k1nq/TREK
1
0
Fork 0
mirror of https://github.com/mauriceboe/TREK.git synced 2026-10-24 07:53:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(assistant): plan and save every tour type, bike tours, runs, paddle and ski tours included

Browse Source 
The assistant can now plan and save every type the Tours tab plans. A bike
tour or a run is proposed and created through the hike's own plan and save
(propose_tour, create_tour), routed on the server with the costing of its
profile, now kept once in shared and read by the planner as well. A paddle
or ski tour planned with plan_paddle_route or plan_ski_route is saved with
create_paddle_tour or create_ski_tour, and "Plan this" takes those plans,
bike tours and runs too. Every create has its card and its way back.
This commit is contained in:
Maurice
2026-10-23 18:59:37 +02:00
parent 79fb71bc92
commit 6e43490ba0
79 changed files with 3664 additions and 168 deletions
Download Patch File Download Diff File Expand all files Collapse all files
client/src/components/Assistant/assistantParts.ts
+4
View File
@@ -127,6 +127,10 @@ function namedFirst(places: readonly AssistantFoundPlace[], text: string): Assis
const TOUR_PLANNING_TOOLS: ReadonlySet<string> = new Set([
'propose_hike',
'create_hike',
'propose_tour',
'create_tour',
'create_paddle_tour',
'create_ski_tour',
'update_tour',
'propose_city_walk',
'create_city_walk',
client/src/components/Assistant/cards/parts/useCardFormat.ts
+5 -2
View File
@@ -5,6 +5,7 @@ import { useTranslation } from '../../../../i18n';
import { useSettingsStore } from '../../../../store/settingsStore';
import { formatClockTime, formatDate, formatMoney } from '../../../../utils/formatters';
import { formatDistance, formatElevation } from '../../../../utils/units';
import { formatRunPace, runPaceUnitText } from '../../../Tours/run/runPace';
/**
* How a card writes its numbers, the way the rest of TREK does for this
@@ -13,7 +14,7 @@ import { formatDistance, formatElevation } from '../../../../utils/units';
* units. A card hands these to its words as `{value}`, never a raw number.
*/
export function useCardFormat() {
const { locale } = useTranslation();
const { locale, t } = useTranslation();
const twelveHour = useSettingsStore((s) => s.settings.time_format === '12h');
const unit = useSettingsStore((s) => s.settings.distance_unit ?? 'metric');
return useMemo(() => {
@@ -37,6 +38,8 @@ export function useCardFormat() {
return m === 0 ? hours.format(h) : `${hours.format(h)} ${mins.format(m)}`;
},
count: (value: number) => number.format(value),
/** "5:30 min/km" from seconds per kilometre, per mile with distances in miles. */
pace: (secondsPerKm: number) => `${formatRunPace(secondsPerKm, unit)} ${runPaceUnitText(unit, t)}`,
};
}, [locale, twelveHour, unit]);
}, [locale, twelveHour, unit, t]);
}
client/src/components/Assistant/cards/tour/TourRouteCard.test.tsx
+41 -1
View File
@@ -1,5 +1,5 @@
/**
* FE-AI-TOUR-021 to FE-AI-TOUR-028, FE-AI-TOUR-037 to FE-AI-TOUR-042
* FE-AI-TOUR-021 to FE-AI-TOUR-028, FE-AI-TOUR-037 to FE-AI-TOUR-042, FE-AI-TOUR-061 to FE-AI-TOUR-062
*
* A route in the chat as the Tours tab shows a hike: its figures and grade,
* a profile only where the heights are known, the profile, the stop chips
@@ -387,4 +387,44 @@ describe('TourRouteCard', () => {
expect(container.querySelectorAll('[data-testid="tour-day"] .bg-danger')).toHaveLength(2);
expect(screen.getAllByText('Start by 10:30')).toHaveLength(1);
});
it('FE-AI-TOUR-061: a bike tour names its profile and its riding time, a run its pace, and waits for one it lacks', () => {
const bike: Route = {
...HIKE,
activity: 'bike',
routingProfile: 'gravel',
minutesBasis: 'router',
limit: null,
grades: null,
};
const { container } = renderCard(bike);
expect(screen.getByText('Gravel')).toBeInTheDocument();
expect(screen.queryByTestId('tour-grade')).toBeNull();
expect(screen.getByRole('button', { name: 'Plan this' })).toBeEnabled();
expect(container.querySelector('[data-field="pace"]')).toBeNull();
const run: Route = {
...bike,
activity: 'run',
routingProfile: 'trail',
minutesBasis: 'pace',
paceSecondsPerKm: 330,
};
const paced = renderCard(run);
expect(screen.getByText('Trail running')).toBeInTheDocument();
expect(paced.container.querySelector('[data-field="pace"]')).toHaveTextContent('5:30 min/km');
renderCard({ ...run, paceSecondsPerKm: null, minutes: null });
expect(screen.getByText('Tell the assistant your pace to save this run.')).toBeInTheDocument();
const buttons = screen.getAllByRole('button', { name: 'Plan this' });
expect(buttons[buttons.length - 1]).toBeDisabled();
});
it('FE-AI-TOUR-062: a whole paddle plan offers "Plan this"; one with a leg that failed does not', () => {
const plan: Route = { ...HIKE, activity: 'kayak', source: 'plan', limit: null, grades: null, schedule: null };
renderCard(plan);
expect(screen.getByRole('button', { name: 'Plan this' })).toBeInTheDocument();
renderCard({ ...plan, name: 'Broken', warnings: [{ kind: 'legs_failed', at: null, count: 1 }] });
expect(screen.getAllByRole('button', { name: 'Plan this' })).toHaveLength(1);
});
});
client/src/components/Assistant/cards/tour/TourRouteHead.tsx
+13 -7
View File
@@ -16,7 +16,7 @@ import RouteSketch from '../parts/RouteSketch';
import { useCardFormat } from '../parts/useCardFormat';
import { factKeysOf, factValue, percentText, type FactKey } from './tourRouteModel';
import { sketchOf } from './tourRouteSketchModel';
import { routeName, SAC_WORDS, timeLabelKey, TOUR_TYPE_WORDS } from './tourRouteWords';
import { PROFILE_WORDS, routeName, SAC_WORDS, timeLabelKey, TOUR_TYPE_WORDS } from './tourRouteWords';
/**
* The head of a route card: the route drawn small beside its name, the
@@ -63,14 +63,16 @@ export function TourRouteFigures({ card }: { card: TourRouteCard }) {
/**
* The grade of a hike, as the hike's own card shows it: the hardest SAC step
* along the way, uncertain when too little of it is graded, with what it
* means, the routing limit and where grades come from in its tooltip. Any
* other tour says what kind it is instead.
* means, the routing limit and where grades come from in its tooltip. A bike
* tour or a run names its profile instead, any other tour what kind it is.
*/
export function TourGrade({ card }: { card: TourRouteCard }) {
const { t } = useTranslation();
if (card.activity !== 'hike' || !card.grades) {
const icon = createElement(tourDayRowIcon(card.activity), { size: 10, strokeWidth: 2.2, 'aria-hidden': true });
return <SoftPill icon={icon}>{t(TOUR_TYPE_WORDS[card.activity].labelKey)}</SoftPill>;
// A bike tour or a run says what it was planned for: "Gravel", "Trail running".
const words = card.routingProfile ? PROFILE_WORDS[card.routingProfile] : TOUR_TYPE_WORDS[card.activity];
return <SoftPill icon={icon}>{t(words.labelKey)}</SoftPill>;
}
const { highest, unknownShare } = card.grades;
const uncertain = unknownShare >= 0.5;
@@ -138,7 +140,7 @@ export function TourRouteSketch({
export function TourRouteFields({ card }: { card: TourRouteCard }) {
const { t } = useTranslation();
const format = useCardFormat();
const fields = factKeysOf(card).flatMap((key) => {
const fields: Array<{ key: string; label: string; value: string }> = factKeysOf(card).flatMap((key) => {
const value = factValue(card, key);
if (value === null) return [];
// A field's label is short; how the time was reckoned is the figure badges' tooltip.
@@ -148,6 +150,10 @@ export function TourRouteFields({ card }: { card: TourRouteCard }) {
else text = key === 'distance' ? format.distance(value / 1000) : format.elevation(value);
return [{ key, label, value: text }];
});
// A run's time is its distance at the runner's pace: the pace stands beside it.
if (card.paceSecondsPerKm != null) {
fields.push({ key: 'pace', label: t('tours.run.pace'), value: format.pace(card.paceSecondsPerKm) });
}
return <CardFields fields={fields} />;
}
@@ -173,9 +179,9 @@ export default function TourRouteHead({ card, onShow }: { card: TourRouteCard; o
title={name}
meta={card.label ?? undefined}
>
{((card.activity === 'hike' && card.grades) || card.schedule) && (
{((card.activity === 'hike' && card.grades) || card.routingProfile || card.schedule) && (
<div className="mt-2.5 flex flex-wrap items-center gap-1.5">
{card.activity === 'hike' && card.grades && <TourGrade card={card} />}
{((card.activity === 'hike' && card.grades) || card.routingProfile) && <TourGrade card={card} />}
<DayPill card={card} />
</div>
)}
client/src/components/Assistant/cards/tour/TourRouteInRow.test.tsx
+7 -1
View File
@@ -1,5 +1,5 @@
/**
* FE-AI-TOUR-033 to FE-AI-TOUR-034
* FE-AI-TOUR-033 to FE-AI-TOUR-034, FE-AI-TOUR-063
*
* A held tour change in its row: the route drawn small with its figures and
* grade and a small profile, the kind of tour as the row's tile; a tour whose
@@ -71,4 +71,10 @@ describe('TourRouteInRow', () => {
expect(delta).toHaveTextContent('+1.6 km');
expect(delta).toHaveTextContent('+20 min');
});
it('FE-AI-TOUR-063: a held bike tour or run names its profile in its row, never a hike grade', () => {
renderRow({ ...PENDING, activity: 'bike', routingProfile: 'road', grades: null, limit: null });
expect(screen.getByText('Road')).toBeInTheDocument();
expect(screen.queryByTestId('tour-grade')).toBeNull();
});
});
client/src/components/Assistant/cards/tour/TourRouteInRow.tsx
+1 -1
View File
@@ -53,7 +53,7 @@ export default function TourRouteInRow({ card, item }: { card: TourRouteCard; it
<span className="min-w-0 flex-1">
<WayFigures way={legVariantOf(card, 'current')} unit={unit} />
</span>
{grades && grades.highest !== null && <TourGrade card={card} />}
{((grades && grades.highest !== null) || card.routingProfile) && <TourGrade card={card} />}
</span>
{previous && (
<VariantDelta
client/src/components/Assistant/cards/tour/TourWays.tsx
+3
View File
@@ -18,6 +18,7 @@ import CardHeader from '../parts/CardHeader';
import { CardSection } from '../parts/CardSection';
import WayFigures from './TourFigureLine';
import { TourRouteBody } from './TourRouteCard';
import { TourGrade } from './TourRouteHead';
import { legVariantOf, profileSamples, type RouteEntry, WAY_KEYS } from './tourRouteModel';
import { routeName, TOUR_TYPE_WORDS } from './tourRouteWords';
import { useLineHover, useTourRouteCard } from './useTourRouteCard';
@@ -114,6 +115,8 @@ function WayOption({
{grades && grades.highest !== null && (
<SacStepChip step={grades.highest} uncertain={grades.unknownShare >= 0.5} />
)}
{/* Ways of a ride or a run may differ by profile: each says its own. */}
{entry.card.routingProfile && <TourGrade card={entry.card} />}
</span>
<WayFigures way={way} unit={unit} />
{!chosen && <WayDelta way={way} chosen={chosenWay} letter={chosenLetter} unit={unit} />}
client/src/components/Assistant/cards/tour/tourLook.ts
+1
View File
@@ -99,6 +99,7 @@ export const TOUR_LOOK = {
tools: {},
steps: {
propose_city_walk: { stepKey: 'assistant.step.planningWalk' },
propose_tour: { stepKey: 'assistant.step.planningRoute' },
plan_paddle_route: { stepKey: 'assistant.step.planningRoute' },
plan_ski_route: { stepKey: 'assistant.step.planningRoute' },
get_tour_plan: { stepKey: 'assistant.step.readingTour' },
client/src/components/Assistant/cards/tour/tourRouteModel.test.ts
+21 -2
View File
@@ -29,6 +29,7 @@ import {
sacAt,
sacPaint,
steepStretches,
takeWaitsKey,
wayGroups,
} from './tourRouteModel';
import { sketchOf } from './tourRouteSketchModel';
@@ -136,15 +137,33 @@ describe('tourRouteModel', () => {
});
});
it('FE-AI-TOUR-009: "Plan this" takes a planned hike or a city walk, nothing else', () => {
it('FE-AI-TOUR-009: "Plan this" takes a planned way of every type, a city walk, a whole paddle or ski plan', () => {
expect(canTake(HIKE)).toBe(true);
expect(canTake({ ...HIKE, routed: false })).toBe(false);
expect(canTake({ ...HIKE, activity: 'walk', routed: false })).toBe(true);
expect(canTake({ ...HIKE, activity: 'bike', routingProfile: 'gravel' })).toBe(true);
expect(canTake({ ...HIKE, activity: 'run', routingProfile: 'trail', routed: false })).toBe(false);
expect(canTake(SAVED)).toBe(false);
expect(canTake({ ...HIKE, activity: 'kayak', source: 'plan' })).toBe(false);
expect(canTake({ ...HIKE, activity: 'kayak', source: 'plan' })).toBe(true);
expect(canTake({ ...HIKE, activity: 'ski', source: 'plan' })).toBe(true);
// A plan with a leg that could not be planned is no tour yet; a hike is never a plan.
const failed = [{ kind: 'legs_failed' as const, at: null, count: 1 }];
expect(canTake({ ...HIKE, activity: 'ski', source: 'plan', warnings: failed })).toBe(false);
expect(canTake({ ...HIKE, source: 'plan' })).toBe(false);
expect(canTake({ ...HIKE, source: 'pending' })).toBe(false);
});
it("FE-AI-TOUR-060: a run waits for the runner's pace; a bike tour, a hike and a run with a pace wait for nothing", () => {
expect(takeWaitsKey({ ...HIKE, activity: 'run', routingProfile: 'running' })).toBe('assistant.card.tour.needsPace');
expect(takeWaitsKey({ ...HIKE, activity: 'run', paceSecondsPerKm: 330 })).toBeNull();
expect(takeWaitsKey({ ...HIKE, activity: 'bike' })).toBeNull();
expect(takeWaitsKey(HIKE)).toBeNull();
// A ride's router time is its riding time; a run's time is at its pace.
expect(timeLabelKey({ activity: 'bike', minutesBasis: 'router' })).toBe('tours.bike.timeEstimated');
expect(timeLabelKey({ activity: 'run', minutesBasis: 'pace' })).toBe('tours.run.timeEstimated');
expect(timeLabelKey({ activity: 'hike', minutesBasis: 'router' })).toBe('tours.scope.routed');
});
it('FE-AI-TOUR-010: proposals of one answer form ways of three at most; anything else stands alone', () => {
const entry = (toolCallId: string, card: TourRouteCard) => ({ toolCallId, card });
const routes = routeEntries([entry('a', HIKE), { toolCallId: 'list', card: TOUR_LIST }, entry('b', GENTLE)]);
client/src/components/Assistant/cards/tour/tourRouteModel.ts
+18 -3
View File
@@ -226,14 +226,29 @@ export function routePoints(card: TourRouteCard): [number, number][] {
}
/**
* Whether "Plan this" can take the proposal: a hike whose way was planned,
* or a city walk. A paddle or ski plan, a saved tour and a held change cannot.
* Whether "Plan this" can take the proposal: a city walk, a hike, a bike
* tour or a run whose way was planned, or a paddle or ski plan whose every
* leg was planned. A saved tour and a held change cannot.
*/
export function canTake(card: TourRouteCard): boolean {
if (card.source === 'plan') {
const whole = card.warnings.every((warning) => warning.kind !== 'legs_failed');
return (card.activity === 'kayak' || card.activity === 'ski') && card.routed && whole;
}
if (card.source !== 'proposal') return false;
return card.activity === 'walk' || (card.activity === 'hike' && card.routed);
return card.activity === 'walk' || (LAND_PLANS.has(card.activity) && card.routed);
}
/** The proposals on land "Plan this" takes once their way is planned. */
const LAND_PLANS: ReadonlySet<TourRouteCard['activity']> = new Set(['hike', 'bike', 'run']);
/** Why "Plan this" waits on a card it can take: a run is saved with the runner's pace only. Null when nothing is missing. */
export function takeWaitsKey(card: TourRouteCard): string | null {
return card.activity === 'run' && card.paceSecondsPerKm == null ? NEEDS_PACE.labelKey : null;
}
const NEEDS_PACE = { labelKey: 'assistant.card.tour.needsPace' } as const;
/** A share as words take it, "40 %". */
export function percentText(share: number): string {
return `${Math.round(share * 100)} %`;
client/src/components/Assistant/cards/tour/tourRouteWords.ts
+16 -1
View File
@@ -92,10 +92,25 @@ const TIME_WORDS = {
planned: { labelKey: 'tours.scope.planned' },
stations: { labelKey: 'tours.scope.plannedWithStays' },
piste: { labelKey: 'tours.ski.time' },
pace: { labelKey: 'tours.run.timeEstimated' },
} as const satisfies Record<NonNullable<TourRouteCard['minutesBasis']>, { labelKey: string }>;
/** The name of a route's time: by how it was reckoned, else a paddle's own, else a walking time. */
/** What each bike and run profile is called, as the Tours tab names it. */
export const PROFILE_WORDS = {
touring: { labelKey: 'tours.bike.profile.touring' },
road: { labelKey: 'tours.bike.profile.road' },
gravel: { labelKey: 'tours.bike.profile.gravel' },
mtb: { labelKey: 'tours.bike.profile.mtb' },
running: { labelKey: 'tours.run.profile.running' },
trail: { labelKey: 'tours.run.profile.trail' },
} as const satisfies Record<NonNullable<TourRouteCard['routingProfile']>, { labelKey: string }>;
/**
* The name of a route's time: by how it was reckoned (a bike tour's router
* time is its riding time), else a paddle's own, else a walking time.
*/
export function timeLabelKey(card: Pick<TourRouteCard, 'minutesBasis' | 'activity'>): string {
if (card.minutesBasis === 'router' && card.activity === 'bike') return 'tours.bike.timeEstimated';
if (card.minutesBasis) return TIME_WORDS[card.minutesBasis].labelKey;
return card.activity === 'kayak' ? 'tours.paddle.timeEstimated' : 'tours.planner.walkingEstimated';
}
client/src/components/Assistant/cards/tour/useTourRouteCard.ts
+5 -3
View File
@@ -11,7 +11,7 @@ import { hasUndecided } from '../../assistantParts';
import { useAssistantView } from '../../assistantViewContext';
import { useChangeHover } from '../../useChangeHover';
import { tourTarget } from './tourLook';
import { canTake, routePoints } from './tourRouteModel';
import { canTake, routePoints, takeWaitsKey } from './tourRouteModel';
import { takeInThread, takeOfProposal } from './tourTakeModel';
/**
@@ -104,7 +104,8 @@ function stateAfter(outcome: HoldOutcome, error: string | null): TakeState {
}
/**
* "Plan this" on a proposed hike or city walk: one tap adds the tour. The
* "Plan this" on a proposed tour (a hike, a bike tour, a run, a city walk)
* or a paddle or ski plan: one tap adds the tour. The
* server holds the tour it creates as a change, without a model turn, and
* the tap decides it at once, since tapping "Plan this" already is the
* decision; the assistant then answers to what was added. Once the tour is
@@ -148,9 +149,10 @@ export function useTakeProposal(toolCallId: string, card: TourRouteCard) {
}, []);
const visible = canTake(card) && !!trip && can('place_edit', trip);
let reasonKey: string | null = null;
let reasonKey: string | null;
if (offline) reasonKey = 'assistant.error.offline';
else if (waiting && state !== 'taken') reasonKey = 'assistant.composer.decideFirst';
else reasonKey = takeWaitsKey(card);
const disabled = reasonKey !== null || isRunning || threadId === null || state === 'busy';
const take = useCallback(async () => {
client/src/components/Tours/planner/tourRouting.ts
+4 -54
View File
@@ -1,5 +1,7 @@
import {
bikeCosting,
hikingCosting,
runCosting,
TOURS_MAX_HIKING_DIFFICULTY,
type BikeProfile,
type HikingPreferences,
@@ -78,28 +80,6 @@ const FIXED_LEG_KM_PER_HOUR = { ferrata: 1.5, free: 4, portage: 2 } as const
/** A leg drawn by hand on a bike tour is reckoned at an easy riding pace: no router saw it. */
const FREE_LEG_RIDING_KM_PER_HOUR = 15
/**
* BIK-01 to BIK-04: what each bike profile asks Valhalla's bicycle costing for.
* Every one was checked against the public instance with trace_attributes over
* the routes it gave, before it was offered (shares of the length):
* - touring, Hybrid with bad surfaces avoided: Garmisch station to the Eckbauer
* 92 % asphalt and no gravel, where gravel took 18 % gravel on farm tracks.
* - road, Road at full surface avoidance: Herrsching to Andechs 100 % asphalt
* over 6.2 km, where touring took 4.98 km with 7 % dirt and 10 % compacted.
* - gravel, Cross with surfaces barely avoided: Munich Marienplatz to the
* Englischer Garten 39 % compacted paths along the Isar, touring 9 %.
* - mtb, Mountain with no surface avoidance and roads least wanted: Garmisch
* to the Eckbauer 63 % tracks and 38 % gravel.
* `use_roads` and the bicycle type also set the router's riding speed, so the
* time it gives is the profile's. None of it says a way is rideable or safe.
*/
const BIKE_COSTING: Record<BikeProfile, Readonly<CostingOptions>> = {
touring: { bicycle_type: 'Hybrid', use_roads: 0.2, avoid_bad_surfaces: 1 },
road: { bicycle_type: 'Road', use_roads: 0.5, avoid_bad_surfaces: 1 },
gravel: { bicycle_type: 'Cross', use_roads: 0.1, avoid_bad_surfaces: 0.25 },
mtb: { bicycle_type: 'Mountain', use_roads: 0, avoid_bad_surfaces: 0 },
}
type LandWaypoint = Pick<Waypoint, 'lat' | 'lng'> & { fixedLeg?: TourFixedLeg | null }
/**
@@ -137,43 +117,13 @@ export async function routeCityWalk(
const CITY_WALK_COSTING: Readonly<CostingOptions> = { use_ferry: 0 }
const CITY_WALK_BINDING: Readonly<SearchFilter> = { exclude_ferry: true }
/**
* RUN-01, RUN-02: what each run profile asks Valhalla's pedestrian costing
* for. A run is run, so a ferry only where no way on land exists
* (`use_ferry` 0). Checked with trace_attributes against the public instance
* on 20.10.2026 (shares of the length):
* - running keeps to runnable, mostly paved ways: farm and forest tracks only
* where there is no other way (`use_tracks` 0), and no hiking limit, so the
* router keeps to the ways it takes for walking anyway (T1). Berlin S
* Grunewald into the forest went from 95 % tracks with 3 % paved to 67 %
* smooth paved paths over 3.58 km instead of 3.50 km; Munich Großhesseloher
* Brücke to Pullach from 79 % to 88 % smooth asphalt and no track left;
* Marienplatz to the Englischer Garten stayed as it was.
* - trail takes tracks wherever they serve (`use_tracks` 1) and admits
* mountain paths up to T2 (`max_hiking_difficulty` 2), never T3 and above.
* Above Freiburg Günterstal up to the Schauinsland it went from 82 % roads
* and 83 % paved (running) to 78 % forest tracks and 81 % compacted, gravel
* and dirt over 9.57 km instead of 10.15 km; Rathen to the Bastei took 28 % of T2
* path that running leaves out; Heidelberg's old town, all streets, stayed
* as it was. Leaning on footways (`walkway_factor`) was tried and left out:
* along the Isar it moved the run onto paved footways, from 33 % to 18 %
* unpaved.
* The router's own time is a walker's and is never used: a run's time is its
* distance at the runner's pace, whatever the profile. Nothing here says a
* way can be run.
*/
const RUN_COSTING: Record<RunProfile, Readonly<CostingOptions>> = {
running: { use_tracks: 0, use_ferry: 0 },
trail: { use_tracks: 1, use_ferry: 0, max_hiking_difficulty: 2 },
}
/** RUN-01, RUN-02: a run, on foot for its profile; a leg drawn by hand is kept as drawn. */
export async function routeRun(
waypoints: LandWaypoint[],
profile: RunProfile,
signal?: AbortSignal,
): Promise<TourRouteResult | TourRouteUnreachable | null> {
return routeOnLand(waypoints, 'walking', RUN_COSTING[profile], signal)
return routeOnLand(waypoints, 'walking', runCosting(profile), signal)
}
/** BIK-01: a bike tour, routed for its profile; a leg drawn by hand is kept as drawn. */
@@ -182,7 +132,7 @@ export async function routeBikeTour(
profile: BikeProfile,
signal?: AbortSignal,
): Promise<TourRouteResult | TourRouteUnreachable | null> {
return routeOnLand(waypoints, 'cycling', BIKE_COSTING[profile], signal)
return routeOnLand(waypoints, 'cycling', bikeCosting(profile), signal)
}
/**
server/src/nest/assistant/assistant-cards.helpers.ts
+1 -1
View File
@@ -244,7 +244,7 @@ function lookOf(
const centre = area ? nearbyName(card, (area.south + area.north) / 2, (area.west + area.east) / 2) : null;
return { label: centre, area };
}
if (toolName === 'propose_hike') return hikeLook(args);
if (toolName === 'propose_hike' || toolName === 'propose_tour') return hikeLook(args);
if (toolName === 'search_place') {
const bias = recordOf(args.locationBias);
const area = pointArea(bias.lat, bias.lng, bias.radius, BIAS_RADIUS_M);
server/src/nest/assistant/assistant-history.ts
+11 -1
View File
@@ -93,10 +93,20 @@ function foundPlaceOutcome(part: ToolCallPart): string {
return `The user picked ${place} from the search results for ${day}; it waits for them to add or discard it.`;
}
/** What a taken proposal created, by the tool it went through; a hike for any other. */
const TAKEN_WORDS: Readonly<Record<string, string>> = {
create_city_walk: 'city walk',
'create_tour:bike': 'bike tour',
'create_tour:run': 'run',
create_paddle_tour: 'paddle tour',
create_ski_tour: 'ski tour',
};
/** What became of a proposal the user took from an answer to add it to the trip, as its stored part says. */
function takenProposalOutcome(part: ToolCallPart): string {
const name = quoted(part.args.name);
const what = part.args.via === 'create_city_walk' ? 'city walk' : 'hike';
const via = part.args.via === 'create_tour' ? `create_tour:${String(part.args.activity)}` : String(part.args.via);
const what = TAKEN_WORDS[via] ?? 'hike';
if (part.approval?.approved === true) {
return part.isError ? `The ${what} ${name} could not be added.` : `The ${what} ${name} was added to the trip.`;
}
server/src/nest/assistant/assistant-proposal-sports.ts
+132
View File
@@ -0,0 +1,132 @@
import { recordOf, type Row } from './cards/card-values';
import { haversineMetres } from '@trek/shared';
import { SUPPORTED_LANGUAGE_CODES } from '@trek/shared/i18n';
/**
* "Plan this" on a paddle or ski plan an answer showed (plan_paddle_route,
* plan_ski_route): the create it holds, from the plan's own arguments and
* its answer read again whole. The legs of a plan must run on from one to
* the next to be one tour; its points are the first leg's start and every
* leg's end. A paddle tour's water is read from the plan (a river where any
* stretch is on running water, else a lake), its name from the waters it
* runs on, a ski tour's from its ski areas; where neither names one, the
* tour type's own word in the user's language.
*/
/** The plans a tour can be taken from, and the create each one is saved through. */
export const SPORT_CREATES = {
plan_paddle_route: 'create_paddle_tour',
plan_ski_route: 'create_ski_tour',
} as const;
export type SportPlanTool = keyof typeof SPORT_CREATES;
/** Whether a tool is one of the plans a tour can be taken from. */
export function isSportPlan(toolName: string): toolName is SportPlanTool {
return Object.hasOwn(SPORT_CREATES, toolName);
}
/** How near one leg's end must lie to the next leg's start for the two to be one tour, in metres. */
const JOINED_M = 5;
/** The longest name a tour is given from its waters or areas, well inside a tour's name. */
const NAME_CHARS = 120;
/** A point as the plan names it, or null. */
function pointOf(value: unknown): { lat: number; lng: number } | null {
const point = recordOf(value);
return typeof point.lat === 'number' && typeof point.lng === 'number' ? { lat: point.lat, lng: point.lng } : null;
}
/** The points of a plan's legs, the first leg's start then every leg's end; null where the legs do not join. */
export function waypointsOfLegs(legs: unknown): Array<{ lat: number; lng: number }> | null {
const rows = Array.isArray(legs) ? legs.map(recordOf) : [];
const first = pointOf(rows[0]?.from);
if (!first) return null;
const points = [first];
for (const [index, leg] of rows.entries()) {
const from = pointOf(leg.from);
const to = pointOf(leg.to);
const before = points[index];
if (!from || !to || !before || haversineMetres(before.lat, before.lng, from.lat, from.lng) > JOINED_M) return null;
points.push(to);
}
return points.length >= 2 ? points : null;
}
/** Each planned leg of an answer; null where one failed, which takes the whole plan out of reach. */
function plannedLegs(result: Row): Row[] | null {
const legs = Array.isArray(result.legs) ? result.legs.map(recordOf) : [];
return legs.length > 0 && legs.every((leg) => leg.status === 'ok') ? legs : null;
}
/** "Isar → Ammersee": the first and last names given, each once, clipped. */
function namedAlong(names: readonly unknown[]): string {
const kept = names.flatMap((name) => (typeof name === 'string' && name.trim() !== '' ? [name.trim()] : []));
const ends = [...new Set([kept[0], kept.at(-1)])].filter((name): name is string => !!name);
const name = ends.join(' → ');
return name.length > NAME_CHARS ? `${name.slice(0, NAME_CHARS - 1)}…` : name;
}
/** The water a paddle plan runs on: a river where any stretch is on running water, else a lake. */
function waterOf(legs: readonly Row[]): 'river' | 'lake' {
const kinds = legs.flatMap((leg) => (Array.isArray(leg.segments) ? leg.segments.map((s) => recordOf(s).kind) : []));
return kinds.some((kind) => kind === 'water' || kind === 'rapids' || kind === 'pass') ? 'river' : 'lake';
}
/**
* The create a taken paddle or ski plan holds: its points, the plan's own
* settings and a name; null where a leg failed or the legs do not join.
*/
export function sportTakeArgsOf(toolName: SportPlanTool, args: Row, result: Row, fallbackName: string): Row | null {
const legs = plannedLegs(result);
const waypoints = waypointsOfLegs(args.legs);
if (!legs || !waypoints) return null;
const via = SPORT_CREATES[toolName];
if (via === 'create_paddle_tour') {
const waters = legs.flatMap((leg) =>
Array.isArray(leg.segments) ? leg.segments.map((s) => recordOf(s).name) : [],
);
const take: Row = { via, name: namedAlong(waters) || fallbackName, waypoints, water_context: waterOf(legs) };
if (args.boat !== undefined) take.boat_type = args.boat;
if (args.lake_style !== undefined) take.lake_style = args.lake_style;
if (args.lock_policy !== undefined) take.lock_policy = args.lock_policy;
return take;
}
const areas = Array.isArray(result.area_names) ? result.area_names : [];
const take: Row = { via, name: namedAlong(areas) || fallbackName, waypoints, discipline: args.discipline };
if (args.technique !== undefined && args.technique !== null) take.technique = args.technique;
if (args.options !== undefined) take.options = args.options;
return take;
}
/** The locale key each plan's tour type is named by. */
const TYPE_WORD_KEYS: Readonly<Record<SportPlanTool, string>> = {
plan_paddle_route: 'tourTypes.kayak',
plan_ski_route: 'tourTypes.ski',
};
/** The words of one locale's table, or none when it cannot be read. */
async function wordsOf(language: string): Promise<Record<string, unknown>> {
try {
// A supported code only, so the path is one of the package's own locale entries.
const loaded: unknown = await import(`@trek/shared/i18n/${language}`);
const words = (loaded as { default?: unknown } | null)?.default;
return words !== null && typeof words === 'object' ? (words as Record<string, unknown>) : {};
} catch {
return {};
}
}
/** A plan's tour type in the user's language ("Paddeltour"), English where the language has no table. */
export async function tourTypeWord(locale: string, toolName: SportPlanTool): Promise<string> {
const language = locale.split('-')[0] ?? 'en';
const code = SUPPORTED_LANGUAGE_CODES.includes(locale)
? locale
: SUPPORTED_LANGUAGE_CODES.includes(language)
? language
: 'en';
const key = TYPE_WORD_KEYS[toolName];
const own = (await wordsOf(code))[key];
if (typeof own === 'string') return own;
const english = (await wordsOf('en'))[key];
return typeof english === 'string' ? english : 'Tour';
}
server/src/nest/assistant/assistant-proposals.service.ts
+77 -12
View File
@@ -22,13 +22,14 @@ import { RateLimitService } from '../common/rate-limit.service';
import { UnitOfWork } from '../database/unit-of-work';
import { buildTripCard, categoriesFrom, todayIn, type TripCard } from './assistant-context';
import { partsOf, toThreadMessages } from './assistant-history';
import { isSportPlan, SPORT_CREATES, sportTakeArgsOf, tourTypeWord } from './assistant-proposal-sports';
import { AssistantStreamRegistry } from './assistant-stream.registry';
import { TAKE_PROPOSAL_TOOL, TURNS_PER_MINUTE } from './assistant-tools.constants';
import { AssistantToolsService, type ToolRun } from './assistant-tools.service';
import { AssistantCardContext } from './cards/card-context';
import { recordOf, type Row } from './cards/card-values';
import { argText } from './cards/tour/tour-card-values';
import { cityWalkCard } from './cards/tour/tour-sport.cards';
import { cityWalkCard, paddleCard, skiCard } from './cards/tour/tour-sport.cards';
import { describeToolCall } from './tool-call-preview.helpers';
import { InjectRepository } from '@mikro-orm/nestjs';
import { Injectable } from '@nestjs/common';
@@ -49,8 +50,17 @@ import { randomUUID } from 'node:crypto';
*/
const WALK_READ = 'propose_city_walk';
/** What a taken proposal reads: the trip's days and places, the category names its card writes with, a walk again. */
const TRIP_READS: ReadonlySet<string> = new Set(['get_trip_summary', 'list_places', 'list_categories', WALK_READ]);
/**
* What a taken proposal reads: the trip's days and places, the category names
* its card writes with, a walk or a paddle or ski plan again.
*/
const TRIP_READS: ReadonlySet<string> = new Set([
'get_trip_summary',
'list_places',
'list_categories',
WALK_READ,
...Object.keys(SPORT_CREATES),
]);
/** Message rows searched for the proposal; the history a turn sends the provider. */
const SEARCHED_ROWS = 40;
@@ -69,9 +79,11 @@ interface StoredProposal {
}
/** The proposing reads a card can be taken from, and the tool each one is created through. */
const CREATES: Readonly<Record<string, 'create_hike' | 'create_city_walk'>> = {
const CREATES: Readonly<Record<string, string>> = {
propose_hike: 'create_hike',
propose_tour: 'create_tour',
propose_city_walk: 'create_city_walk',
...SPORT_CREATES,
};
const PROPOSING: ReadonlySet<string> = new Set(Object.keys(CREATES));
@@ -103,6 +115,26 @@ function walkName(stations: readonly Row[], result: Row): string {
return name.length > WALK_NAME_CHARS ? `${name.slice(0, WALK_NAME_CHARS - 1)}…` : name;
}
/**
* A paddle or ski plan asked again with the arguments it was planned with:
* the stored answer is the model's shortened copy, and its legs' stretches
* name the water or the areas the tour is called after. The card is drawn
* again from the whole answer (the stored one when none can be drawn). Null
* when the plan cannot be read now.
*/
async function planAgain(
read: (name: string, args: Row) => Promise<ToolRun>,
proposal: StoredProposal,
trip: TripCard,
today: string,
): Promise<StoredProposal | null> {
const run = await read(proposal.toolName, proposal.args);
if (!run.ok) return null;
const input = { toolCallId: '', args: proposal.args, value: run.value, card: trip, today };
const drawn = proposal.toolName === 'plan_ski_route' ? skiCard(input) : paddleCard(input);
return { ...proposal, result: recordOf(run.value), card: drawn ?? proposal.card };
}
/**
* A walk asked again with the arguments it was proposed with: the stations to
* create from the tool's own answer, and the card drawn from that answer (the
@@ -133,7 +165,7 @@ export function pendingCardOf(card: TourRouteCard, args: Row): TourRouteCard {
return { ...card, source: 'pending', name: argText(args.name, 120) ?? card.name, label: null, schedule };
}
/** The fields of a propose_hike create_hike takes as they are. */
/** The fields of a propose_hike create_hike takes as they are, and those of a propose_tour create_tour takes. */
const HIKE_FIELDS = [
'name',
'waypoints',
@@ -143,21 +175,42 @@ const HIKE_FIELDS = [
'day_id',
'start_time',
] as const;
const TOUR_FIELDS = [
'name',
'activity',
'bike_profile',
'run_profile',
'run_pace_seconds_per_km',
'waypoints',
'round_trip',
'day_id',
'start_time',
] as const;
/**
* The change a taken proposal holds: create_hike with the proposal's own
* arguments for a hike whose way was planned, create_city_walk with the
* The change a taken proposal holds: create_hike (create_tour for a bike
* tour or a run) with the proposal's own arguments for a way that was
* planned, create_paddle_tour or create_ski_tour with a plan's points and
* settings, create_city_walk with the
* stations it answered for a walk that can be created. Null for a proposal
* nothing can be created from.
*/
export function takeArgsOf(proposal: StoredProposal): Row | null {
export function takeArgsOf(proposal: StoredProposal, fallbackName = ''): Row | null {
const via = CREATES[proposal.toolName];
if (via === 'create_hike') {
if (via === 'create_hike' || via === 'create_tour') {
if (!proposal.card.routed) return null;
// A run is saved with the runner's pace only, as the planner saves one.
if (via === 'create_tour' && proposal.args.activity === 'run' && proposal.args.run_pace_seconds_per_km == null) {
return null;
}
const args: Row = { via };
for (const key of HIKE_FIELDS) if (proposal.args[key] !== undefined) args[key] = proposal.args[key];
for (const key of via === 'create_hike' ? HIKE_FIELDS : TOUR_FIELDS) {
if (proposal.args[key] !== undefined) args[key] = proposal.args[key];
}
return args;
}
if (isSportPlan(proposal.toolName))
return sportTakeArgsOf(proposal.toolName, proposal.args, proposal.result, fallbackName);
const stations = Array.isArray(proposal.result.stations_for_create) ? proposal.result.stations_for_create : [];
if (proposal.result.can_create === false || stations.length < 2) return null;
return { via, name: walkName(stations.map(recordOf), proposal.result), stations };
@@ -227,7 +280,8 @@ export class AssistantProposalsService {
const id = randomUUID();
const today = todayIn(req.timeZone, new Date());
const { card, categories, proposal } = await this.tripOf(userId, tripId, stored, today);
const args = proposal ? takeArgsOf(proposal) : null;
const fallback = isSportPlan(stored.toolName) ? await tourTypeWord(req.locale, stored.toolName) : '';
const args = proposal ? takeArgsOf(proposal, fallback) : null;
if (!proposal || !args) throw aiRefusal('generic', 'Nothing can be created from this proposal: ask for it again');
const ctx = this.cardContext.contextOf(card, categories, req.locale, today);
// The proposal it came from, so the thread tells which card was taken, whatever way it creates.
@@ -294,13 +348,24 @@ export class AssistantProposalsService {
return {
card,
categories: new Map(categories.map((category): [number, string] => [category.id, category.name])),
proposal: stored.toolName === WALK_READ ? await walkAgain(read, stored, card, today) : stored,
proposal: await this.again(read, stored, card, today),
};
} finally {
await session.close();
}
}
/** The proposal as it is taken: a walk or a paddle or ski plan asked again, a hike or tour as it was stored. */
private async again(
read: (name: string, args: Row) => Promise<ToolRun>,
stored: StoredProposal,
card: TripCard,
today: string,
): Promise<StoredProposal | null> {
if (stored.toolName === WALK_READ) return await walkAgain(read, stored, card, today);
return isSportPlan(stored.toolName) ? await planAgain(read, stored, card, today) : stored;
}
/** The newest answer of the thread as the client shows it, with what became of its changes. */
private async answerOf(threadId: number): Promise<AssistantMessage> {
const rows = await this.messages.listLatest(threadId, THREAD_ROWS);
server/src/nest/assistant/assistant-tool-offer.ts
+4 -2
View File
@@ -226,14 +226,16 @@ type ToolGroups = Readonly<Record<string, { about: string; controllers: readonly
const CORE_TOOL_GROUPS: ToolGroups = {
tours: {
about:
'Tours: hikes (also over several days in stages), city walks, bike tours, runs, rides, paddling and ski ' +
'routes; plan, create, change and export them (hikes with their heights and SAC grades), search along a ' +
'Tours: hikes (also over several days in stages), city walks, bike tours (road, gravel, mountain bike), ' +
'runs (road and trail), rides, paddling and ski and winter tours; plan and save every one of them, change ' +
'and export them (hikes with their heights and SAC grades), search along a ' +
'tour, check off a city walk under way, the recorded tracks and tour stats, their packing, tours in ' +
'collections, the tour library and imports from GPX files and Google Maps walks.',
controllers: [
'ToursMcp',
'CityWalkMcp',
'HikePlanMcp',
'TourPlanMcp',
'TourChangeMcp',
'TourChangeUndoMcp',
'TourLibraryMcp',
server/src/nest/assistant/assistant-tools.constants.ts
+8 -2
View File
@@ -145,8 +145,14 @@ export const PREVIEW_BOOK_PAGE_TOOL = 'preview_book_page';
/** The model's tools a found place is added through: a new place for the day, or one the trip has already. */
const FOUND_PLACE_VIA: ReadonlySet<string> = new Set(['create_and_assign_place', 'assign_place_to_day']);
/** The model's tools a taken proposal is created through: a hike, a city walk. */
const PROPOSAL_VIA: ReadonlySet<string> = new Set(['create_hike', 'create_city_walk']);
/** The model's tools a taken proposal is created through: a hike, a bike tour or a run, a city walk, a paddle or ski tour. */
const PROPOSAL_VIA: ReadonlySet<string> = new Set([
'create_hike',
'create_tour',
'create_city_walk',
'create_paddle_tour',
'create_ski_tour',
]);
/**
* Changes the server applies itself: a booking from an attached file, a search
server/src/nest/assistant/cards/tour/index.ts
+42
View File
@@ -6,6 +6,7 @@ import {
createHikeCard,
createHikeEffect,
loadCreateHike,
loadCreateTour,
loadUpdateTour,
updateTourCard,
type TourLoaded,
@@ -13,6 +14,13 @@ import {
import { TOUR_DESCRIBERS } from './tour-describe';
import { tourListCard } from './tour-lists.cards';
import { proposalCard, savedTourCard } from './tour-route.cards';
import {
createPaddleCard,
createSkiCard,
loadCreatePaddle,
loadCreateSki,
type SportLoaded,
} from './tour-sport-change.cards';
import { cityWalkCard, paddleCard, skiCard } from './tour-sport.cards';
import { DELETE_CREATED_TOUR, DELETE_IMPORTED_TOUR } from './tour-undo';
import { describeVisit, loadVisit, SET_VISIT_UNDO } from './tour-visit.cards';
@@ -47,6 +55,34 @@ const createHike: ToolCards<TourLoaded> = {
undo: DELETE_CREATED_TOUR,
};
/** create_tour: a bike tour or a run, drawn and taken back as a hike is, its effect on the day too. */
const createTour: ToolCards<TourLoaded> = {
write: { verbKey: 'addTour', entity: 'tour' },
describe: TOUR_DESCRIBERS.create_tour,
load: loadCreateTour,
change: createHikeCard,
effect: createHikeEffect,
applied: appliedTourCard,
undo: DELETE_CREATED_TOUR,
};
/** A paddle or ski tour saved from its plan: the plan's card waiting, the receipt opening the tour, its delete the way back. */
function sportCreate(
describe: ToolCards<SportLoaded>['describe'],
load: NonNullable<ToolCards<SportLoaded>['load']>,
change: NonNullable<ToolCards<SportLoaded>['change']>,
): ToolCards<SportLoaded> {
return {
write: { verbKey: 'addTour', entity: 'tour' },
describe,
load,
change,
effect: createHikeEffect,
applied: appliedTourCard,
undo: DELETE_CREATED_TOUR,
};
}
const updateTour: ToolCards<TourLoaded> = {
write: { verbKey: 'updateTour', entity: 'tour' },
describe: TOUR_DESCRIBERS.update_tour,
@@ -60,6 +96,7 @@ export const TOUR_CARDS: DomainCards = {
id: 'tour',
tools: {
propose_hike: { argPolicy: WITH_GEOMETRY, answer: proposalCard },
propose_tour: { argPolicy: WITH_GEOMETRY, answer: proposalCard },
propose_city_walk: { argPolicy: WITH_GEOMETRY, answer: cityWalkCard },
plan_paddle_route: { argPolicy: WITH_GEOMETRY, answer: paddleCard },
plan_ski_route: { argPolicy: WITH_GEOMETRY, answer: skiCard },
@@ -67,6 +104,9 @@ export const TOUR_CARDS: DomainCards = {
list_tours: { answer: tourListCard },
find_tours_for_day: { answer: tourListCard },
create_hike: createHike,
create_tour: createTour,
create_paddle_tour: sportCreate(TOUR_DESCRIBERS.create_paddle_tour, loadCreatePaddle, createPaddleCard),
create_ski_tour: sportCreate(TOUR_DESCRIBERS.create_ski_tour, loadCreateSki, createSkiCard),
create_city_walk: {
write: { verbKey: 'addTour', entity: 'tour' },
describe: TOUR_DESCRIBERS.create_city_walk,
@@ -94,6 +134,8 @@ export const TOUR_CARDS: DomainCards = {
},
},
prompt: [
"Every tour type can be planned and saved. Pick the tool by what the user does: a hike (also a trek over several days) propose_hike then create_hike; a bike tour or a run propose_tour (activity bike or run) then create_tour; a city walk propose_city_walk then create_city_walk; a paddle tour plan_paddle_route then create_paddle_tour (it needs water_context river or lake); a ski or winter tour (alpine, snowboard, cross-country, ski touring, snowshoe, winter hike) plan_ski_route then create_ski_tour with the same points, discipline and options. Pass the plan's points in order as waypoints: the from of the first leg and the to of every leg.",
"Profiles: a bike tour is touring for a city or trekking bike on paved ways and cycle paths (the default), road for a road bike on asphalt only, gravel for a gravel bike on gravel and farm tracks, mtb for a mountain bike on rough tracks and trails; a run is running on mostly paved ways (the default) or trail on forest tracks and natural paths. Choose from what the user rides or how they run; ask when it is not clear. A run needs the runner's pace (run_pace_seconds_per_km, 330 for 5:30 min/km) for its time and to be created: ask for it, never guess one.",
'Hikes: call propose_hike with a name, and day_id and start_time when known; to compare ways, call it up to three times in one step, each with a variant_label and along false, the way you recommend first (the card shows the first one chosen). Call create_hike only once the user chose a way. A hike over several days is one hike: stage_end on each stop a day ends at (no day_id), then each stage on its day with assign_place_to_day and tourStageKey.',
'The app draws a proposed, planned or saved tour (route, profile, stops, times, weather, warnings) and lists of tours as cards: do not repeat their figures or list them again, say in one sentence what matters. Once a tour is planned, offer what goes with it: places along it (search_tour_pois), what to pack (get_tour_packing, link_tour_packing), the GPX file (export_tour_gpx).',
],
server/src/nest/assistant/cards/tour/tour-change.cards.ts
+36 -6
View File
@@ -18,7 +18,7 @@ import {
straightMetres,
whole,
} from './tour-card-values';
import { hikeCard } from './tour-route.cards';
import { hikeCard, landSportOf } from './tour-route.cards';
import {
hikingPreferencesOf,
TOUR_ROUTE_LIMITS,
@@ -118,8 +118,12 @@ function heldProblem(card: TourRouteCard | null): TourRouteCard['problem'] {
return refuses && card?.problem ? card.problem : { why: 'not_planned', position: null, snappedM: null };
}
/** The points of a held hike or walk joined straight, as stops along the straight line. */
function straightCard(points: readonly Row[], activity: 'hike' | 'walk', fields: Partial<TourRouteCard>) {
/** The points of a held tour joined straight, as stops along the straight line. */
export function straightCard(
points: readonly Row[],
activity: TourRouteCard['activity'],
fields: Partial<TourRouteCard>,
): TourRouteCard | null {
const stops = points.flatMap((point) => {
const at = latLngOf(point);
return at ? [{ ...at, point }] : [];
@@ -155,19 +159,45 @@ function hikePoints(args: ToolArgs): Row[] {
return args.round_trip === true && points[0] ? [...points, points[0]] : points;
}
/** create_hike: the planned way as the proposal drew it, else the points straight. */
/**
* create_hike and create_tour: the planned way as the proposal drew it, else
* the points straight, a hike's under its limit, a bike tour's or a run's
* under its profile.
*/
export function createHikeCard(ctx: PreviewContext, args: ToolArgs, loaded: TourLoaded | null): TourRouteCard | null {
const name = argText(args.name, 120);
const planned = loaded ? hikeCard(loaded.plan, args, ctx.card, 'pending') : null;
if (planned?.routed) return fitted({ ...planned, name: name ?? planned.name, label: null });
const straight = straightCard(hikePoints(args), 'hike', {
const sport = landSportOf({}, args);
const own = sport ?? { limit: sacStepOf(args.max_hiking_difficulty) ?? TOURS_MAX_HIKING_DIFFICULTY };
const straight = straightCard(hikePoints(args), sport?.activity ?? 'hike', {
name,
limit: sacStepOf(args.max_hiking_difficulty) ?? TOURS_MAX_HIKING_DIFFICULTY,
...own,
problem: heldProblem(planned),
});
return straight ? fitted(straight) : null;
}
/** The fields propose_tour takes of a create_tour, as the planner's memo keys its way. */
const TOUR_PLAN_FIELDS = [
'name',
'activity',
'bike_profile',
'run_profile',
'run_pace_seconds_per_km',
'waypoints',
'round_trip',
'day_id',
'start_time',
] as const;
/** create_tour: plans the way through the points as propose_tour did (the planner's memo answers a recent one). */
export async function loadCreateTour(args: ToolArgs, read: CardReader): Promise<TourLoaded> {
const plan: ToolArgs = { along: false };
for (const key of TOUR_PLAN_FIELDS) if (args[key] !== undefined) plan[key] = args[key];
return { plan: await read('propose_tour', plan), saved: null };
}
/** create_city_walk: the stations joined straight; the way on foot is planned when the walk is saved. */
export function createCityWalkCard(_ctx: PreviewContext, args: ToolArgs): TourRouteCard | null {
const straight = straightCard(rowsIn(args.stations), 'walk', { name: argText(args.name, 120) });
server/src/nest/assistant/cards/tour/tour-describe.ts
+17 -2
View File
@@ -5,8 +5,8 @@ import { TOURS_MAX_HIKING_DIFFICULTY } from '@trek/shared';
/**
* The change cards of the tours an assistant creates and changes: a hike, a
* city walk, a change to a saved hike, tours taken in from a GPX file. The
* route reads as the names of its points in order, a hike's limit as its SAC
* bike tour, a run, a paddle or ski tour, a city walk, a change to a saved
* hike, tours taken in from a GPX file. The route reads as the names of its points in order, a hike's limit as its SAC
* grade (T1 to T6), a planned time in hours and minutes.
*/
@@ -58,6 +58,17 @@ function gpxName(gpx: unknown): string {
return close < 0 ? '' : text(gpx.slice(open + '<name>'.length, close));
}
/** A tour of another type than a hike created from its plan: its points in order, its day, its planned time and words. */
function describeSportCreate(ctx: PreviewContext, args: ToolArgs): Described {
const day = onDay(ctx, id(args, 'day_id'), args.start_time);
const rows = new Rows()
.add('route', routeOf(ctx, args.waypoints, args.round_trip))
.add('day', day)
.add('time', hours(args.planned_duration_minutes))
.add('description', text(args.description));
return { subject: text(args.name), rows, dayId: day ? id(args, 'day_id') : null, placeIds: [] };
}
export const TOUR_DESCRIBERS = {
create_hike: (ctx, args) => {
const day = onDay(ctx, id(args, 'day_id'), args.start_time);
@@ -69,6 +80,10 @@ export const TOUR_DESCRIBERS = {
.add('description', text(args.description));
return { subject: text(args.name), rows, dayId: day ? id(args, 'day_id') : null, placeIds: [] };
},
// A bike tour, a run, a paddle or ski tour: its points and day; its profile and figures are on the route card below.
create_tour: describeSportCreate,
create_paddle_tour: describeSportCreate,
create_ski_tour: describeSportCreate,
create_city_walk: (ctx, args) => {
const rows = new Rows().add('route', routeOf(ctx, args.stations, false)).add('description', text(args.description));
return { subject: text(args.name), rows, dayId: null, placeIds: linkedPlaceIds(ctx, args.stations) };
server/src/nest/assistant/cards/tour/tour-route.cards.ts
+49 -3
View File
@@ -28,10 +28,12 @@ import {
type RoutePoint,
} from './tour-card-values';
import {
BIKE_PROFILES,
cumulativeMetres,
HIKE_UNROUTED_REASONS,
legMinutes,
nearestAlongM,
RUN_PROFILES,
TOUR_ROUTE_LIMITS,
TOUR_WARNING_KINDS,
tourTypeKeySchema,
@@ -42,7 +44,8 @@ import {
} from '@trek/shared';
/**
* The cards of a hike the assistant proposed (propose_hike) and of a saved
* The cards of a hike, a bike tour or a run the assistant proposed
* (propose_hike, propose_tour) and of a saved
* tour it read (get_tour_plan), built from the tool's raw answer. A proposal
* draws its line only when the tool added it for drawing (the assistant
* always asks), so without `line_geometry` there is no card. A way that was
@@ -56,6 +59,35 @@ const SAME_SUMMIT_M = 150;
const LOOP_END_M = 60;
const UNROUTED: ReadonlySet<string> = new Set(HIKE_UNROUTED_REASONS);
const BIKE: ReadonlySet<string> = new Set(BIKE_PROFILES);
const RUN: ReadonlySet<string> = new Set(RUN_PROFILES);
/** A planned way's activity on land beyond a hike: a bike tour or a run, with its profile and a run's pace. */
type RoutingProfile = NonNullable<TourRouteCard['routingProfile']>;
type LandSport = Pick<TourRouteCard, 'activity' | 'routingProfile' | 'paceSecondsPerKm'>;
/**
* The bike tour or run a proposal (propose_tour) or its arguments name, with
* its profile (the planner's own where none is named) and a run's pace; null
* for a hike, whose card names none of them.
*/
export function landSportOf(plan: Row, args: Row): LandSport | null {
const activity = plan.activity ?? args.activity;
if (activity === 'bike') {
const profile = plan.bike_profile ?? args.bike_profile;
return {
activity,
routingProfile: typeof profile === 'string' && BIKE.has(profile) ? (profile as RoutingProfile) : 'touring',
};
}
if (activity !== 'run') return null;
const profile = plan.run_profile ?? args.run_profile;
return {
activity,
routingProfile: typeof profile === 'string' && RUN.has(profile) ? (profile as RoutingProfile) : 'running',
paceSecondsPerKm: whole(plan.run_pace_seconds_per_km ?? args.run_pace_seconds_per_km, 60, 3_600),
};
}
const WARNINGS: ReadonlySet<string> = new Set(TOUR_WARNING_KINDS);
/** Graded stretches merged where the step repeats, at most the card's share, the hardest kept. */
@@ -197,9 +229,11 @@ function unroutedHike(value: Row, args: Row, source: TourRouteCard['source']): T
const unreachable = recordOf(value.unreachable);
const why = typeof route.why === 'string' && UNROUTED.has(route.why) ? route.why : 'not_planned';
const along = straightMetres(points);
const sport = landSportOf(value, args);
return routeCard({
source,
activity: 'hike',
...sport,
name: clipped(value.name ?? args.name, 120),
label: clipped(value.variant_label ?? args.variant_label, 40),
limit: sacStepOf(value.max_hiking_difficulty ?? args.max_hiking_difficulty),
@@ -235,11 +269,16 @@ export function hikeCard(
const sac = plan.sac === null || plan.sac === undefined ? null : recordOf(plan.sac);
const start = clockOf(plan.start_time);
const own = waypointStops(rowsIn(plan.waypoints), start);
const basis = plan.duration_basis === 'din33466' || plan.duration_basis === 'router' ? plan.duration_basis : null;
const basis =
plan.duration_basis === 'din33466' || plan.duration_basis === 'router' || plan.duration_basis === 'pace'
? plan.duration_basis
: null;
const unknown = finite(sac?.unknown_share);
const sport = landSportOf(plan, args);
return routeCard({
source,
activity: 'hike',
...sport,
name: clipped(plan.name, 120),
label: clipped(plan.variant_label, 40),
distanceM: metresOf(plan.distance_m),
@@ -261,7 +300,7 @@ export function hikeCard(
});
}
/** propose_hike: the proposal as a card. */
/** propose_hike and propose_tour: the proposal as a card, a hike's or a bike tour's or a run's. */
export function proposalCard({ value, args, card }: AnswerInput): TourRouteCard | null {
const proposal = hikeCard(value, args, card, 'proposal');
return proposal ? fitted(proposal) : null;
@@ -347,6 +386,13 @@ export function savedTourCard({ value }: AnswerInput): TourRouteCard | null {
line,
stops: sortedStops(stops),
stages: whole(tour.stage_count, 2, 60),
...savedSportOf(activity.data, tour),
}),
);
}
/** A saved bike tour's or run's profile and a run's pace, as its card names them; nothing for any other type. */
function savedSportOf(activity: TourRouteCard['activity'], tour: Row): Partial<TourRouteCard> {
if (activity !== 'bike' && activity !== 'run') return {};
return landSportOf({ activity, ...tour }, {}) ?? {};
}
server/src/nest/assistant/cards/tour/tour-sport-change.cards.ts
+78
View File
@@ -0,0 +1,78 @@
import type { CardReader, PreviewContext, ToolArgs } from '../card-types';
import { recordOf, type Row } from '../card-values';
import { argText, fitted, latLngOf, rowsIn } from './tour-card-values';
import { straightCard } from './tour-change.cards';
import { paddleCard, skiCard } from './tour-sport.cards';
import type { TourRouteCard } from '@trek/shared';
/**
* The change cards of a paddle or ski tour the assistant saves from its plan
* (create_paddle_tour, create_ski_tour): the legs between its points planned
* again as the plan planned them, drawn as the plan's card was, waiting, under
* the name the tour is saved with. Where the plan cannot be read now, the
* points are drawn straight and the way is planned when the change is applied.
*/
/** What a held paddle or ski tour looked up: the plan of its legs, null where it could not be read. */
export interface SportLoaded {
plan: unknown;
}
/** The legs a tour's points make, each from one to the next, as the planning tools take them. */
export function legArgsOf(
args: ToolArgs,
): Array<{ from: { lat: number; lng: number }; to: { lat: number; lng: number } }> {
const points = rowsIn(args.waypoints).flatMap((point) => latLngOf(point) ?? []);
return points.slice(1).map((to, index) => ({ from: points[index] ?? to, to }));
}
/** The fields of a create a plan was asked with besides its legs, as the planning tool names them. */
function planArgs(args: ToolArgs, fields: Readonly<Record<string, string>>): ToolArgs {
const plan: ToolArgs = { legs: legArgsOf(args) };
for (const [from, to] of Object.entries(fields)) if (args[from] !== undefined) plan[to] = args[from];
return plan;
}
/** create_paddle_tour: its legs planned on the water as plan_paddle_route planned them. */
export async function loadCreatePaddle(args: ToolArgs, read: CardReader): Promise<SportLoaded | null> {
const plan = planArgs(args, { boat_type: 'boat', lake_style: 'lake_style', lock_policy: 'lock_policy' });
if (rowsIn(plan.legs).length === 0) return null;
return { plan: await read('plan_paddle_route', plan) };
}
/** create_ski_tour: its legs planned on the piste data as plan_ski_route planned them. */
export async function loadCreateSki(args: ToolArgs, read: CardReader): Promise<SportLoaded | null> {
const plan = planArgs(args, { discipline: 'discipline', technique: 'technique', options: 'options' });
if (rowsIn(plan.legs).length === 0) return null;
return { plan: await read('plan_ski_route', plan) };
}
/** A plan's card, waiting under the name the tour is saved with; else the points straight. */
function heldCard(
ctx: PreviewContext,
args: ToolArgs,
loaded: SportLoaded | null,
activity: 'kayak' | 'ski',
): TourRouteCard | null {
const name = argText(args.name, 120);
const input = { toolCallId: '', args: { legs: legArgsOf(args) } as Row, card: ctx.card, today: ctx.today };
const value = loaded ? recordOf(loaded.plan) : null;
const drawn = value ? (activity === 'kayak' ? paddleCard : skiCard)({ ...input, value }) : null;
if (drawn && drawn.warnings.every((warning) => warning.kind !== 'legs_failed')) {
return fitted({ ...drawn, source: 'pending', name });
}
const straight = straightCard(rowsIn(args.waypoints), activity, { name });
return straight ? fitted(straight) : null;
}
export function createPaddleCard(
ctx: PreviewContext,
args: ToolArgs,
loaded: SportLoaded | null,
): TourRouteCard | null {
return heldCard(ctx, args, loaded, 'kayak');
}
export function createSkiCard(ctx: PreviewContext, args: ToolArgs, loaded: SportLoaded | null): TourRouteCard | null {
return heldCard(ctx, args, loaded, 'ski');
}
server/src/nest/roadtrip/roadtrip-router.service.ts
+18 -12
View File
@@ -101,14 +101,16 @@ export interface RouteOptions {
*/
footOnly?: boolean;
/**
* A hike's own pedestrian costing (its hiking limit and preferences, as
* `hikingCosting` builds them), sent to Valhalla as the planner in the
* browser sends it. Only Valhalla knows a hiking limit: OSRM's foot profile
* takes a T5 ridge as readily as a forest road. So a walk asked with one is
* asked of Valhalla alone and fails rather than fall back to OSRM, with a
* `RouteRefusal` of `no_valhalla` where there is no Valhalla to ask.
* A tour's own costing, sent to Valhalla as the planner in the browser
* sends it: on foot a hike's (its hiking limit and preferences, as
* `hikingCosting` builds them) or a run's (`runCosting`), by bike the
* bicycle costing of its profile (`bikeCosting`). Only Valhalla knows these:
* OSRM's foot profile takes a T5 ridge as readily as a forest road, and its
* bike profile knows no road bike from a mountain bike. So a way asked with
* one is asked of Valhalla alone and fails rather than fall back to OSRM,
* with a `RouteRefusal` of `no_valhalla` where there is no Valhalla to ask.
*/
costingOptions?: Readonly<Record<string, number>>;
costingOptions?: Readonly<Record<string, number | string>>;
}
export type { TracedWay };
@@ -304,7 +306,8 @@ export class RoadtripRouterService {
): Promise<RoadtripRoute> {
const settings = await this.settings.getUserSettings(userId);
const footOnly = options.footOnly === true && profile === 'walking';
const hiking = profile === 'walking' ? options.costingOptions : undefined;
// A tour's own costing goes with a way on foot or by bike; a drive has its avoidances instead.
const hiking = profile === 'walking' || profile === 'cycling' ? options.costingOptions : undefined;
const key = JSON.stringify([
userId,
tripId,
@@ -348,8 +351,11 @@ export class RoadtripRouterService {
const { base, valhalla } = routersOf(settings);
let weighted = false;
if (hiking) {
if (!valhalla) throw new RouteRefusal('no_valhalla', 'No Valhalla is set to plan a hike with');
const legs = await this.valhallaLegs(valhalla, points, 'pedestrian', { ...hiking });
const cycling = mode === 'cycling';
if (!valhalla) {
throw new RouteRefusal('no_valhalla', `No Valhalla is set to plan a ${cycling ? 'bike tour' : 'hike'} with`);
}
const legs = await this.valhallaLegs(valhalla, points, cycling ? 'bicycle' : 'pedestrian', { ...hiking });
({ line, distance, duration, parts, snapped } = routeOfLegs(points, legs));
weighted = true;
} else if (footOnly && valhalla) {
@@ -473,8 +479,8 @@ export class RoadtripRouterService {
private async valhallaLegs(
valhalla: string,
points: Point[],
costing: 'auto' | 'pedestrian',
options: Record<string, number>,
costing: 'auto' | 'pedestrian' | 'bicycle',
options: Record<string, number | string>,
offBoatLines = false,
): Promise<ValhallaLegs> {
const legs: ValhallaLegs = [];
server/src/nest/ski-routing/ski-routing.module.ts
+2
View File
@@ -38,5 +38,7 @@ function routerRunner() {
TrekPlacesWinterService,
{ provide: SKI_ROUTER_RUNNER, useFactory: routerRunner },
],
// A ski tour the assistant planned is planned again when it is saved (ToursModule).
exports: [SkiRoutingService],
})
export class SkiRoutingModule {}
server/src/nest/tours/hike-plan.helpers.ts
+22 -4
View File
@@ -321,6 +321,19 @@ export interface HikeProposalContext {
along: HikeAlongPlace[] | null;
/** Null where none was asked or it could not be had. */
weather: WeatherResult | null;
/**
* A bike tour's or a run's own time on the move, in minutes, which stands
* for the plan's and is shared out over the legs by their length: a ride's
* is the router's for its profile, a run's its distance at the pace (null
* without one). A hike leaves it out and keeps the signposts' rule.
*/
movingMinutes?: number | null;
}
/** The minutes from the start to each point, the whole time shared out by how far along the way each lies. */
function minutesByLength(positions: readonly number[], total: number): number[] {
const length = positions.at(-1) ?? 0;
return positions.map((at) => (length > 0 ? Math.round((total * at) / length) : 0));
}
/**
@@ -341,16 +354,21 @@ export function hikeProposalOf(
const routed = plan.kind === 'routed' ? plan : null;
const positions = routed ? waypointPositionsOf(planned, points) : null;
const heights = routed?.has_heights && line ? heightRangeOf(line) : null;
const minutes = routed && line && positions ? waypointMinutesOf(line, positions, routed.duration_minutes) : null;
const own = context.movingMinutes !== undefined;
const total = routed ? (own ? (context.movingMinutes ?? null) : routed.duration_minutes) : null;
let minutes: number[] | null = null;
if (line && positions && total !== null) {
minutes = own ? minutesByLength(positions, total) : waypointMinutesOf(line, positions, total);
}
const arrivals = arrivalsOf(request.start_time ?? null, minutes ?? points.map(() => null));
// One day's sun and hours say nothing about a hike over several days.
const day =
routed && context.date && hikeStagesOf(points) === 1
total !== null && context.date && hikeStagesOf(points) === 1
? hikeScheduleOf({
date: context.date,
dayId: context.dayId,
start: request.start_time ?? null,
minutes: routed.duration_minutes,
minutes: total,
weather: context.weather,
})
: null;
@@ -362,7 +380,7 @@ export function hikeProposalOf(
distance_m: routed?.distance_m ?? null,
ascent_m: routed?.ascent_m ?? null,
descent_m: routed?.descent_m ?? null,
duration_minutes: routed?.duration_minutes ?? null,
duration_minutes: total,
duration_basis: routed?.duration_basis ?? null,
heights_known: heights !== null,
min_ele_m: heights?.min ?? null,
server/src/nest/tours/hike-plan.service.ts
+102 -17
View File
@@ -17,8 +17,20 @@ import {
weatherPointOf,
type KeptWay,
} from './hike-plan.helpers';
import { HikeRoutingService, type PlannedHike } from './hike-routing.service';
import { HikeRoutingService, type PlannedActivity, type PlannedHike } from './hike-routing.service';
import { noTrackFound } from './tour-file-import.helpers';
import {
ALONG_CATEGORIES,
asHikeCreate,
asHikeProposal,
checkedRequest,
movingMinutesOf,
plannedActivityOf,
refusesSave,
tourCreateCommandOf,
tourProposalOf,
unplannedTourMessage,
} from './tour-plan.helpers';
import { TourPoiSearchService } from './tour-poi-search.service';
import { tourRevisionConflict } from './tour-revision';
import { thinnedLine } from './tours.helpers';
@@ -26,13 +38,14 @@ import { ToursService, type ImportGpxAsTourResult, type TourCreateCommand } from
import { InjectRepository } from '@mikro-orm/nestjs';
import { Injectable } from '@nestjs/common';
import {
HIKE_ALONG_CATEGORIES,
HIKE_ALONG_CORRIDOR_M,
HIKE_PLAN_MAX_WAYPOINTS,
hikeStageIssues,
hikingPreferencesOf,
TOUR_POI_MAX_LINE_POINTS,
tourGpxImportFieldsSchema,
tourPlanCreateRequestSchema,
tourProposeRequestSchema,
TOURS_MAX_HIKING_DIFFICULTY,
type GeometryPoint,
type HikeAlongPlace,
@@ -45,6 +58,9 @@ import {
type TourCreateResponse,
type TourDetailResponse,
type TourGpxImportRequest,
type TourPlanCreateRequest,
type TourProposal,
type TourProposeRequest,
type HikeRouteOutcome,
type TourUpdateRequest,
type TourWaypoint,
@@ -157,6 +173,7 @@ export class HikePlanService {
limit: number | undefined,
preferences: HikingPreferences | null | undefined,
grades: boolean,
activity: PlannedActivity | null = null,
): Promise<PlannedHike> {
// The router takes the points only: where a stage ends is the hike's, not the way's.
const waypoints = points.map(({ lat, lng, name, poi_category }) => ({
@@ -169,7 +186,8 @@ export class HikePlanService {
userId,
tripId,
{ waypoints, max_hiking_difficulty: limit, hiking_preferences: preferences },
{ grades },
// A hike asks as it always has; a ride or a run names its activity and reads no grades.
activity ? { grades: false, activity } : { grades },
);
}
@@ -181,17 +199,41 @@ export class HikePlanService {
* best effort: without them the proposal still answers.
*/
async propose(userId: number, tripId: number, request: HikeProposeRequest): Promise<HikeProposal> {
return await this.proposed(userId, tripId, request, null, null);
}
/**
* A bike tour or a run proposed the way a hike is: the same points, day,
* places along the way and weather, planned for its profile and timed by
* its own time (a ride the router's, a run its distance at the pace).
*/
async proposeTour(userId: number, tripId: number, request: TourProposeRequest): Promise<TourProposal> {
const asked = checkedRequest<TourProposeRequest>(tourProposeRequestSchema, request);
const activity = plannedActivityOf(asked);
const base = await this.proposed(userId, tripId, asHikeProposal(asked), activity, asked.run_pace_seconds_per_km);
return tourProposalOf(base, asked, activity);
}
/** The proposal of a hike, or with `activity` of a ride or a run, timed by its own time. */
private async proposed(
userId: number,
tripId: number,
request: HikeProposeRequest,
activity: PlannedActivity | null,
pace: number | null | undefined,
): Promise<HikeProposal> {
refuseBadStages(request.waypoints, request.round_trip);
const day = await this.dayOf(tripId, request.day_id, request.date);
const points = hikePointsOf(request.waypoints, request.round_trip);
const { max_hiking_difficulty: limit, hiking_preferences: preferences } = request;
const planned = await this.plan(userId, tripId, points, limit, preferences, true);
const planned = await this.plan(userId, tripId, points, limit, preferences, activity === null, activity);
const line = planned.plan.kind === 'routed' ? planned.line : null;
const [along, weather] = await Promise.all([
line && request.along !== false ? this.alongOf(line) : null,
line && request.along !== false ? this.alongOf(line, activity?.activity ?? 'hike') : null,
line && day.date ? this.weatherOf(weatherPointOf(points, planned), day.date) : null,
]);
return hikeProposalOf(request, points, planned, { ...day, along, weather });
const timed = activity ? { movingMinutes: movingMinutesOf(activity, pace, planned) } : {};
return hikeProposalOf(request, points, planned, { ...day, along, weather, ...timed });
}
/** The trip's day a hike is planned on and its date, or the date given without a day. */
@@ -206,17 +248,24 @@ export class HikePlanService {
return { dayId: day.id, date: day.date };
}
/** Summits, huts, water and viewpoints near the way, or null where the search could not be made. */
private async alongOf(line: readonly GeometryPoint[]): Promise<HikeAlongPlace[] | null> {
/**
* The places near the way the activity stops for (summits, huts, water and
* viewpoints on a hike), or null where the search could not be made.
*/
private async alongOf(
line: readonly GeometryPoint[],
type: keyof typeof ALONG_CATEGORIES,
): Promise<HikeAlongPlace[] | null> {
const categories = ALONG_CATEGORIES[type];
try {
const found = await this.poiSearch.search({
tour_type: 'hike',
categories: [...HIKE_ALONG_CATEGORIES],
tour_type: type,
categories: [...categories],
corridor_m: HIKE_ALONG_CORRIDOR_M,
line: thinnedLine(line, TOUR_POI_MAX_LINE_POINTS).map(([lat, lng]): [number, number] => [lat, lng]),
});
// Not one kind could be searched: nothing found would read as nothing there.
if (found.unavailable.length === HIKE_ALONG_CATEGORIES.length) return null;
if (found.unavailable.length === categories.length) return null;
return alongPlacesOf(found.pois, line);
} catch (err: unknown) {
logWarn(`[Hike] no places along the way: ${reasonOf(err)}`);
@@ -258,17 +307,53 @@ export class HikePlanService {
throw notRouted(unplannedCreateMessage(way.route));
}
const command = hikeCreateCommandOf(request, points, way, planned.plan.max_hiking_difficulty);
if (day?.dayId == null) {
return await this.saveOnDay(tripId, command, day?.dayId ?? null, request.start_time, way.route);
}
/**
* A bike tour or a run created the way a hike is (create): planned again
* through its points for its profile, saved with its line and heights, its
* time (a ride the router's, a run its distance at the pace), its profile
* and pace, put on its day in the same write. A router that did not answer
* saves its points only; any other reason refuses it, and nothing is saved.
*/
async createTour(userId: number, tripId: number, request: TourPlanCreateRequest): Promise<HikeCreated> {
const asked = checkedRequest<TourPlanCreateRequest>(tourPlanCreateRequestSchema, request);
const activity = plannedActivityOf(asked);
const hike = asHikeCreate(asked);
const day = hike.day_id === undefined ? null : await this.dayOf(tripId, hike.day_id, undefined);
const points = hikePointsOf(hike.waypoints, hike.round_trip);
const planned = await this.plan(userId, tripId, points, undefined, undefined, false, activity);
const way = keptWayOf(planned);
if (refusesSave(way.route)) throw notRouted(unplannedTourMessage(way.route, activity.activity));
const minutes = movingMinutesOf(activity, asked.run_pace_seconds_per_km, planned);
const command = tourCreateCommandOf(asked, points, way, activity, minutes);
return await this.saveOnDay(tripId, command, day?.dayId ?? null, hike.start_time, way.route);
}
/**
* A planned tour saved through the creation the planner's save uses. With
* a day it is put on that day in the same write, its start kept as the
* visit's, and the trip is told of the tour and the visit once both are
* saved, as the planner's save and its drop onto the day tell it.
*/
async saveOnDay(
tripId: number,
command: TourCreateCommand,
dayId: number | null,
startTime: string | undefined,
route: HikeRouteOutcome,
): Promise<HikeCreated> {
if (dayId === null) {
const created = await this.tours.createTour(String(tripId), command);
return { ...created, route: way.route, assignment: null };
return { ...created, route, assignment: null };
}
const dayId = day.dayId;
const written = await this.uow.transactional(async () => {
const placeId = await this.tours.insertTour(tripId, command);
const added = await this.assignments.createAssignment(dayId, placeId, null);
if (!added) throw new Error('Created visit could not be loaded');
if (!request.start_time) return { placeId, assignment: added, reordered: null, vias: null };
const timed = await this.assignments.updateTime(added.id, request.start_time, null);
if (!startTime) return { placeId, assignment: added, reordered: null, vias: null };
const timed = await this.assignments.updateTime(added.id, startTime, null);
return { placeId, ...timed, assignment: timed.assignment ?? added };
});
const trip = String(tripId);
@@ -278,7 +363,7 @@ export class HikePlanService {
if (written.reordered) this.assignments.broadcast(trip, 'assignment:reordered', written.reordered, undefined);
if (written.vias) this.assignments.broadcast(trip, 'roadtripVia:changed', written.vias, undefined);
await this.assignments.reconcile(tripId);
return { ...created, route: way.route, assignment: { id: written.assignment.id, day_id: dayId } };
return { ...created, route, assignment: { id: written.assignment.id, day_id: dayId } };
}
/**
server/src/nest/tours/hike-routing.service.ts
+53 -10
View File
@@ -6,6 +6,7 @@ import { TourTrailGradeService } from './tour-trail-grade.service';
import { thinnedLine } from './tours.helpers';
import { Injectable } from '@nestjs/common';
import {
bikeCosting,
computeTourMetrics,
HIKE_MAX_LINE_POINTS,
HIKE_PLAN_LINE_POINTS,
@@ -14,14 +15,18 @@ import {
hikingCosting,
hikingPreferencesOf,
hikingTimeMinutes,
runCosting,
sacStepOf,
TOUR_MAX_SNAP_M,
TOUR_TRAIL_GRADE_MAX_WAYS,
TOURS_MAX_HIKING_DIFFICULTY,
type BikeProfile,
type GeometryPoint,
type HikePlan,
type HikePlanRequest,
type HikingPreferences,
type HikeTrailGrades,
type RunProfile,
type SacStep,
type UnroutedHikePlan,
} from '@trek/shared';
@@ -79,14 +84,26 @@ interface KeptPlan {
planned: PlannedHike;
}
/** The request as the memo keys it: who asked in which trip, the points to about a metre, the limit, the preferences. */
function memoKeyOf(userId: number, tripId: number, request: HikePlanRequest): string {
/**
* A tour planned through the same way as a hike but for another activity: a
* bike tour by bike for its profile, a run on foot for its profile. Neither
* takes a hiking limit, preferences or SAC grades.
*/
export type PlannedActivity = { activity: 'bike'; profile: BikeProfile } | { activity: 'run'; profile: RunProfile };
/**
* The request as the memo keys it: who asked in which trip, the points to
* about a metre, the limit, the preferences, and for a bike tour or a run its
* activity and profile.
*/
function memoKeyOf(userId: number, tripId: number, request: HikePlanRequest, activity: PlannedActivity | null): string {
const points = request.waypoints.map(({ lat, lng }) => [
Number(lat.toFixed(PLAN_MEMO_DECIMALS)),
Number(lng.toFixed(PLAN_MEMO_DECIMALS)),
]);
const limit = request.max_hiking_difficulty ?? TOURS_MAX_HIKING_DIFFICULTY;
return JSON.stringify([userId, tripId, points, limit, hikingPreferencesOf(request.hiking_preferences)]);
const key = [userId, tripId, points, limit, hikingPreferencesOf(request.hiking_preferences)];
return JSON.stringify(activity ? [...key, activity.activity, activity.profile] : key);
}
/** What a plan asks for besides the way and its heights. */
@@ -96,6 +113,27 @@ export interface HikePlanOptions {
* trail grades): a proposal shows them, a hike being saved keeps none.
*/
grades: boolean;
/**
* A bike tour or a run, planned with its own costing and timed by the
* router; a hike when left out. Its limit and preferences are a hike's and
* go unread.
*/
activity?: PlannedActivity;
}
/**
* How a way is asked of the router: on foot with a hike's limit and
* preferences, by bike with its profile's bicycle costing, on foot with a
* run's pedestrian costing.
*/
function costingOf(
activity: PlannedActivity | null,
limit: number,
preferences: HikingPreferences | null,
): ['walking' | 'cycling', Readonly<Record<string, number | string>>] {
if (activity?.activity === 'bike') return ['cycling', bikeCosting(activity.profile)];
if (activity?.activity === 'run') return ['walking', runCosting(activity.profile)];
return ['walking', hikingCosting(limit, preferences)];
}
/** What went wrong, for the log. */
@@ -139,14 +177,16 @@ export class HikeRoutingService {
request: HikePlanRequest,
options?: HikePlanOptions,
): Promise<PlannedHike> {
const withGrades = options?.grades ?? true;
const activity = options?.activity ?? null;
// SAC grades are a hike's: a bike tour or a run never reads them.
const withGrades = activity === null && (options?.grades ?? true);
// The tools check their own requests; a change plans through the points a hike has saved, held here to the same.
const checked = hikePlanRequestSchema.safeParse(request);
if (!checked.success) throw badRequest(checked.error.issues.map((issue) => issue.message).join('; '));
const key = memoKeyOf(userId, tripId, request);
const key = memoKeyOf(userId, tripId, request, activity);
const kept = this.recall(key, withGrades);
if (kept) return kept;
const planned = await this.planned(userId, tripId, request, withGrades);
const planned = await this.planned(userId, tripId, request, withGrades, activity);
// Only a way with every height is kept: one without is asked again, and its heights with it.
if (planned.plan.kind === 'routed' && planned.plan.has_heights && planned.line) {
const grades = withGrades && planned.plan.grades !== null;
@@ -193,6 +233,7 @@ export class HikeRoutingService {
tripId: number,
request: HikePlanRequest,
withGrades: boolean,
activity: PlannedActivity | null,
): Promise<PlannedHike> {
const limit = request.max_hiking_difficulty ?? TOURS_MAX_HIKING_DIFFICULTY;
const preferences = hikingPreferencesOf(request.hiking_preferences);
@@ -205,8 +246,8 @@ export class HikeRoutingService {
let route: RoadtripRoute;
try {
const points = request.waypoints.map(({ lat, lng }) => ({ lat, lng }));
const costingOptions = hikingCosting(limit, preferences);
route = await this.router.route(userId, tripId, ANY_DAY, points, 'walking', [], { costingOptions });
const [mode, costingOptions] = costingOf(activity, limit, preferences);
route = await this.router.route(userId, tripId, ANY_DAY, points, mode, [], { costingOptions });
} catch (err: unknown) {
if (!(err instanceof RouteRefusal)) logWarn(`[Hike] no way for trip ${tripId}: ${reasonOf(err)}`);
return unrouted(whyNot(err));
@@ -226,6 +267,8 @@ export class HikeRoutingService {
const ascent = metrics.elevationGainM;
const descent = metrics.elevationLossM;
const heights = ascent !== null && descent !== null;
// The signposts' rule is a walker's: a ride keeps the router's time for its profile, and a run's pace is set later.
const byRule = heights && activity === null;
return {
plan: {
kind: 'routed',
@@ -234,10 +277,10 @@ export class HikeRoutingService {
distance_m: Math.round(lengthM),
ascent_m: heights ? Math.round(ascent) : null,
descent_m: heights ? Math.round(descent) : null,
duration_minutes: heights
duration_minutes: byRule
? hikingTimeMinutes(metrics.distanceKm, ascent, descent)
: Math.round(route.leg.seg.duration / 60),
duration_basis: heights ? 'din33466' : 'router',
duration_basis: byRule ? 'din33466' : 'router',
has_heights: heights,
line: thinnedLine(line, HIKE_PLAN_LINE_POINTS),
profile: profileOf(line, HIKE_PLAN_PROFILE_SAMPLES),
server/src/nest/tours/sport-tour-create.helpers.ts
+158
View File
@@ -0,0 +1,158 @@
import type { TourCreateCommand } from './tours.service';
import {
cumulativeMetres,
estimatePaddleTime,
paddleLayoutOfTrack,
paddleMovingSeconds,
recommendedPaddleSpeedKmh,
skiOptionsForDiscipline,
type GeometryPoint,
type PaddleRouteLeg,
type PaddleTourCreateRequest,
type SkiRouteLeg,
type SkiTourCreateRequest,
type SportTourPoint,
type TourWaypoint,
type TrackMarks,
} from '@trek/shared';
/**
* The pure halves of a paddle or ski tour saved from a plan
* (SportTourCreateService): the legs between its points, the portages and
* locks the paddle router found laid along the whole line, the joined line of
* a ski tour with its time, and the write each one makes, as the planner's
* save writes it.
*/
/** What a save keeps of a plan: the whole line with its heights (null without them) and a paddle tour's marks. */
export interface SportPlanned {
line: GeometryPoint[] | null;
marks: TrackMarks | null;
}
/** The legs a tour's points make, each from one point to the next. */
export function legsOf(points: readonly SportTourPoint[]): Array<{ from: SportTourPoint; to: SportTourPoint }> {
return points.slice(1).map((to, index) => ({ from: points[index] as SportTourPoint, to }));
}
type PlannedPaddleLeg = Extract<PaddleRouteLeg, { status: 'ok' }>;
/**
* The portages and locks of the planned legs, in metres along the whole
* line as the legs are joined: each leg's stretches placed by its own line,
* after the length of the legs before it. A lock has no time of its own
* entered, which the estimate names as unknown rather than zero.
*/
export function paddleMarksOf(legs: readonly PlannedPaddleLeg[]): TrackMarks {
const marks: TrackMarks = { portages: [], locks: [] };
let offset = 0;
for (const leg of legs) {
const along = cumulativeMetres(leg.geometry.map(([lat, lng]) => [lat, lng] as const));
for (const segment of leg.segments) {
const from = offset + (along[segment.from] ?? 0);
const to = offset + (along[segment.to] ?? 0);
if (segment.kind === 'portage' && to > from) marks.portages.push({ from_m: from, to_m: to, extra_minutes: null });
if (segment.kind === 'lock') {
marks.locks.push({ at_m: (from + to) / 2, wait_minutes: null, transit_minutes: null });
}
}
offset += along.at(-1) ?? 0;
}
return marks;
}
/** The length of a line in metres. */
function lengthOf(line: readonly GeometryPoint[]): number {
return cumulativeMetres(line.map(([lat, lng]) => [lat, lng] as const)).at(-1) ?? 0;
}
/**
* The write of a paddle tour, as the planner's save writes one: its boat and
* water, the speeds its time is reckoned with (the boat's starting speed where
* none is given) and that time, the moving part of the planner's estimate.
*/
export function paddleCommandOf(
request: PaddleTourCreateRequest,
waypoints: TourWaypoint[],
planned: SportPlanned,
): TourCreateCommand {
const boat = request.boat_type ?? 'kayak';
const speed = request.paddle_speed_kmh ?? recommendedPaddleSpeedKmh(boat);
const portageSpeed = request.portage_speed_kmh ?? null;
const estimate = planned.line
? estimatePaddleTime(paddleLayoutOfTrack(lengthOf(planned.line), planned.marks), {
paddleSpeedKmh: speed,
portageSpeedKmh: portageSpeed,
breakMinutes: null,
})
: null;
return {
name: request.name,
description: request.description,
tour_type: 'kayak',
route_geometry: planned.line,
duration_seconds: estimate ? paddleMovingSeconds(estimate) : null,
max_hiking_difficulty: null,
hiking_preferences: null,
boat_type: boat,
water_context: request.water_context,
paddle_speed_kmh: speed,
portage_speed_kmh: portageSpeed,
paddle_lake_style: request.lake_style ?? null,
...(request.planned_duration_minutes !== undefined
? { planned_duration_minutes: request.planned_duration_minutes }
: {}),
waypoints,
};
}
type PlannedSkiLeg = Extract<SkiRouteLeg, { status: 'ok' }>;
/**
* The planned legs of a ski tour as one line, each point with its height
* where the piste data has one, a point repeating the one before it left out,
* and the piste router's time: skiing, lifts, waiting and walking together.
*/
export function skiLineOf(legs: readonly PlannedSkiLeg[]): { line: GeometryPoint[]; seconds: number } {
const line: GeometryPoint[] = [];
for (const [lat, lng, height] of legs.flatMap((leg) => leg.geometry)) {
const last = line.at(-1);
if (last && last[0] === lat && last[1] === lng) continue;
line.push(height === null ? [lat, lng] : [lat, lng, height]);
}
const seconds = legs.reduce((sum, { seconds: parts }) => sum + parts.ski + parts.lift + parts.wait + parts.walk, 0);
return { line, seconds };
}
/**
* The write of a ski tour, as the planner's save writes one: its discipline
* (and a cross-country technique), the options the piste router was asked
* with as the discipline reads them, the build its legs were planned on, every
* leg as planned by it, and its time, given only with the line it belongs to.
*/
export function skiCommandOf(
request: SkiTourCreateRequest,
waypoints: TourWaypoint[],
planned: SportPlanned,
plan: { build: string | null; seconds: number; legs: number },
): TourCreateCommand {
const crossCountry = request.discipline === 'cross_country';
return {
name: request.name,
description: request.description,
tour_type: 'ski',
route_geometry: planned.line,
duration_seconds: planned.line ? Math.round(plan.seconds) : null,
max_hiking_difficulty: null,
hiking_preferences: null,
ski_discipline: request.discipline,
ski_technique: crossCountry ? (request.technique ?? null) : null,
ski_options: skiOptionsForDiscipline(request.discipline, request.options ?? {}),
ski_route_build: plan.build,
ski_planned_legs: Array.from({ length: plan.legs }, (_, index) => index),
...(request.planned_duration_minutes !== undefined
? { planned_duration_minutes: request.planned_duration_minutes }
: {}),
waypoints,
};
}
server/src/nest/tours/sport-tour-create.service.ts
+167
View File
@@ -0,0 +1,167 @@
import { Tours } from '../../db/entities/Tours.entity';
import type { ToursRepository } from '../../db/repositories/Tours.repository';
import { logWarn } from '../audit/audit-log.logger';
import { DomainError, notFound } from '../common/domain-error';
import { PaddleRoutingService } from '../paddle-routing/paddle-routing.service';
import { RoadtripRouterService } from '../roadtrip/roadtrip-router.service';
import { SkiRoutingService } from '../ski-routing/ski-routing.service';
import { hikeWaypointsOf } from './hike-plan.helpers';
import { HikePlanService, type HikeCreated } from './hike-plan.service';
import { heightsOrNone, joinedLine } from './hike-routing.helpers';
import {
legsOf,
paddleCommandOf,
paddleMarksOf,
skiCommandOf,
skiLineOf,
type SportPlanned,
} from './sport-tour-create.helpers';
import { checkedRequest } from './tour-plan.helpers';
import { InjectRepository } from '@mikro-orm/nestjs';
import { Injectable } from '@nestjs/common';
import {
paddleRouteRequestSchema,
paddleTourCreateRequestSchema,
skiRouteRequestSchema,
skiTourCreateRequestSchema,
type GeometryPoint,
type HikeRouteOutcome,
type PaddleTourCreateRequest,
type SkiTourCreateRequest,
} from '@trek/shared';
/** A leg the router could not plan: the tour is refused, as a 422 the tools answer with its text. */
function legRefused(index: number, code: string, where: string): DomainError {
return new DomainError(
422,
`Leg ${index + 1} could not be planned ${where} (${code}): move its points or plan it again. Nothing was saved.`,
{ code: 'tour_not_routed' },
);
}
function reasonOf(err: unknown): string {
return err instanceof Error ? err.message : String(err);
}
/**
* A paddle tour or a ski tour the assistant planned (plan_paddle_route,
* plan_ski_route) saved once the traveller said yes, the way the planner's
* save writes one. Its legs run from each point to the next and are planned
* again by the same router, on the water or on the piste data; a leg that
* cannot be planned refuses the tour and nothing is saved. The legs are
* joined into one line with the height of every point (the piste data's
* where it has them all, else Valhalla's, as for a hike); where the heights
* cannot be read the tour is saved with its points only (route_pending), and
* the planner plans it when it is opened. A paddle tour is timed with the
* planner's estimate (water at the paddling speed, each portage the router
* carries round at the carrying speed), a ski tour with the piste router's
* time. With a day it is put on that day in the same write (HikePlanService's
* save, so a tour of any type lands on its day alike).
*/
@Injectable()
export class SportTourCreateService {
constructor(
private readonly paddle: PaddleRoutingService,
private readonly ski: SkiRoutingService,
private readonly router: RoadtripRouterService,
private readonly hikes: HikePlanService,
@InjectRepository(Tours) private readonly toursRepo: ToursRepository,
) {}
async createPaddle(userId: number, tripId: number, request: PaddleTourCreateRequest): Promise<HikeCreated> {
const asked = checkedRequest<PaddleTourCreateRequest>(paddleTourCreateRequestSchema, request);
const dayId = await this.dayOf(tripId, asked.day_id);
const planned = await this.paddle.route(
paddleRouteRequestSchema.parse({
legs: legsOf(asked.waypoints),
boat: asked.boat_type ?? 'kayak',
lake_style: asked.lake_style,
lock_policy: asked.lock_policy,
}),
);
const legs = planned.legs.map((leg, index) => {
if (leg.status === 'failed') throw legRefused(index, leg.code, 'on the water');
return leg;
});
const flat = joinedLine(legs.flatMap((leg) => leg.geometry.map(([lat, lng]): [number, number] => [lat, lng])));
const line = await this.withHeights(userId, flat);
const saved = this.planned(line, paddleMarksOf(legs));
return await this.save(
tripId,
paddleCommandOf(asked, hikeWaypointsOf(asked.waypoints), saved),
dayId,
asked,
saved,
);
}
async createSki(userId: number, tripId: number, request: SkiTourCreateRequest): Promise<HikeCreated> {
const asked = checkedRequest<SkiTourCreateRequest>(skiTourCreateRequestSchema, request);
const dayId = await this.dayOf(tripId, asked.day_id);
const planned = await this.ski.route(
skiRouteRequestSchema.parse({
legs: legsOf(asked.waypoints),
discipline: asked.discipline,
technique: asked.discipline === 'cross_country' ? (asked.technique ?? null) : null,
options: asked.options ?? {},
}),
);
const legs = planned.legs.map((leg, index) => {
if (leg.status === 'failed') throw legRefused(index, leg.code, 'on the piste data');
return leg;
});
const { line, seconds } = skiLineOf(legs);
// The piste data's heights where it has one for every point, else Valhalla's, as the planner reads them.
const measured = line.every((point) => point.length === 3)
? line
: await this.withHeights(
userId,
line.map(([lat, lng]): [number, number] => [lat, lng]),
);
const saved = this.planned(measured, null);
const command = skiCommandOf(asked, hikeWaypointsOf(asked.waypoints), saved, {
build: planned.build,
seconds,
legs: legs.length,
});
return await this.save(tripId, command, dayId, asked, saved);
}
/** The joined line as it is kept: whole with its heights, or none where a height is missing. */
private planned(line: GeometryPoint[], marks: SportPlanned['marks']): SportPlanned {
const heights = line.length >= 2 && line.every((point) => point.length === 3);
return { line: heights ? line : null, marks };
}
/** The line with the height of every point, or as it was where the heights could not all be read. */
private async withHeights(userId: number, flat: Array<[number, number]>): Promise<GeometryPoint[]> {
try {
return heightsOrNone(flat, await this.router.heights(userId, flat));
} catch (err: unknown) {
logWarn(`[SportTour] no heights: ${reasonOf(err)}`);
return heightsOrNone(flat, null);
}
}
/** The trip's day a tour is put on; a day of another trip is not found. */
private async dayOf(tripId: number, dayId: number | undefined): Promise<number | null> {
if (dayId === undefined) return null;
const day = await this.toursRepo.dayOfTrip(tripId, dayId);
if (!day) throw notFound('Day not found');
return day.id;
}
private async save(
tripId: number,
command: Parameters<HikePlanService['saveOnDay']>[1],
dayId: number | null,
asked: { start_time?: string },
saved: SportPlanned,
): Promise<HikeCreated> {
// Without its heights the tour waits for its way, as a hike does when the router did not answer.
const route: HikeRouteOutcome = saved.line
? { planned: true }
: { planned: false, why: 'router_unavailable', position: null };
return await this.hikes.saveOnDay(tripId, command, dayId, asked.start_time, route);
}
}
server/src/nest/tours/tour-plan.helpers.ts
+180
View File
@@ -0,0 +1,180 @@
import { badRequest } from '../common/domain-error';
import { hikeWaypointsOf, type KeptWay } from './hike-plan.helpers';
import type { PlannedActivity, PlannedHike } from './hike-routing.service';
import type { TourCreateCommand } from './tours.service';
import {
HIKE_ALONG_CATEGORIES,
runMinutesAtPace,
TOUR_MAX_SNAP_M,
type HikeCreateRequest,
type HikeProposal,
type HikeProposeRequest,
type HikeRouteOutcome,
type HikeStop,
type TourPlanActivity,
type TourPlanCreateRequest,
type TourPoiCategory,
type TourProposal,
type TourProposeRequest,
type UnroutedHikePlan,
} from '@trek/shared';
import type { z } from 'zod';
/**
* The pure halves of a bike tour or a run an assistant plans over MCP
* (propose_tour, create_tour), on top of a hike's (hike-plan.helpers): the
* profile it is planned for, the places looked for along it, its time on the
* move, the proposal it answers and the write it makes. One plan and one save
* for every activity; only these differ.
*/
/** The activity and profile a request plans for, the planner's own profile where none is named. */
export function plannedActivityOf(request: {
activity: TourPlanActivity;
bike_profile?: PlannedActivity['profile'];
run_profile?: PlannedActivity['profile'];
}): PlannedActivity {
if (request.activity === 'bike') {
const profile = request.bike_profile;
return {
activity: 'bike',
profile: profile === 'road' || profile === 'gravel' || profile === 'mtb' ? profile : 'touring',
};
}
return { activity: 'run', profile: request.run_profile === 'trail' ? 'trail' : 'running' };
}
/** What a proposal looks for along the way, by activity: a hike its summits and huts, a ride and a run what they stop for. */
export const ALONG_CATEGORIES: Readonly<Record<'hike' | TourPlanActivity, readonly TourPoiCategory[]>> = {
hike: HIKE_ALONG_CATEGORIES,
bike: ['drinking_water', 'bike_repair', 'food', 'viewpoint'],
run: ['drinking_water', 'toilets', 'viewpoint', 'park'],
};
/** A request of propose_tour as a hike's proposal reads it: the same points, day and words, no hiking limit. */
export function asHikeProposal({
activity: _activity,
bike_profile: _bike,
run_profile: _run,
run_pace_seconds_per_km: _pace,
...request
}: TourProposeRequest): HikeProposeRequest {
return request;
}
/** A request of create_tour as a hike's create reads it: the same points, day, words and planned time. */
export function asHikeCreate({
activity: _activity,
bike_profile: _bike,
run_profile: _run,
run_pace_seconds_per_km: _pace,
...request
}: TourPlanCreateRequest): HikeCreateRequest {
return request;
}
/**
* A bike tour's or a run's time on the move, in whole minutes: a ride the
* router's for its profile, a run its distance at the runner's pace and
* nothing else (null without a pace, never the router's walking time). Null
* where no way was planned.
*/
export function movingMinutesOf(
activity: PlannedActivity,
pace: number | null | undefined,
{ plan }: PlannedHike,
): number | null {
if (plan.kind !== 'routed') return null;
if (activity.activity === 'bike') return plan.duration_minutes;
return pace == null ? null : runMinutesAtPace(plan.distance_m / 1000, pace);
}
/**
* The proposal of a bike tour or a run, from a hike's proposal of the same
* points timed by its own time: its activity, profile and pace, how its time
* was reckoned, and nothing of a hike's limit, preferences or grades.
*/
export function tourProposalOf(
base: HikeProposal,
request: TourProposeRequest,
activity: PlannedActivity,
): TourProposal {
const bike = activity.activity === 'bike';
const pace = bike ? null : (request.run_pace_seconds_per_km ?? null);
let basis: TourProposal['duration_basis'] = null;
if (base.duration_minutes !== null) basis = bike ? 'router' : 'pace';
return {
...base,
activity: activity.activity,
bike_profile: bike ? activity.profile : null,
run_profile: bike ? null : activity.profile,
run_pace_seconds_per_km: pace,
duration_basis: basis,
max_hiking_difficulty: null,
hiking_preferences: null,
sac: null,
} as TourProposal;
}
/**
* The write of a bike tour or a run created from its points, as the
* planner's save writes one: the way it keeps with its heights, its time on
* the move, its profile (and a run's pace), and nothing of a hike's.
*/
export function tourCreateCommandOf(
request: TourPlanCreateRequest,
points: readonly HikeStop[],
way: KeptWay,
activity: PlannedActivity,
minutes: number | null,
): TourCreateCommand {
const bike = activity.activity === 'bike';
return {
name: request.name,
description: request.description,
tour_type: activity.activity,
route_geometry: way.line,
duration_seconds: way.line && minutes !== null ? minutes * 60 : null,
max_hiking_difficulty: null,
hiking_preferences: null,
bike_profile: bike ? activity.profile : null,
run_profile: bike ? null : activity.profile,
run_pace_seconds_per_km: bike ? null : (request.run_pace_seconds_per_km ?? null),
...(request.planned_duration_minutes !== undefined
? { planned_duration_minutes: request.planned_duration_minutes }
: {}),
waypoints: hikeWaypointsOf(points),
};
}
/** Why no way was planned for a ride or a run, in words that say what to do about it. */
const UNPLANNED: Readonly<Record<UnroutedHikePlan['why'], (named: string, position: number | null) => string>> = {
no_valhalla: (named) => `TREK has no Valhalla router here to plan ${named} with its profile.`,
router_unavailable: () => 'The router did not answer, for the way or for its heights; try again in a moment.',
no_way: (named) => `No way for ${named} of this profile joins these points: try another profile or move the points.`,
point_off_the_way: (_named, position) =>
`Point ${position ?? ''} is further than ${TOUR_MAX_SNAP_M} m from any way: move it onto a way.`,
too_long: (named) => `The way is too long to plan as ${named}: split it into shorter tours.`,
};
/** The refusal of a bike tour or a run whose way could not be planned: nothing is saved. */
export function unplannedTourMessage(
{ why, position }: Pick<UnroutedHikePlan, 'why' | 'position'>,
activity: TourPlanActivity,
): string {
const named = activity === 'bike' ? 'a bike tour' : 'a run';
return `${UNPLANNED[why](named, position)} Nothing was saved.`;
}
/** Whether a way that was not planned refuses the save: every reason but a router that did not answer. */
export function refusesSave(route: HikeRouteOutcome): route is Extract<HikeRouteOutcome, { planned: false }> {
return 'why' in route && route.why !== 'router_unavailable';
}
/** A request checked whole, its refinements included: an MCP tool reads only its schema's shape. */
export function checkedRequest<T>(schema: z.ZodType<T>, value: unknown): T {
const result = schema.safeParse(value);
if (result.error) throw badRequest(result.error.issues.map((issue) => issue.message).join('; '));
return result.data as T;
}
server/src/nest/tours/tour-plan.mcp.ts
+121
View File
@@ -0,0 +1,121 @@
import { ADDON_IDS } from '../../addons';
import { noAccess, permissionDenied } from '../../mcp/tools/_shared';
import {
McpController,
Tool,
TOOL_ANNOTATIONS_NON_IDEMPOTENT,
TOOL_ANNOTATIONS_READONLY,
ok,
type McpContext,
} from '../../nest-mcp';
import { addonGate } from '../addons/addon-gate';
import { AddonsService } from '../addons/addons.service';
import { McpToolGuardsService } from '../mcp-shared/mcp-tool-guards.service';
import { TripAccessService } from '../trip-membership/trip-access.service';
import { HikePlanService } from './hike-plan.service';
import { SportTourCreateService } from './sport-tour-create.service';
import {
idSchema,
paddleTourCreateRequestSchema,
skiTourCreateRequestSchema,
tourPlanCreateRequestSchema,
tourProposeRequestSchema,
type PaddleTourCreateRequest,
type SkiTourCreateRequest,
type TourPlanCreateRequest,
type TourProposeRequest,
} from '@trek/shared';
/** What every create here says of the day it may be put on, and of where to go on from it. */
const ON_A_DAY =
'With day_id the tour is put on that day of the trip in the same write, start_time kept as the start of that visit (which needs day editing permission too); assignment names the visit, null without a day. The answer is the tour as list_tours reads it (tour.place_id is the tour id, its revision 1), route and assignment. Put it on a day later with assign_place_to_day, link it to the packing list with link_tour_packing, export it with export_tour_gpx. Needs place editing permission on the trip. Create it only after the traveller said yes.';
/**
* Every tour type besides a hike and a city walk planned and saved with the
* traveller over MCP: a bike tour or a run proposed and created through the
* hike's own plan and save (HikePlanService, one path for every activity on
* land), a paddle or ski tour planned with plan_paddle_route or
* plan_ski_route saved through SportTourCreateService. A proposal reads only;
* a create writes through the creation the planner's save uses, with
* 'place_edit' on the trip as REST asks (ToursController), and 'day_edit' as
* well for a tour put on a day (AssignmentsController). A refusal of the
* service is a DomainError, which the registry answers as an error result
* with the text REST sends.
*/
@McpController()
export class TourPlanMcp {
constructor(
private readonly hikes: HikePlanService,
private readonly sports: SportTourCreateService,
private readonly access: TripAccessService,
private readonly guards: McpToolGuardsService,
// Read by the addon gate of every tool here.
readonly addons: AddonsService,
) {}
/** Whether the user may create a tour in the trip, and put it on a day where one is named. */
private async mayCreate(tripId: number, userId: number, dayId: number | undefined): Promise<boolean> {
if (!(await this.guards.hasTripPermission('place_edit', tripId, userId))) return false;
// Putting it on a day is what REST's assignment route asks 'day_edit' for.
return dayId === undefined || (await this.guards.hasTripPermission('day_edit', tripId, userId));
}
@Tool({
name: 'propose_tour',
description:
"Plan a bike tour (activity bike) or a run (activity run) for a trip and show it to the traveller, without saving anything; give it a name. A hike is planned with propose_hike, a city walk with propose_city_walk, a paddle tour with plan_paddle_route, a ski or winter tour with plan_ski_route. The way runs through waypoints in order (the start, the points on the way, the end; with round_trip back to the start), planned by TREK's Valhalla router as the tour planner plans it for the profile: a bike tour's bike_profile touring (paved ways, cycle paths and quiet roads, for a city or trekking bike, the default), road (asphalt only, a road bike), gravel (gravel and farm tracks) or mtb (rough tracks and trails, a mountain bike); a run's run_profile running (runnable, mostly paved ways, the default) or trail (forest tracks and natural paths up to T2). Pick the profile from what the traveller rides or how they like to run, and ask when it is not clear. A bike tour's time (duration_minutes, duration_basis router) is the router's riding time for its profile; a run's is its distance at run_pace_seconds_per_km, the runner's own pace (duration_basis pace), and a run without a pace has no time: ask for the pace. The answer gives distance_m, ascent_m, descent_m, min_ele_m, max_ele_m, high_point, every point with at_m, snapped_m, minutes and, with start_time, its arrival, and along: water, food, toilets, viewpoints (a bike repair shop on a ride, a park on a run) near the way. With day_id or date, schedule gives the day with sunrise, sunset and the weather by the hour, and warnings name a start in the dark, an arrival after sunset, thunder or rain. Where no way was planned, route says why as propose_hike does (no_valhalla, router_unavailable, no_way, point_off_the_way, too_long). To compare ways, propose each with its own variant_label and along false, the one you recommend first. The chat shows the route, its profile, times and weather as a card: never list coordinates or the figures, sum it up in a sentence. Create it with create_tour only after the traveller said yes.",
inputSchema: { tripId: idSchema, ...tourProposeRequestSchema.shape },
annotations: TOOL_ANNOTATIONS_READONLY,
when: addonGate(ADDON_IDS.TOURS),
access: { group: 'trips', mode: 'read' },
})
async proposeTour({ tripId, ...request }: { tripId: number } & TourProposeRequest, ctx: McpContext) {
if (!(await this.access.findAccessible(tripId, ctx.userId))) return noAccess();
return ok(await this.hikes.proposeTour(ctx.userId, tripId, request));
}
@Tool({
name: 'create_tour',
description: `Create a bike tour or a run in a trip from points the traveller confirmed, usually the name, activity, profile and waypoints of a proposal of propose_tour with its round_trip. A run is created only with run_pace_seconds_per_km, the runner's pace. It is saved the way the planner saves one: a tour of type bike or run with its points in order, the way planned by the same router for the same profile and kept whole with its heights, its distance, ascent, descent and time (a bike tour the router's riding time, a run its distance at the pace), its bike_profile or run_profile and pace, and planned_duration_minutes (the time out, breaks included) where given. Where the router did not answer, for the way or its heights (route planned false, why router_unavailable), the tour is saved with its points only (route_pending true) and TREK plans the way when someone opens it in the planner. Any other reason refuses the tour with why, and nothing is saved. ${ON_A_DAY}`,
inputSchema: { tripId: idSchema.describe('The trip to create the tour in'), ...tourPlanCreateRequestSchema.shape },
annotations: TOOL_ANNOTATIONS_NON_IDEMPOTENT,
when: addonGate(ADDON_IDS.TOURS),
access: { group: 'trips', mode: 'write' },
})
async createTour({ tripId, ...request }: { tripId: number } & TourPlanCreateRequest, ctx: McpContext) {
if (!(await this.access.findAccessible(tripId, ctx.userId))) return noAccess();
if (!(await this.mayCreate(tripId, ctx.userId, request.day_id))) return permissionDenied();
return ok(await this.hikes.createTour(ctx.userId, tripId, request));
}
@Tool({
name: 'create_paddle_tour',
description: `Create a paddle tour in a trip from a plan of plan_paddle_route the traveller confirmed: waypoints are the put-in, the points on the way and the take-out (the from of the first leg and the to of every leg, in order), with the boat_type, lake_style and lock_policy the plan was asked with, and water_context (river or lake), which the tour needs. Each leg is planned again on the water by the same router and the tour is saved as the planner saves one: its points, the whole line with its heights, its distance and its time on the move by the planner's estimate (water at paddle_speed_kmh, the boat's starting speed when left out, each portage the router carries round at portage_speed_kmh, locks without a time of their own). A leg that cannot be planned on the water refuses the tour and nothing is saved. Where the heights could not be read the tour is saved with its points only (route_pending true). ${ON_A_DAY}`,
inputSchema: {
tripId: idSchema.describe('The trip to create the tour in'),
...paddleTourCreateRequestSchema.shape,
},
annotations: TOOL_ANNOTATIONS_NON_IDEMPOTENT,
when: addonGate(ADDON_IDS.TOURS),
access: { group: 'trips', mode: 'write' },
})
async createPaddleTour({ tripId, ...request }: { tripId: number } & PaddleTourCreateRequest, ctx: McpContext) {
if (!(await this.access.findAccessible(tripId, ctx.userId))) return noAccess();
if (!(await this.mayCreate(tripId, ctx.userId, request.day_id))) return permissionDenied();
return ok(await this.sports.createPaddle(ctx.userId, tripId, request));
}
@Tool({
name: 'create_ski_tour',
description: `Create a ski or winter tour in a trip from a plan of plan_ski_route the traveller confirmed: waypoints are the start, the points on the way and the end (the from of the first leg and the to of every leg, in order), with the discipline, technique (cross_country only, and needed there) and options the plan was asked with. Each leg is planned again on the piste data by the same router and the tour is saved as the planner saves one: its points, the whole line with its heights, its distance, climb and descent, the piste router's time (skiing, lifts, waiting and walking), its discipline and options and the piste data build it was planned on. A leg that cannot be planned refuses the tour and nothing is saved (loading: the ski area is still being downloaded, try again in a moment). Where the heights could not be read the tour is saved with its points only (route_pending true). ${ON_A_DAY}`,
inputSchema: { tripId: idSchema.describe('The trip to create the tour in'), ...skiTourCreateRequestSchema.shape },
annotations: TOOL_ANNOTATIONS_NON_IDEMPOTENT,
when: addonGate(ADDON_IDS.TOURS),
access: { group: 'trips', mode: 'write' },
})
async createSkiTour({ tripId, ...request }: { tripId: number } & SkiTourCreateRequest, ctx: McpContext) {
if (!(await this.access.findAccessible(tripId, ctx.userId))) return noAccess();
if (!(await this.mayCreate(tripId, ctx.userId, request.day_id))) return permissionDenied();
return ok(await this.sports.createSki(ctx.userId, tripId, request));
}
}
server/src/nest/tours/tours.module.ts
+12 -1
View File
@@ -21,11 +21,13 @@ import { NotificationsModule } from '../notifications/notifications.module';
import { OverpassModule } from '../overpass/overpass.module';
import { PackingModule } from '../packing/packing.module';
import { PaddleObstaclesModule } from '../paddle-obstacles/paddle-obstacles.module';
import { PaddleRoutingModule } from '../paddle-routing/paddle-routing.module';
import { PermissionsModule } from '../permissions/permissions.module';
import { PlaceImportModule } from '../place-import/place-import.module';
import { PlacesModule } from '../places/places.module';
import { RoadtripModule } from '../roadtrip/roadtrip.module';
import { SchedulingModule } from '../scheduling/scheduling.module';
import { SkiRoutingModule } from '../ski-routing/ski-routing.module';
import { TripMembershipModule } from '../trip-membership/trip-membership.module';
import { WandererModule } from '../wanderer/wanderer.module';
import { WeatherModule } from '../weather/weather.module';
@@ -38,6 +40,7 @@ import { CollectionToursService } from './collection-tours.service';
import { HikePlanMcp } from './hike-plan.mcp';
import { HikePlanService } from './hike-plan.service';
import { HikeRoutingService } from './hike-routing.service';
import { SportTourCreateService } from './sport-tour-create.service';
import { TourActivitiesController } from './tour-activities.controller';
import { TourActivitiesMcp } from './tour-activities.mcp';
import { TourActivitiesService } from './tour-activities.service';
@@ -64,6 +67,7 @@ import { TourPackingMcp } from './tour-packing.mcp';
import { PaddleCheckCache } from './tour-paddle-check.cache';
import { TourPaddleCheckService } from './tour-paddle-check.service';
import { TourPaddlePlanService } from './tour-paddle-plan.service';
import { TourPlanMcp } from './tour-plan.mcp';
import { TourPoiSearchController } from './tour-poi-search.controller';
import { TourPoiSearchService } from './tour-poi-search.service';
import { TourSkiController } from './tour-ski.controller';
@@ -102,7 +106,9 @@ import { Module } from '@nestjs/common';
* the same writes, its way planned on the server by HikeRoutingService, its
* day read from WeatherModule's detailed weather and the places along it from
* the tours' own search; one created on a day is put there through
* AssignmentsService in the same write. A
* AssignmentsService in the same write. A bike tour or a run goes the same
* way for its profile, and a paddle or ski tour an assistant planned is saved
* after PaddleRoutingModule's or SkiRoutingModule's router planned its legs again. A
* change to a saved city walk an assistant prepares for review is laid onto
* its saved points and planned on foot by the same router, and saves nothing
* (MCP-T02); once the traveller
@@ -155,6 +161,9 @@ import { Module } from '@nestjs/common';
SchedulingModule,
// A proposed hike's day reads the detailed weather at its highest point: sun, hours and warnings.
WeatherModule,
// A paddle or ski tour the assistant planned is planned again by its own router when it is saved.
PaddleRoutingModule,
SkiRoutingModule,
MikroOrmModule.forFeature([
CollectionTours,
Tours,
@@ -212,6 +221,7 @@ import { Module } from '@nestjs/common';
CityWalkBriefingService,
HikeRoutingService,
HikePlanService,
SportTourCreateService,
TourChangePreviewService,
TourChangeSaveService,
TourChangeUndoService,
@@ -227,6 +237,7 @@ import { Module } from '@nestjs/common';
TourWalkImportMcp,
CityWalkMcp,
HikePlanMcp,
TourPlanMcp,
TourChangeMcp,
TourChangeUndoMcp,
TourActivitiesMcp,
server/tests/e2e/tours-plan-types.e2e.test.ts
+268
View File
@@ -0,0 +1,268 @@
/**
* Tours e2e for every tour type besides a hike planned with an assistant over
* MCP: a bike tour proposed and created, a run created at its pace, a paddle
* tour and a ski tour saved from their plans, every tool called through a
* real MCP session on the whole app (buildApp, the real registry with its
* addon gates, scopes and error mapper, the real services and a migrated temp
* SQLite). The way on land is planned by the road trip's router with its
* paced queue; only the routing host behind safeFetchAdminConfigured is a
* stub answering /route and /height as Valhalla does. The legs on the water
* and on the piste data come from spies on the container's
* PaddleRoutingService and SkiRoutingService, the places along the way from
* one on TourPoiSearchService, so nothing leaves the process.
*/
import { buildApp } from '../../src/bootstrap';
import { Places } from '../../src/db/entities/Places.entity';
import { Tours } from '../../src/db/entities/Tours.entity';
import { createLocalMcpServer, McpRegistryService } from '../../src/nest-mcp';
import { withRequestContext } from '../../src/nest/database/request-context';
import { PaddleRoutingService } from '../../src/nest/paddle-routing/paddle-routing.service';
import { SkiRoutingService } from '../../src/nest/ski-routing/ski-routing.service';
import { TourPoiSearchService } from '../../src/nest/tours/tour-poi-search.service';
import { safeFetchAdminConfigured } from '../../src/utils/ssrfGuard';
import { countRows, findRow } from '../helpers/factories/rows';
import { setAddonEnabled } from '../helpers/factories/settings';
import { makeTrip } from '../helpers/factories/trips';
import { makeUser } from '../helpers/factories/users';
import { spyOnRealtime, type RealtimeSpies } from '../helpers/fake-realtime';
import { valhallaRoute } from '../helpers/valhalla';
import { MikroORM } from '@mikro-orm/core';
import { Client } from '@modelcontextprotocol/sdk/client/index';
import { InMemoryTransport } from '@modelcontextprotocol/sdk/inMemory';
import type { INestApplication } from '@nestjs/common';
import { BIKE_COSTING, tourProposalSchema } from '@trek/shared';
import { afterAll, beforeAll, describe, expect, it, vi } from 'vitest';
vi.mock('../../src/utils/ssrfGuard', async (importOriginal) => ({
...(await importOriginal<typeof import('../../src/utils/ssrfGuard')>()),
safeFetchAdminConfigured: vi.fn(),
}));
let app: INestApplication;
let orm: MikroORM;
let broadcasts: RealtimeSpies;
/** A point `k` steps of 0.0005° north of 47.9° N on 11.1° E, about 56 m a step. */
const at = (k: number): [number, number] => [47.9 + k / 2000, 11.1];
const stepsOf = (from: number, to: number) => Array.from({ length: to - from + 1 }, (_, index) => at(from + index));
const WAYPOINTS = [
{ lat: at(0)[0], lng: 11.1, name: 'Station' },
{ lat: at(20)[0], lng: 11.1, name: 'Lake' },
];
const json = (body: unknown, status = 200) => new Response(JSON.stringify(body), { status });
/** The routing host: one leg of 1.1 km ridden in four minutes, the height of every point. */
function valhalla() {
vi.mocked(safeFetchAdminConfigured).mockImplementation(async (url, init) => {
const body = JSON.parse(String(init?.body ?? '{}')) as { shape?: Array<{ lat: number; lon: number }> };
if (url.endsWith('/route')) return json(valhallaRoute([{ line: stepsOf(0, 20), km: 1.112, seconds: 240 }]));
if (url.endsWith('/height')) {
return json({ range_height: (body.shape ?? []).map((point, index) => [index, 600 + index]) });
}
return json({}, 404);
});
}
async function moveOn(done: () => boolean): Promise<void> {
if (done()) return;
await vi.advanceTimersByTimeAsync(100);
await moveOn(done);
}
/** A call moved through to its end on the test's clock, which the router's pacing waits on. */
async function settled<T>(pending: Promise<T>): Promise<T> {
let done = false;
const outcome = pending.then(
(value) => {
done = true;
return { value };
},
(error: unknown) => {
done = true;
return { error };
},
);
await moveOn(() => done);
const result = await outcome;
if ('error' in result) throw result.error;
return result.value;
}
/** One tool call as `userId` over an MCP session of its own, with every scope; the JSON it answered or its error. */
async function callTool(userId: number, name: string, args: Record<string, unknown>) {
vi.useFakeTimers({ toFake: ['setTimeout', 'clearTimeout'] });
try {
return await settled(callOnce(userId, name, args));
} finally {
vi.useRealTimers();
}
}
async function callOnce(userId: number, name: string, args: Record<string, unknown>) {
const server = createLocalMcpServer('TREK tour types e2e');
const around = (_info: unknown, call: () => unknown): unknown => withRequestContext(orm, call);
await withRequestContext(orm, () =>
app
.get(McpRegistryService)
.attach(
server,
{ userId, scopes: null, isStaticToken: false },
{ include: (kind, tool) => kind === 'tool' && tool === name, around },
),
);
const [clientTransport, serverTransport] = InMemoryTransport.createLinkedPair();
const client = new Client({ name: 'tour-types-e2e', version: '1.0.0' });
await server.connect(serverTransport);
await client.connect(clientTransport);
try {
const result = await client.callTool({ name, arguments: args });
const content = Array.isArray(result.content) ? (result.content as Array<{ text?: string }>) : [];
const text = content[0]?.text ?? '';
return result.isError === true ? { error: text } : JSON.parse(text);
} finally {
await client.close();
await server.close();
}
}
/** The events the trip was sent, emptied after each read. */
function sent(): string[] {
const events = broadcasts.broadcast.mock.calls.map((call) => String(call[1]));
broadcasts.broadcast.mockClear();
return events;
}
beforeAll(async () => {
app = await buildApp();
orm = app.get(MikroORM);
broadcasts = spyOnRealtime(app);
await setAddonEnabled(orm, 'tours', true);
vi.spyOn(app.get(TourPoiSearchService), 'search').mockResolvedValue({
pois: [],
truncated: false,
partial: false,
capped: false,
unavailable: [],
});
vi.spyOn(app.get(PaddleRoutingService), 'route').mockResolvedValue({
legs: [
{
status: 'ok',
geometry: stepsOf(0, 20),
segments: [{ kind: 'water', from: 0, to: 20, name: 'Isar', source: null, osm_ref: null, grade: null }],
distance_m: 1112,
snapped_m: { from: 1, to: 1 },
},
],
graph_rev: 'r1',
});
vi.spyOn(app.get(SkiRoutingService), 'route').mockResolvedValue({
legs: [
{
status: 'ok',
geometry: stepsOf(0, 20).map(([lat, lng], index): [number, number, number] => [lat, lng, 1800 - index * 10]),
segments: [],
distance_m: 1112,
climb_m: 0,
descent_m: 200,
seconds: { ski: 300, lift: 0, wait: 0, walk: 0 },
snapped_m: { from: 1, to: 1 },
area_ids: ['a1'],
why: [],
alternatives: [],
},
],
build: 'b1',
stale: false,
area_names: ['Garmisch'],
colour_scheme: 'europe',
attribution: '',
});
valhalla();
}, 60_000);
afterAll(async () => {
await app?.close();
});
describe('every tour type planned with an assistant over MCP', () => {
it('a bike tour is proposed for its profile and created as the planner saves one, the trip told', async () => {
const { user } = await makeUser(orm);
const trip = await makeTrip(orm, user.id, { title: 'Lakes' });
const proposal = await callTool(user.id, 'propose_tour', {
tripId: trip.id,
name: 'Lake ride',
activity: 'bike',
bike_profile: 'road',
waypoints: WAYPOINTS,
});
expect(tourProposalSchema.parse(proposal)).toEqual(proposal);
expect(proposal).toMatchObject({
activity: 'bike',
bike_profile: 'road',
duration_minutes: 4,
duration_basis: 'router',
});
const routeCall = vi.mocked(safeFetchAdminConfigured).mock.calls.find(([url]) => String(url).endsWith('/route'));
expect(JSON.parse(String(routeCall?.[1]?.body))).toMatchObject({
costing: 'bicycle',
costing_options: { bicycle: BIKE_COSTING.road },
});
expect(await countRows(orm, Places, { trip: trip.id })).toBe(0);
const created = await callTool(user.id, 'create_tour', {
tripId: trip.id,
name: 'Lake ride',
activity: 'bike',
bike_profile: 'road',
waypoints: WAYPOINTS,
});
expect(created.route).toEqual({ planned: true });
const tour = await findRow(orm, Tours, { place: created.tour.place_id });
expect(tour).toMatchObject({ bike_profile: 'road', duration: 4 });
expect(sent()).toEqual(['tours:changed', 'place:created']);
});
it("a run is created only with the runner's pace, and timed at it", async () => {
const { user } = await makeUser(orm);
const trip = await makeTrip(orm, user.id, { title: 'Run' });
const args = { tripId: trip.id, name: 'Isar run', activity: 'run', run_profile: 'trail', waypoints: WAYPOINTS };
const refused = await callTool(user.id, 'create_tour', args);
expect(refused.error).toContain("a run is saved with the runner's pace");
const created = await callTool(user.id, 'create_tour', { ...args, run_pace_seconds_per_km: 360 });
expect(created.tour).toMatchObject({ tour_type: 'run', run_profile: 'trail', duration: 7 });
});
it('a paddle tour and a ski tour are saved from their plans with their heights and times', async () => {
const { user } = await makeUser(orm);
const trip = await makeTrip(orm, user.id, { title: 'Water and snow' });
const points = [
{ lat: at(0)[0], lng: 11.1 },
{ lat: at(20)[0], lng: 11.1 },
];
const paddle = await callTool(user.id, 'create_paddle_tour', {
tripId: trip.id,
name: 'Isar',
waypoints: points,
water_context: 'river',
});
expect(paddle.tour).toMatchObject({ tour_type: 'kayak', boat_type: 'kayak', water_context: 'river' });
// 1112 m at a kayak's 4 km/h.
expect(paddle.tour.duration).toBe(17);
const ski = await callTool(user.id, 'create_ski_tour', {
tripId: trip.id,
name: 'Garmisch',
waypoints: points,
discipline: 'alpine',
});
expect(ski.tour).toMatchObject({ tour_type: 'ski', ski_discipline: 'alpine', duration: 5 });
const place = await findRow(orm, Places, { id: ski.tour.place_id });
expect(JSON.parse(String(place?.route_geometry))[0]).toEqual([...at(0), 1800]);
const refused = await callTool(user.id, 'create_paddle_tour', { tripId: trip.id, name: 'X', waypoints: points });
expect(refused.error).toBeTruthy();
expect(await countRows(orm, Places, { trip: trip.id })).toBe(2);
});
});
server/tests/integration/broadcast-parity/tours-roadtrip.cases.ts
+110
View File
@@ -3,7 +3,9 @@ import { Places } from '../../../src/db/entities/Places.entity';
import { TourChangeSteps } from '../../../src/db/entities/TourChangeSteps.entity';
import { TourWaypoints } from '../../../src/db/entities/TourWaypoints.entity';
import { Tours } from '../../../src/db/entities/Tours.entity';
import { PaddleRoutingService } from '../../../src/nest/paddle-routing/paddle-routing.service';
import { RoadtripRouterService } from '../../../src/nest/roadtrip/roadtrip-router.service';
import { SkiRoutingService } from '../../../src/nest/ski-routing/ski-routing.service';
import { proposalIdOf } from '../../../src/nest/tours/tour-change-proposal';
import { makeDayAssignment } from '../../helpers/factories/itinerary';
import { makePlace } from '../../helpers/factories/places';
@@ -41,6 +43,64 @@ function routerDown(app: INestApplication): () => void {
return () => route.mockRestore();
}
/**
* No water or piste data in a test: the paddle and piste routers plan the
* one leg asked as a straight stretch, and no height host answers, so each
* tour is saved with its points only, as both tools save one then.
*/
function sportRouters(app: INestApplication): () => void {
const geometry: Array<[number, number]> = [
[47, 11],
[47.02, 11.02],
];
const paddle = vi.spyOn(app.get(PaddleRoutingService), 'route').mockResolvedValue({
legs: [
{
status: 'ok',
geometry,
segments: [{ kind: 'water', from: 0, to: 1, name: null, source: null, osm_ref: null, grade: null }],
distance_m: 2700,
snapped_m: { from: 0, to: 0 },
},
],
graph_rev: null,
});
const ski = vi.spyOn(app.get(SkiRoutingService), 'route').mockResolvedValue({
legs: [
{
status: 'ok',
geometry: geometry.map(([lat, lng]): [number, number, null] => [lat, lng, null]),
segments: [],
distance_m: 2700,
climb_m: 0,
descent_m: 0,
seconds: { ski: 600, lift: 0, wait: 0, walk: 0 },
snapped_m: { from: 0, to: 0 },
area_ids: [],
why: [],
alternatives: [],
},
],
build: null,
stale: false,
area_names: [],
colour_scheme: 'europe',
attribution: '',
});
const heights = vi.spyOn(app.get(RoadtripRouterService), 'heights').mockResolvedValue(null);
return () => {
paddle.mockRestore();
ski.mockRestore();
heights.mockRestore();
};
}
/** The two points of every tour the parity cases create. */
const TWO_POINTS = [
{ lat: 47, lng: 11 },
{ lat: 47.02, lng: 11.02 },
];
/** A hike's line with its heights, as the planner saves one. */
const HIKE_LINE: [number, number, number][] = [
[47, 11, 600],
@@ -343,6 +403,56 @@ export const toursRoadtrip: CaseGroup = {
stub: routerDown,
expect: ['tours:changed', 'place:created'],
},
{
tool: 'create_tour',
args: (s) => ({ tripId: s.trip.id, name: 'Lake ride', activity: 'bike', waypoints: TWO_POINTS }),
// The planner saves a new bike tour through the tours route, with the line it planned in the browser.
rest: {
method: 'post',
path: (s) => `/api/trips/${s.trip.id}/tours`,
body: () => ({
...hikeBody('Lake ride'),
tour_type: 'bike',
bike_profile: 'touring',
max_hiking_difficulty: null,
}),
},
stub: routerDown,
expect: ['tours:changed', 'place:created'],
},
{
tool: 'create_paddle_tour',
args: (s) => ({ tripId: s.trip.id, name: 'River day', waypoints: TWO_POINTS, water_context: 'river' }),
rest: {
method: 'post',
path: (s) => `/api/trips/${s.trip.id}/tours`,
body: () => ({
...hikeBody('River day'),
tour_type: 'kayak',
boat_type: 'kayak',
water_context: 'river',
max_hiking_difficulty: null,
}),
},
stub: sportRouters,
expect: ['tours:changed', 'place:created'],
},
{
tool: 'create_ski_tour',
args: (s) => ({ tripId: s.trip.id, name: 'Piste day', waypoints: TWO_POINTS, discipline: 'alpine' }),
rest: {
method: 'post',
path: (s) => `/api/trips/${s.trip.id}/tours`,
body: () => ({
...hikeBody('Piste day'),
tour_type: 'ski',
ski_discipline: 'alpine',
max_hiking_difficulty: null,
}),
},
stub: sportRouters,
expect: ['tours:changed', 'place:created'],
},
{
// Only the name changes, so the hike keeps its way and the router is not asked.
tool: 'update_tour',
server/tests/unit/nest/assistant/assistant-proposal-sports.test.ts
+137
View File
@@ -0,0 +1,137 @@
/**
* ASTPROP-SPORT-001 to ASTPROP-SPORT-007
*
* "Plan this" on every tour type: what a proposed bike tour or run and a
* paddle or ski plan are taken as, the points a plan's legs make, the water
* and the name a paddle tour gets, and the tour type's word in the user's
* language where nothing names the tour.
*/
import {
isSportPlan,
sportTakeArgsOf,
tourTypeWord,
waypointsOfLegs,
} from '../../../../src/nest/assistant/assistant-proposal-sports';
import { takeArgsOf } from '../../../../src/nest/assistant/assistant-proposals.service';
import { writeToolOf } from '../../../../src/nest/assistant/assistant-tools.constants';
import { tourRouteCard } from '../../../helpers/assistant-tour-cards';
import { describe, expect, it } from 'vitest';
const A = { lat: 48.1, lng: 11.6 };
const B = { lat: 48.11, lng: 11.6 };
const C = { lat: 48.12, lng: 11.6 };
const ok = (segments: Array<{ kind: string; name: string | null }>) => ({ status: 'ok', segments });
describe('the points of a plan', () => {
it('ASTPROP-SPORT-001: are the first start and every end, where each leg goes on from the one before', () => {
expect(
waypointsOfLegs([
{ from: A, to: B },
{ from: B, to: C },
]),
).toEqual([A, B, C]);
// A leg that starts elsewhere is no part of one tour.
expect(
waypointsOfLegs([
{ from: A, to: B },
{ from: C, to: A },
]),
).toBeNull();
expect(waypointsOfLegs([])).toBeNull();
expect(waypointsOfLegs('legs')).toBeNull();
});
});
describe('a paddle or ski plan taken', () => {
it('ASTPROP-SPORT-002: a paddle plan is created with its boat, styles, water and the waters it runs on', () => {
const args = {
legs: [
{ from: A, to: B },
{ from: B, to: C },
],
boat: 'canoe',
lake_style: 'shore',
lock_policy: 'use',
};
const result = {
legs: [ok([{ kind: 'water', name: 'Isar' }]), ok([{ kind: 'lake', name: 'Ammersee' }])],
};
expect(sportTakeArgsOf('plan_paddle_route', args, result, 'Paddle tour')).toEqual({
via: 'create_paddle_tour',
name: 'Isar → Ammersee',
waypoints: [A, B, C],
water_context: 'river',
boat_type: 'canoe',
lake_style: 'shore',
lock_policy: 'use',
});
const lake = sportTakeArgsOf(
'plan_paddle_route',
{ legs: [{ from: A, to: B }] },
{ legs: [ok([{ kind: 'lake', name: null }])] },
'Paddeltour',
);
expect(lake).toMatchObject({ name: 'Paddeltour', water_context: 'lake' });
});
it('ASTPROP-SPORT-003: a ski plan is created with its discipline, technique and options, named by its areas', () => {
const args = {
legs: [{ from: A, to: B }],
discipline: 'cross_country',
technique: 'classic',
options: { lit_only: true },
};
expect(sportTakeArgsOf('plan_ski_route', args, { legs: [ok([])], area_names: ['Seefeld'] }, 'Ski')).toEqual({
via: 'create_ski_tour',
name: 'Seefeld',
waypoints: [A, B],
discipline: 'cross_country',
technique: 'classic',
options: { lit_only: true },
});
});
it('ASTPROP-SPORT-004: a plan with a failed leg, or legs that do not join, cannot be taken', () => {
const args = { legs: [{ from: A, to: B }], discipline: 'alpine' };
expect(sportTakeArgsOf('plan_ski_route', args, { legs: [{ status: 'failed' }] }, 'Ski')).toBeNull();
expect(sportTakeArgsOf('plan_ski_route', { ...args, legs: [] }, { legs: [] }, 'Ski')).toBeNull();
expect(isSportPlan('plan_ski_route')).toBe(true);
expect(isSportPlan('propose_hike')).toBe(false);
});
it("ASTPROP-SPORT-005: a tour nothing names is called by its type in the user's language, English for one TREK has none of", async () => {
expect(await tourTypeWord('de-DE', 'plan_paddle_route')).toBe('Paddeltour');
expect(await tourTypeWord('en', 'plan_ski_route')).toBe('Ski & winter');
expect(await tourTypeWord('xx', 'plan_paddle_route')).toBe('Paddle tour');
});
});
describe('a proposed bike tour or run taken', () => {
const card = tourRouteCard({ activity: 'bike', routingProfile: 'road' });
const args = { name: 'Lake', activity: 'bike', bike_profile: 'road', waypoints: [A, B], day_id: 3, along: false };
it('ASTPROP-SPORT-006: is created as create_tour with the arguments it was proposed with, what create_tour takes', () => {
expect(takeArgsOf({ toolName: 'propose_tour', args, result: {}, card })).toEqual({
via: 'create_tour',
name: 'Lake',
activity: 'bike',
bike_profile: 'road',
waypoints: [A, B],
day_id: 3,
});
expect(writeToolOf('take_proposal', { via: 'create_tour' })).toBe('create_tour');
expect(writeToolOf('take_proposal', { via: 'create_paddle_tour' })).toBe('create_paddle_tour');
expect(writeToolOf('take_proposal', { via: 'create_ski_tour' })).toBe('create_ski_tour');
});
it("ASTPROP-SPORT-007: a run without the runner's pace, or a way not planned, cannot be taken", () => {
const run = { ...args, activity: 'run', bike_profile: undefined, run_profile: 'trail' };
expect(takeArgsOf({ toolName: 'propose_tour', args: run, result: {}, card })).toBeNull();
expect(
takeArgsOf({ toolName: 'propose_tour', args: { ...run, run_pace_seconds_per_km: 330 }, result: {}, card }),
).toMatchObject({ via: 'create_tour', run_pace_seconds_per_km: 330 });
expect(takeArgsOf({ toolName: 'propose_tour', args, result: {}, card: { ...card, routed: false } })).toBeNull();
});
});
server/tests/unit/nest/assistant/cards/tour/tour-plan-types.cards.test.ts
+278
View File
@@ -0,0 +1,278 @@
/**
* ASTCARD-TOUR-080 to ASTCARD-TOUR-088
*
* The cards of every tour type besides a hike and a city walk: a proposed
* bike tour or run (propose_tour) with its profile, time and pace, a held
* create_tour drawn as its proposal was, a held create_paddle_tour or
* create_ski_tour drawn as its plan was, the words of each create, the way
* back from each and what the tours tell the model. Every card goes through
* the registry's guarded call, so it also fits the shared card union.
*/
import { buildTripCard } from '../../../../../../src/nest/assistant/assistant-context';
import { systemPrompt } from '../../../../../../src/nest/assistant/assistant.prompt';
import { loadFor } from '../../../../../../src/nest/assistant/cards/card-context';
import type { PreviewContext } from '../../../../../../src/nest/assistant/cards/card-types';
import {
answerCardOf,
ASSISTANT_ARG_POLICY,
ASSISTANT_UNDO_MAP,
ASSISTANT_WRITE_TOOLS,
CARD_PROMPT_LINES,
} from '../../../../../../src/nest/assistant/cards/registry';
import { landSportOf } from '../../../../../../src/nest/assistant/cards/tour/tour-route.cards';
import { legArgsOf } from '../../../../../../src/nest/assistant/cards/tour/tour-sport-change.cards';
import { describeToolCall } from '../../../../../../src/nest/assistant/tool-call-preview.helpers';
import { assistantChangePreviewSchema, trekCardSchema, type TourRouteCard, type TrekCard } from '@trek/shared';
import { beforeEach, describe, expect, it, vi } from 'vitest';
const logMock = vi.hoisted(() => ({ logInfo: vi.fn(), logError: vi.fn(), logWarn: vi.fn(), logDebug: vi.fn() }));
vi.mock('../../../../../../src/nest/audit/audit-log.logger', () => logMock);
beforeEach(() => vi.clearAllMocks());
const card = buildTripCard(
1,
7,
{ trip: { title: 'Bavaria' }, days: [{ id: 31, day_number: 1, date: '2026-06-11', assignments: [] }] },
{ places: [] },
null,
);
const ctx: PreviewContext = { card, categories: new Map(), locale: 'en-GB', today: '2026-06-01', airport: () => null };
const POINTS = [
{ lat: 47.9, lng: 11.1, name: 'Station' },
{ lat: 47.91, lng: 11.1, name: 'Lake' },
];
/** What propose_tour answers for a gravel ride of 1.1 km. */
function proposal(extra: Record<string, unknown> = {}) {
return {
name: 'Lake loop',
variant_label: null,
route: { planned: true },
unreachable: null,
distance_m: 1112,
ascent_m: 10,
descent_m: 0,
duration_minutes: 5,
duration_basis: 'router',
heights_known: true,
min_ele_m: 600,
max_ele_m: 610,
line_geometry: [
[47.9, 11.1, 600],
[47.91, 11.1, 610],
],
sac: null,
high_point: null,
waypoints: [
{ ...POINTS[0], poi_category: null, at_m: 0, snapped_m: 1, minutes: 0, arrival: null, stage_end: false },
{ ...POINTS[1], poi_category: null, at_m: 1112, snapped_m: 1, minutes: 5, arrival: null, stage_end: false },
],
along: null,
activity: 'bike',
bike_profile: 'gravel',
run_profile: null,
run_pace_seconds_per_km: null,
max_hiking_difficulty: null,
hiking_preferences: null,
round_trip: false,
day_id: null,
date: null,
start_time: null,
schedule: null,
warnings: [],
...extra,
};
}
const input = (tool: string, value: unknown, args: Record<string, unknown> = {}) =>
[tool, { toolCallId: 'tc-1', args, value, card, today: '2026-06-01' }] as const;
function route(shown: TrekCard | null | undefined): TourRouteCard {
if (shown?.kind !== 'tourRoute') throw new Error('no route card');
expect(trekCardSchema.safeParse(shown).success).toBe(true);
return shown;
}
/** What plan_paddle_route answers for one leg on the river. */
const PADDLE_PLAN = {
legs: [
{
status: 'ok',
distance_m: 1112,
snapped_m: { from: 1, to: 1 },
points: 2,
segments: [{ kind: 'water', name: 'Isar', source: null, osm_ref: null, from_m: 0, to_m: 1112 }],
line_geometry: [
[48.1, 11.6],
[48.11, 11.6],
],
},
],
graph_rev: 'r1',
};
describe('a proposed bike tour or run', () => {
it('ASTCARD-TOUR-080: a ride names its profile and its riding time, no hiking limit or grade', () => {
const shown = route(answerCardOf(...input('propose_tour', proposal())));
expect(shown).toMatchObject({
source: 'proposal',
activity: 'bike',
routingProfile: 'gravel',
minutes: 5,
minutesBasis: 'router',
limit: null,
grades: null,
routed: true,
});
});
it('ASTCARD-TOUR-081: a run names its profile and pace, its time at that pace; one without a pace has none', () => {
const run = { activity: 'run', bike_profile: null, run_profile: 'trail', run_pace_seconds_per_km: 330 };
const shown = route(answerCardOf(...input('propose_tour', proposal({ ...run, duration_basis: 'pace' }))));
expect(shown).toMatchObject({
activity: 'run',
routingProfile: 'trail',
paceSecondsPerKm: 330,
minutesBasis: 'pace',
});
const unpaced = { ...run, run_pace_seconds_per_km: null, duration_minutes: null, duration_basis: null };
expect(route(answerCardOf(...input('propose_tour', proposal(unpaced))))).toMatchObject({
paceSecondsPerKm: null,
minutes: null,
});
});
it('ASTCARD-TOUR-082: a way that was not planned is drawn straight as the ride it is; a hike names no profile', () => {
const value = proposal({ route: { planned: false, why: 'no_way', position: null } });
expect(route(answerCardOf(...input('propose_tour', value)))).toMatchObject({
activity: 'bike',
routingProfile: 'gravel',
routed: false,
problem: { why: 'no_way' },
});
expect(landSportOf({}, {})).toBeNull();
expect(landSportOf({ activity: 'run' }, { run_profile: 'nonsense' })).toEqual({
activity: 'run',
routingProfile: 'running',
paceSecondsPerKm: null,
});
});
it('ASTCARD-TOUR-083: a saved bike tour or run names its profile on its card', () => {
const saved = {
tour: {
place_id: 9,
name: 'Lake',
tour_type: 'run',
distance: 1.1,
duration: 7,
run_profile: 'trail',
run_pace_seconds_per_km: 360,
},
waypoints: POINTS,
line: { preview: proposal().line_geometry },
};
expect(route(answerCardOf(...input('get_tour_plan', saved)))).toMatchObject({
activity: 'run',
routingProfile: 'trail',
paceSecondsPerKm: 360,
});
});
});
describe('a held new bike tour or run', () => {
const CREATE = { name: 'Lake loop', activity: 'bike', bike_profile: 'gravel', waypoints: POINTS, day_id: 31 };
it('ASTCARD-TOUR-084: reads its proposal again and shows its way, on its day, taken back by deleting it', async () => {
const read = vi.fn(async (tool: string) => (tool === 'propose_tour' ? proposal() : null));
const loaded = await loadFor('create_tour', CREATE, read);
expect(read).toHaveBeenCalledWith('propose_tour', {
along: false,
name: 'Lake loop',
activity: 'bike',
bike_profile: 'gravel',
waypoints: POINTS,
day_id: 31,
});
const preview = describeToolCall('create_tour', 'tc-2', CREATE, ctx, loaded);
expect(assistantChangePreviewSchema.safeParse(preview).success).toBe(true);
expect(preview).toMatchObject({ verbKey: 'addTour', subject: 'Lake loop', dayId: 31, undoable: true });
expect(preview.effect).toMatchObject({ kind: 'add', dayId: 31 });
expect(route(preview.card)).toMatchObject({ source: 'pending', activity: 'bike', routingProfile: 'gravel' });
// Without its plan the points are drawn straight, still as the ride it is.
const straight = route(describeToolCall('create_tour', 'tc-3', CREATE, ctx, null).card);
expect(straight).toMatchObject({ activity: 'bike', routingProfile: 'gravel', routed: false, limit: null });
expect(ASSISTANT_WRITE_TOOLS.create_tour).toEqual({ verbKey: 'addTour', entity: 'tour' });
expect(ASSISTANT_UNDO_MAP.create_tour?.args({}, { tour: { place_id: 9 } }, null)).toEqual({ placeId: 9 });
});
});
describe('a held paddle or ski tour', () => {
const PADDLE = {
name: 'Isar',
waypoints: [
{ lat: 48.1, lng: 11.6 },
{ lat: 48.11, lng: 11.6 },
],
water_context: 'river',
boat_type: 'canoe',
};
it('ASTCARD-TOUR-085: a paddle tour reads its plan again with its legs and boat and shows it waiting', async () => {
const read = vi.fn(async (tool: string) => (tool === 'plan_paddle_route' ? PADDLE_PLAN : null));
const loaded = await loadFor('create_paddle_tour', PADDLE, read);
expect(read).toHaveBeenCalledWith('plan_paddle_route', { legs: legArgsOf(PADDLE), boat: 'canoe' });
const preview = describeToolCall('create_paddle_tour', 'tc-4', PADDLE, ctx, loaded);
expect(assistantChangePreviewSchema.safeParse(preview).success).toBe(true);
expect(preview).toMatchObject({ verbKey: 'addTour', subject: 'Isar', undoable: true });
expect(route(preview.card)).toMatchObject({ source: 'pending', activity: 'kayak', name: 'Isar', routed: true });
expect(ASSISTANT_UNDO_MAP.create_paddle_tour?.tool).toBe('delete_place');
});
it('ASTCARD-TOUR-086: a plan with a failed leg or none at all is drawn straight, planned when the tour is added', async () => {
const failed = { legs: [{ status: 'failed', code: 'not_on_water', at: null }], graph_rev: null };
const drawn = route(describeToolCall('create_paddle_tour', 'tc-5', PADDLE, ctx, { plan: failed }).card);
expect(drawn).toMatchObject({ activity: 'kayak', routed: false, problem: { why: 'not_planned' } });
const SKI = { ...PADDLE, discipline: 'alpine', water_context: undefined, boat_type: undefined };
const read = vi.fn(async () => null);
const loaded = await loadFor('create_ski_tour', SKI, read);
expect(read).toHaveBeenCalledWith('plan_ski_route', { legs: legArgsOf(SKI), discipline: 'alpine' });
expect(route(describeToolCall('create_ski_tour', 'tc-6', SKI, ctx, loaded).card)).toMatchObject({
activity: 'ski',
routed: false,
});
// Too few points draw nothing, and there are no legs to plan.
expect(await loadFor('create_ski_tour', { name: 'X' }, read)).toBeNull();
});
it('ASTCARD-TOUR-087: legs run from each point to the next', () => {
expect(
legArgsOf({
waypoints: [
{ lat: 1, lng: 2 },
{ lat: 3, lng: 4 },
{ lat: 5, lng: 6 },
],
}),
).toEqual([
{ from: { lat: 1, lng: 2 }, to: { lat: 3, lng: 4 } },
{ from: { lat: 3, lng: 4 }, to: { lat: 5, lng: 6 } },
]);
});
});
describe('what the tours tell the model about every type', () => {
it('ASTCARD-TOUR-088: propose_tour draws its line and the prompt names a tool and profile for every type', () => {
expect(ASSISTANT_ARG_POLICY.propose_tour?.forced).toEqual({ include_geometry: true });
const every = CARD_PROMPT_LINES.find((line) => line.startsWith('Every tour type'));
for (const tool of ['propose_tour', 'create_tour', 'create_paddle_tour', 'create_ski_tour', 'plan_ski_route']) {
expect(every).toContain(tool);
}
const profiles = CARD_PROMPT_LINES.find((line) => line.startsWith('Profiles:'));
for (const word of ['road', 'gravel', 'mtb', 'trail', 'run_pace_seconds_per_km']) expect(profiles).toContain(word);
for (const line of CARD_PROMPT_LINES) expect(systemPrompt('English')).toContain(line);
});
});
server/tests/unit/nest/sport-tour-create.helpers.test.ts
+262
View File
@@ -0,0 +1,262 @@
/**
* The pure halves of a bike tour, a run, a paddle or ski tour saved from its
* plan: the profile planned for, the time on the move, the proposal and the
* writes, as the planner's save writes each type.
*/
import type { PlannedHike } from '../../../src/nest/tours/hike-routing.service';
import {
legsOf,
paddleCommandOf,
paddleMarksOf,
skiCommandOf,
skiLineOf,
} from '../../../src/nest/tours/sport-tour-create.helpers';
import {
movingMinutesOf,
plannedActivityOf,
refusesSave,
tourCreateCommandOf,
unplannedTourMessage,
} from '../../../src/nest/tours/tour-plan.helpers';
import type { GeometryPoint, PaddleRouteLeg, SkiRouteLeg } from '@trek/shared';
import { describe, expect, it } from 'vitest';
// SPORT-HELP-001 to SPORT-HELP-008
const routed = (distance: number, minutes: number): PlannedHike => ({
plan: {
kind: 'routed',
max_hiking_difficulty: 2,
hiking_preferences: null,
distance_m: distance,
ascent_m: 0,
descent_m: 0,
duration_minutes: minutes,
duration_basis: 'router',
has_heights: true,
line: [
[47, 11, 500],
[47.01, 11, 500],
],
profile: [],
grades: null,
},
line: null,
snapped: null,
legs: null,
});
describe('tour-plan.helpers', () => {
it("SPORT-HELP-001: a request plans for its profile, the planner's own where none is named", () => {
expect(plannedActivityOf({ activity: 'bike' })).toEqual({ activity: 'bike', profile: 'touring' });
expect(plannedActivityOf({ activity: 'bike', bike_profile: 'mtb' })).toEqual({ activity: 'bike', profile: 'mtb' });
expect(plannedActivityOf({ activity: 'run' })).toEqual({ activity: 'run', profile: 'running' });
expect(plannedActivityOf({ activity: 'run', run_profile: 'trail' })).toEqual({ activity: 'run', profile: 'trail' });
});
it("SPORT-HELP-002: a ride keeps the router's time, a run its distance at the pace, and none without one", () => {
const plan = routed(10_000, 40);
expect(movingMinutesOf({ activity: 'bike', profile: 'road' }, null, plan)).toBe(40);
expect(movingMinutesOf({ activity: 'run', profile: 'running' }, 330, plan)).toBe(55);
expect(movingMinutesOf({ activity: 'run', profile: 'running' }, null, plan)).toBeNull();
const unrouted: PlannedHike = {
plan: { kind: 'unrouted', max_hiking_difficulty: 2, why: 'no_way', position: null, snapped_m: null },
line: null,
snapped: null,
legs: null,
};
expect(movingMinutesOf({ activity: 'bike', profile: 'road' }, null, unrouted)).toBeNull();
});
it('SPORT-HELP-003: the write names the type, its profile and pace, and nothing of a hike', () => {
const line: GeometryPoint[] = [
[47, 11, 500],
[47.01, 11, 510],
];
const points = [
{ lat: 47, lng: 11 },
{ lat: 47.01, lng: 11 },
];
const request = { name: 'Isar', activity: 'run' as const, waypoints: points, run_pace_seconds_per_km: 330 };
const command = tourCreateCommandOf(
request,
points,
{ line, seconds: 600, route: { planned: true } },
{ activity: 'run', profile: 'trail' },
55,
);
expect(command).toMatchObject({
tour_type: 'run',
run_profile: 'trail',
run_pace_seconds_per_km: 330,
bike_profile: null,
max_hiking_difficulty: null,
duration_seconds: 3300,
});
// Without its line the tour waits for its way, and so does its time.
const waiting = tourCreateCommandOf(
request,
points,
{ line: null, seconds: null, route: { planned: false, why: 'router_unavailable', position: null } },
{ activity: 'run', profile: 'trail' },
55,
);
expect(waiting.duration_seconds).toBeNull();
});
it('SPORT-HELP-004: only a router that did not answer saves a tour without its way, in words of its type', () => {
expect(refusesSave({ planned: true })).toBe(false);
expect(refusesSave({ planned: false, why: 'router_unavailable', position: null })).toBe(false);
expect(refusesSave({ planned: false, why: 'no_way', position: null })).toBe(true);
expect(unplannedTourMessage({ why: 'too_long', position: null }, 'run')).toBe(
'The way is too long to plan as a run: split it into shorter tours. Nothing was saved.',
);
expect(unplannedTourMessage({ why: 'point_off_the_way', position: 2 }, 'bike')).toContain('Point 2');
});
});
describe('sport-tour-create.helpers', () => {
const water = (from: number, to: number, kind: 'water' | 'portage' | 'lock') => ({
kind,
from,
to,
name: null,
source: null,
osm_ref: null,
grade: null,
});
it('SPORT-HELP-005: the legs run from each point to the next', () => {
const points = [
{ lat: 1, lng: 1 },
{ lat: 2, lng: 2 },
{ lat: 3, lng: 3 },
];
expect(legsOf(points)).toEqual([
{ from: points[0], to: points[1] },
{ from: points[1], to: points[2] },
]);
});
it('SPORT-HELP-006: portages and locks lie along the whole line, after the legs before them', () => {
const legs: Array<Extract<PaddleRouteLeg, { status: 'ok' }>> = [
{
status: 'ok',
geometry: [
[48, 11],
[48.01, 11],
],
segments: [water(0, 1, 'water')],
distance_m: 1112,
snapped_m: { from: 0, to: 0 },
},
{
status: 'ok',
geometry: [
[48.01, 11],
[48.02, 11],
[48.03, 11],
],
segments: [water(0, 1, 'portage'), water(1, 1, 'lock'), water(1, 2, 'water')],
distance_m: 2224,
snapped_m: { from: 0, to: 0 },
},
];
const marks = paddleMarksOf(legs);
expect(marks.portages).toHaveLength(1);
expect(Math.round(marks.portages[0]?.from_m ?? 0)).toBe(1112);
expect(Math.round(marks.portages[0]?.to_m ?? 0)).toBe(2224);
expect(Math.round(marks.locks[0]?.at_m ?? 0)).toBe(2224);
expect(marks.locks[0]).toMatchObject({ wait_minutes: null, transit_minutes: null });
const line: GeometryPoint[] = [
[48, 11, 500],
[48.01, 11, 500],
[48.02, 11, 500],
[48.03, 11, 500],
];
const request = {
name: 'Isar',
waypoints: [
{ lat: 48, lng: 11 },
{ lat: 48.03, lng: 11 },
],
water_context: 'river' as const,
};
const command = paddleCommandOf(request, [], { line, marks });
// 2224 m on the water at a kayak's 4 km/h, 1112 m carried at 2 km/h and ten minutes to get out and in.
expect(command).toMatchObject({
tour_type: 'kayak',
boat_type: 'kayak',
paddle_speed_kmh: 4,
duration_seconds: 4620,
});
expect(paddleCommandOf(request, [], { line: null, marks }).duration_seconds).toBeNull();
});
it('SPORT-HELP-007: a ski tour is one line with the piste heights and the router time, a missing height kept missing', () => {
const leg = (geometry: Array<[number, number, number | null]>): Extract<SkiRouteLeg, { status: 'ok' }> => ({
status: 'ok',
geometry,
segments: [],
distance_m: 1000,
climb_m: 0,
descent_m: 100,
seconds: { ski: 120, lift: 300, wait: 60, walk: 20 },
snapped_m: { from: 0, to: 0 },
area_ids: [],
why: [],
alternatives: [],
});
const { line, seconds } = skiLineOf([
leg([
[47, 11, 1800],
[47.01, 11, 1700],
]),
leg([
[47.01, 11, 1700],
[47.02, 11, null],
]),
]);
expect(line).toEqual([
[47, 11, 1800],
[47.01, 11, 1700],
[47.02, 11],
]);
expect(seconds).toBe(1000);
});
it('SPORT-HELP-008: the ski write keeps the discipline, its options as the discipline reads them and every leg planned', () => {
const request = {
name: 'Loipe',
waypoints: [
{ lat: 47, lng: 11 },
{ lat: 47.01, lng: 11 },
],
discipline: 'cross_country' as const,
technique: 'skating' as const,
};
const line: GeometryPoint[] = [
[47, 11, 900],
[47.01, 11, 910],
];
const command = skiCommandOf(request, [], { line, marks: null }, { build: 'b1', seconds: 1799.6, legs: 3 });
expect(command).toMatchObject({
tour_type: 'ski',
ski_discipline: 'cross_country',
ski_technique: 'skating',
ski_route_build: 'b1',
ski_planned_legs: [0, 1, 2],
duration_seconds: 1800,
});
expect(command.ski_options).toBeTruthy();
const alpine = skiCommandOf(
{ ...request, discipline: 'alpine', technique: undefined },
[],
{ line: null, marks: null },
{ build: null, seconds: 60, legs: 1 },
);
expect(alpine).toMatchObject({ ski_technique: null, duration_seconds: null });
});
});
server/tests/unit/nest/tour-activity-routing.test.ts
+148
View File
@@ -0,0 +1,148 @@
/**
* HikeRoutingService for a bike tour and a run: the way planned through the
* same router a hike is, with the costing of the tour's profile from
* `@trek/shared` (the one the planner in the browser sends), timed by the
* router and without SAC grades. The router is the real one with its paced
* queue; only the routing host behind safeFetchAdminConfigured is a stub,
* answering /route and /height as Valhalla does.
*/
import { SettingsService } from '../../../src/nest/settings/settings.service';
import {
HikeRoutingService,
type PlannedActivity,
type PlannedHike,
} from '../../../src/nest/tours/hike-routing.service';
import { TourTrailGradeService } from '../../../src/nest/tours/tour-trail-grade.service';
import { ToursModule } from '../../../src/nest/tours/tours.module';
import { safeFetchAdminConfigured } from '../../../src/utils/ssrfGuard';
import { createSnapshotTestDb } from '../../helpers/db-mock';
import { createTestModule, type TestModule } from '../../helpers/test-module';
import { valhallaRoute } from '../../helpers/valhalla';
import { BIKE_COSTING, RUN_COSTING, type RoutedHikePlan } from '@trek/shared';
import { afterAll, afterEach, beforeAll, beforeEach, describe, expect, it, vi } from 'vitest';
vi.mock('../../../src/utils/ssrfGuard', () => ({ safeFetchAdminConfigured: vi.fn() }));
// TOUR-ROUTE-001 to TOUR-ROUTE-004
const db = createSnapshotTestDb();
const grades = vi.fn<TourTrailGradeService['grades']>();
const getUserSettings = vi.fn<(userId: number) => Promise<Record<string, unknown>>>();
let t: TestModule;
let routing: HikeRoutingService;
beforeAll(async () => {
t = await createTestModule({
db,
imports: [ToursModule],
overrides: [
{ provide: TourTrailGradeService, useValue: { grades } },
{ provide: SettingsService, useValue: { getUserSettings } },
],
});
routing = t.get(HikeRoutingService);
});
afterAll(async () => {
await t.close();
db.close();
});
const at = (k: number): [number, number] => [47 + k / 1e4, 11];
const stepsOf = (from: number, to: number) => Array.from({ length: to - from + 1 }, (_, index) => at(from + index));
const WAYPOINTS = [0, 10, 20].map((k) => ({ lat: at(k)[0], lng: 11 }));
const json = (body: unknown, status = 200) => new Response(JSON.stringify(body), { status });
function valhalla() {
vi.mocked(safeFetchAdminConfigured)
.mockReset()
.mockImplementation(async (url, init) => {
const body = JSON.parse(String(init?.body ?? '{}')) as { shape?: Array<{ lat: number; lon: number }> };
if (url.endsWith('/route')) {
return json(
valhallaRoute([
{ line: stepsOf(0, 10), km: 0.111, seconds: 150 },
{ line: stepsOf(10, 20), km: 0.111, seconds: 180 },
]),
);
}
if (url.endsWith('/height')) {
return json({ range_height: (body.shape ?? []).map((point, index) => [index, 600 + index]) });
}
return json({}, 404);
});
}
const asked = (path: string) =>
vi.mocked(safeFetchAdminConfigured).mock.calls.filter(([url]) => String(url).endsWith(path));
const bodyOf = (path: string, index = 0) =>
JSON.parse(String(asked(path)[index]?.[1]?.body)) as Record<string, unknown>;
let trip = 0;
async function plan(activity?: PlannedActivity, sameTrip = false): Promise<PlannedHike> {
if (!sameTrip) trip += 1;
const pending = routing.plan(
trip,
trip,
{ waypoints: WAYPOINTS },
activity ? { grades: false, activity } : undefined,
);
await vi.runAllTimersAsync();
return pending;
}
function routed({ plan: planned }: PlannedHike): RoutedHikePlan {
if (planned.kind !== 'routed') throw new Error(`expected a routed plan, got ${planned.why}`);
return planned;
}
beforeEach(() => {
vi.useFakeTimers();
getUserSettings.mockReset().mockResolvedValue({});
grades.mockReset();
valhalla();
});
afterEach(() => vi.useRealTimers());
describe('HikeRoutingService: a bike tour and a run', () => {
it("TOUR-ROUTE-001: a bike tour asks the bicycle costing of its profile and keeps the router's riding time", async () => {
const planned = routed(await plan({ activity: 'bike', profile: 'gravel' }));
expect(bodyOf('/route')).toMatchObject({
costing: 'bicycle',
costing_options: { bicycle: BIKE_COSTING.gravel },
});
// 330 s by the router for the profile, never the signposts' rule a walker is timed by.
expect(planned).toMatchObject({ duration_minutes: 6, duration_basis: 'router', has_heights: true, grades: null });
expect(asked('/trace_attributes')).toHaveLength(0);
expect(grades).not.toHaveBeenCalled();
});
it('TOUR-ROUTE-002: a run asks the pedestrian costing of its profile, without a hiking limit of its own', async () => {
routed(await plan({ activity: 'run', profile: 'trail' }));
expect(bodyOf('/route')).toMatchObject({
costing: 'pedestrian',
costing_options: { pedestrian: RUN_COSTING.trail },
});
routed(await plan({ activity: 'run', profile: 'running' }));
expect(bodyOf('/route', 1)).toMatchObject({ costing_options: { pedestrian: { use_tracks: 0, use_ferry: 0 } } });
});
it('TOUR-ROUTE-003: a ride, a run and a hike through the same points are each planned on their own', async () => {
await plan();
await plan({ activity: 'bike', profile: 'road' }, true);
await plan({ activity: 'run', profile: 'running' }, true);
await plan({ activity: 'bike', profile: 'road' }, true);
// Three ways asked; the ride asked again comes from the memo.
expect(asked('/route').map((call) => (JSON.parse(String(call[1]?.body)) as { costing: string }).costing)).toEqual([
'pedestrian',
'bicycle',
'pedestrian',
]);
});
it('TOUR-ROUTE-004: where an own OSRM has no Valhalla a bike tour is refused as no_valhalla, never ridden by OSRM', async () => {
getUserSettings.mockResolvedValue({ routing_base_url: 'http://osrm.internal' });
const planned = await plan({ activity: 'bike', profile: 'touring' });
expect(planned.plan.kind === 'unrouted' && planned.plan.why).toBe('no_valhalla');
expect(asked('/route')).toHaveLength(0);
});
});
server/tests/unit/nest/tour-plan.mcp.test.ts
+500
View File
@@ -0,0 +1,500 @@
/**
* TourPlanMcp: every tour type besides a hike and a city walk planned and
* saved over MCP. A bike tour or a run is proposed and created through the
* hike's own plan and save (HikePlanService), a paddle or ski tour from its
* plan through SportTourCreateService, all real here over a snapshot test
* db. The way on land is planned by HikeRoutingService, the legs on the water
* and on the piste data by PaddleRoutingService and SkiRoutingService, and the
* heights by RoadtripRouterService: stubs in this suite. The places along the
* way and the day's weather are stubs too. The suite takes its subject from
* the container and seeds through the ORM factories.
*/
import { DayAssignments } from '../../../src/db/entities/DayAssignments.entity';
import { Places } from '../../../src/db/entities/Places.entity';
import type { McpContext } from '../../../src/nest-mcp';
import { getEntry, type ClassRef } from '../../../src/nest-mcp/metadata';
import { McpToolGuardsService } from '../../../src/nest/mcp-shared/mcp-tool-guards.service';
import { PaddleRoutingService } from '../../../src/nest/paddle-routing/paddle-routing.service';
import { RoadtripRouterService } from '../../../src/nest/roadtrip/roadtrip-router.service';
import { SkiRoutingService } from '../../../src/nest/ski-routing/ski-routing.service';
import { HikeRoutingService, type PlannedHike } from '../../../src/nest/tours/hike-routing.service';
import { TourPlanMcp } from '../../../src/nest/tours/tour-plan.mcp';
import { TourPoiSearchService } from '../../../src/nest/tours/tour-poi-search.service';
import { ToursModule } from '../../../src/nest/tours/tours.module';
import { WeatherService } from '../../../src/nest/weather/weather.service';
import { createSnapshotTestDb } from '../../helpers/db-mock';
import { countRows, findRow } from '../../helpers/factories/rows';
import { makeDay, makeTrip } from '../../helpers/factories/trips';
import { makeUser } from '../../helpers/factories/users';
import { resetTestDb } from '../../helpers/test-db';
import { createTestModule, type TestModule } from '../../helpers/test-module';
import { MikroORM } from '@mikro-orm/core';
import {
tourProposalSchema,
type GeometryPoint,
type PaddleRouteResponse,
type SkiRouteResponse,
type SkiRouteSegment,
} from '@trek/shared';
import { afterAll, beforeAll, beforeEach, describe, expect, it, vi } from 'vitest';
// TOUR-PLAN-MCP-001 to TOUR-PLAN-MCP-012
const db = createSnapshotTestDb();
const plan = vi.fn<HikeRoutingService['plan']>();
const search = vi.fn<TourPoiSearchService['search']>();
const getDetailed = vi.fn<WeatherService['getDetailed']>();
const paddleRoute = vi.fn<PaddleRoutingService['route']>();
const skiRoute = vi.fn<SkiRoutingService['route']>();
const heights = vi.fn<RoadtripRouterService['heights']>();
let t: TestModule;
let mcp: TourPlanMcp;
const orm = () => t.get(MikroORM);
beforeAll(async () => {
t = await createTestModule({
db,
imports: [ToursModule],
overrides: [
{ provide: HikeRoutingService, useValue: { plan } },
{ provide: TourPoiSearchService, useValue: { search } },
{ provide: WeatherService, useValue: { getDetailed } },
{ provide: PaddleRoutingService, useValue: { route: paddleRoute } },
{ provide: SkiRoutingService, useValue: { route: skiRoute } },
],
});
mcp = t.get(TourPlanMcp);
});
beforeEach(() => {
resetTestDb(db);
plan.mockReset().mockResolvedValue(routed());
search.mockReset().mockResolvedValue({ pois: [], truncated: false, partial: false, capped: false, unavailable: [] });
getDetailed.mockReset().mockRejectedValue(new Error('no weather in this suite'));
paddleRoute.mockReset().mockResolvedValue(paddled());
skiRoute.mockReset().mockResolvedValue(skied());
heights
.mockReset()
.mockImplementation(async (_userId, line) => line.map(([lat, lng]): GeometryPoint => [lat, lng, 500]));
vi.spyOn(t.get(RoadtripRouterService), 'heights').mockImplementation(heights);
t.realtime.broadcastMock.mockReset();
});
afterAll(async () => {
await t.close();
db.close();
});
const ctx = (userId: number) => ({ userId }) as McpContext;
function read(result: { content: Array<{ type: string; text: string }>; isError?: boolean }) {
const text = result.content[0]?.text ?? '';
return result.isError ? { error: text } : JSON.parse(text);
}
const LINE: GeometryPoint[] = [
[47.9, 11.1, 600],
[47.905, 11.1, 610],
[47.91, 11.1, 620],
];
/** The stub's plan: a way of 1112 m, 25 minutes by the router, every height read. */
function routed(): PlannedHike {
return {
plan: {
kind: 'routed',
max_hiking_difficulty: 2,
hiking_preferences: null,
distance_m: 1112,
ascent_m: 20,
descent_m: 0,
duration_minutes: 25,
duration_basis: 'router',
has_heights: true,
line: LINE,
profile: [
[0, 600],
[1112, 620],
],
grades: null,
},
line: LINE,
snapped: [3, 4, 5],
legs: [556, 556],
};
}
const WAYPOINTS = [
{ lat: 47.9, lng: 11.1, name: 'Station' },
{ lat: 47.905, lng: 11.1 },
{ lat: 47.91, lng: 11.1, name: 'Lake' },
];
/** Two legs on the water, the second carried round a weir halfway. */
function paddled(): PaddleRouteResponse {
const segment = (kind: 'water' | 'portage', from: number, to: number, name: string | null = 'Isar') => ({
kind,
from,
to,
name,
source: kind === 'portage' ? ('tagged' as const) : null,
osm_ref: null,
grade: null,
});
return {
legs: [
{
status: 'ok',
geometry: [
[48.1, 11.6],
[48.11, 11.6],
],
segments: [segment('water', 0, 1)],
distance_m: 1112,
snapped_m: { from: 2, to: 3 },
},
{
status: 'ok',
geometry: [
[48.11, 11.6],
[48.115, 11.6],
[48.12, 11.6],
],
segments: [segment('water', 0, 1), segment('portage', 1, 2, null)],
distance_m: 1112,
snapped_m: { from: 1, to: 2 },
},
],
graph_rev: 'r1',
};
}
const PADDLE_POINTS = [
{ lat: 48.1, lng: 11.6, name: 'Put-in' },
{ lat: 48.11, lng: 11.6 },
{ lat: 48.12, lng: 11.6, name: 'Take-out' },
];
/** One run down, its heights from the piste data, four minutes skied and a minute at the lift. */
function skied(): SkiRouteResponse {
const segment: SkiRouteSegment = {
kind: 'run',
from: 0,
to: 1,
name: 'Kandahar',
ref: null,
difficulty: 'intermediate',
lift_type: null,
grooming: [],
seconds: 240,
wait_seconds: 0,
length_m: 1112,
flags: [],
osm_way: null,
};
return {
legs: [
{
status: 'ok',
geometry: [
[47.4, 11.0, 1800],
[47.41, 11.0, 1500],
],
segments: [segment],
distance_m: 1112,
climb_m: 0,
descent_m: 300,
seconds: { ski: 240, lift: 0, wait: 60, walk: 0 },
snapped_m: { from: 1, to: 1 },
area_ids: ['a1'],
why: [],
alternatives: [],
},
],
build: 'b7',
stale: false,
area_names: ['Garmisch-Classic'],
colour_scheme: 'europe',
attribution: 'OpenStreetMap',
};
}
async function fixture() {
const { user } = await makeUser(orm());
const { user: outsider } = await makeUser(orm());
const trip = await makeTrip(orm(), user.id);
return { user, outsider, trip };
}
describe('TourPlanMcp: the tools and their gates', () => {
it('TOUR-PLAN-MCP-001: the proposal reads only, the creates write, all on the Tours addon', async () => {
const options = (method: string) => {
const entry = getEntry(TourPlanMcp as unknown as ClassRef, method);
if (!entry || entry.kind !== 'tool') throw new Error(`${method} is no MCP tool`);
return entry.options;
};
const tools = ['proposeTour', 'createTour', 'createPaddleTour', 'createSkiTour'].map(options);
expect(tools.map((tool) => [tool.name, tool.annotations?.readOnlyHint, tool.access])).toEqual([
['propose_tour', true, { group: 'trips', mode: 'read' }],
['create_tour', false, { group: 'trips', mode: 'write' }],
['create_paddle_tour', false, { group: 'trips', mode: 'write' }],
['create_ski_tour', false, { group: 'trips', mode: 'write' }],
]);
// The model is told which tool plans which type, and which profile to pick.
expect(tools[0].description).toContain('propose_hike');
expect(tools[0].description).toContain('gravel');
expect(tools[0].description).toContain('trail');
expect(tools[1].description).toContain('run_pace_seconds_per_km');
expect(tools[2].description).toContain('water_context');
expect(tools[3].description).toContain('discipline');
const isAddonEnabled = vi.fn(async (id: string) => id === 'tours');
const gated = await Promise.all(tools.map((tool) => tool.when?.(ctx(1), { addons: { isAddonEnabled } })));
expect(gated).toEqual([true, true, true, true]);
});
it('TOUR-PLAN-MCP-002: an outsider is refused every tool, the creates without place_edit or, on a day, day_edit', async () => {
const f = await fixture();
const outsider = ctx(f.outsider.id);
const noAccess = { error: 'Trip not found or access denied.' };
const bike = { tripId: f.trip.id, name: 'Lake', activity: 'bike' as const, waypoints: WAYPOINTS };
const paddle = { tripId: f.trip.id, name: 'Isar', waypoints: PADDLE_POINTS, water_context: 'river' as const };
const ski = { tripId: f.trip.id, name: 'Kandahar', waypoints: PADDLE_POINTS, discipline: 'alpine' as const };
expect(read(await mcp.proposeTour(bike, outsider))).toEqual(noAccess);
expect(read(await mcp.createTour(bike, outsider))).toEqual(noAccess);
expect(read(await mcp.createPaddleTour(paddle, outsider))).toEqual(noAccess);
expect(read(await mcp.createSkiTour(ski, outsider))).toEqual(noAccess);
const own = ctx(f.user.id);
const guards = t.get(McpToolGuardsService);
const denied = vi.spyOn(guards, 'hasTripPermission').mockResolvedValue(false);
try {
for (const result of [
await mcp.createTour(bike, own),
await mcp.createPaddleTour(paddle, own),
await mcp.createSkiTour(ski, own),
]) {
expect(result.isError).toBe(true);
}
expect(denied).toHaveBeenCalledWith('place_edit', f.trip.id, f.user.id);
} finally {
denied.mockRestore();
}
const day = await makeDay(orm(), f.trip.id, { day_number: 1, date: '2027-06-01' });
const noDayEdit = vi.spyOn(guards, 'hasTripPermission').mockImplementation(async (action) => action !== 'day_edit');
try {
expect((await mcp.createTour({ ...bike, day_id: day.id }, own)).isError).toBe(true);
expect(noDayEdit).toHaveBeenCalledWith('day_edit', f.trip.id, f.user.id);
} finally {
noDayEdit.mockRestore();
}
expect(await countRows(orm(), Places, { trip: f.trip.id })).toBe(0);
});
});
describe('TourPlanMcp: propose_tour', () => {
it('TOUR-PLAN-MCP-003: a bike tour is planned for its profile and timed by the router, nothing of a hike in it', async () => {
const f = await fixture();
const proposal = read(
await mcp.proposeTour(
{ tripId: f.trip.id, name: 'Lake', activity: 'bike', bike_profile: 'gravel', waypoints: WAYPOINTS },
ctx(f.user.id),
),
);
expect(tourProposalSchema.parse(proposal)).toEqual(proposal);
expect(proposal).toMatchObject({
activity: 'bike',
bike_profile: 'gravel',
run_profile: null,
duration_minutes: 25,
duration_basis: 'router',
max_hiking_difficulty: null,
hiking_preferences: null,
sac: null,
});
// Shared out over the legs by their length: halfway at the middle point.
expect(proposal.waypoints.map((point: { minutes: number | null }) => point.minutes)).toEqual([0, 13, 25]);
expect(plan.mock.calls[0][3]).toEqual({ grades: false, activity: { activity: 'bike', profile: 'gravel' } });
// The places a ride stops for are looked for along it, a bike repair shop among them.
expect(search).toHaveBeenCalledWith(expect.objectContaining({ tour_type: 'bike' }));
expect(search.mock.calls[0][0].categories).toContain('bike_repair');
});
it("TOUR-PLAN-MCP-004: a run is timed at the runner's pace, and has no time without one", async () => {
const f = await fixture();
const base = { tripId: f.trip.id, name: 'Isar', activity: 'run' as const, waypoints: WAYPOINTS, along: false };
const paced = read(await mcp.proposeTour({ ...base, run_pace_seconds_per_km: 360 }, ctx(f.user.id)));
expect(paced).toMatchObject({
run_profile: 'running',
run_pace_seconds_per_km: 360,
duration_minutes: 7,
duration_basis: 'pace',
});
const unpaced = read(await mcp.proposeTour({ ...base, run_profile: 'trail' }, ctx(f.user.id)));
expect(unpaced).toMatchObject({ run_profile: 'trail', duration_minutes: null, duration_basis: null });
expect(unpaced.waypoints.every((point: { minutes: number | null }) => point.minutes === null)).toBe(true);
expect(search).not.toHaveBeenCalled();
});
it('TOUR-PLAN-MCP-005: refuses a profile of the other kind, which the tool shape alone would let through', async () => {
const f = await fixture();
await expect(
mcp.proposeTour(
{ tripId: f.trip.id, name: 'X', activity: 'bike', run_profile: 'trail', waypoints: WAYPOINTS },
ctx(f.user.id),
),
).rejects.toThrow('run_profile belongs to a run');
expect(plan).not.toHaveBeenCalled();
});
});
describe('TourPlanMcp: create_tour', () => {
it('TOUR-PLAN-MCP-006: a bike tour is saved as the planner saves one, its profile and riding time kept', async () => {
const f = await fixture();
const created = read(
await mcp.createTour(
{ tripId: f.trip.id, name: 'Lake', activity: 'bike', bike_profile: 'road', waypoints: WAYPOINTS },
ctx(f.user.id),
),
);
expect(created.route).toEqual({ planned: true });
expect(created.tour).toMatchObject({
tour_type: 'bike',
bike_profile: 'road',
max_hiking_difficulty: null,
duration: 25,
route_pending: false,
});
const place = await findRow(orm(), Places, { id: created.tour.place_id });
expect(JSON.parse(String(place?.route_geometry))).toEqual(LINE);
expect(created.assignment).toBeNull();
});
it('TOUR-PLAN-MCP-007: a run is saved with its pace and the time at that pace, put on its day with its start', async () => {
const f = await fixture();
const day = await makeDay(orm(), f.trip.id, { day_number: 1, date: '2027-06-01' });
const created = read(
await mcp.createTour(
{
tripId: f.trip.id,
name: 'Isar',
activity: 'run',
run_profile: 'trail',
run_pace_seconds_per_km: 360,
waypoints: WAYPOINTS,
day_id: day.id,
start_time: '07:30',
},
ctx(f.user.id),
),
);
expect(created.tour).toMatchObject({
tour_type: 'run',
run_profile: 'trail',
run_pace_seconds_per_km: 360,
duration: 7,
});
expect(created.assignment).toEqual({ id: expect.any(Number), day_id: day.id });
const visit = await findRow(orm(), DayAssignments, { id: created.assignment.id });
expect(visit?.assignment_time).toBe('07:30');
});
it("TOUR-PLAN-MCP-008: refuses a run without the runner's pace and a way no profile joins; nothing is saved", async () => {
const f = await fixture();
await expect(
mcp.createTour({ tripId: f.trip.id, name: 'Isar', activity: 'run', waypoints: WAYPOINTS }, ctx(f.user.id)),
).rejects.toThrow("a run is saved with the runner's pace");
plan.mockResolvedValue({
plan: { kind: 'unrouted', max_hiking_difficulty: 2, why: 'no_way', position: null, snapped_m: null },
line: null,
snapped: null,
legs: null,
});
await expect(
mcp.createTour({ tripId: f.trip.id, name: 'Lake', activity: 'bike', waypoints: WAYPOINTS }, ctx(f.user.id)),
).rejects.toThrow('No way for a bike tour of this profile joins these points');
expect(await countRows(orm(), Places, { trip: f.trip.id })).toBe(0);
});
});
describe('TourPlanMcp: create_paddle_tour', () => {
it('TOUR-PLAN-MCP-009: saves the legs planned again on the water with their heights and the estimate with the portage', async () => {
const f = await fixture();
const created = read(
await mcp.createPaddleTour(
{ tripId: f.trip.id, name: 'Isar', waypoints: PADDLE_POINTS, water_context: 'river', boat_type: 'canoe' },
ctx(f.user.id),
),
);
expect(paddleRoute).toHaveBeenCalledWith(
expect.objectContaining({
boat: 'canoe',
legs: [
{ from: PADDLE_POINTS[0], to: PADDLE_POINTS[1] },
{ from: PADDLE_POINTS[1], to: PADDLE_POINTS[2] },
],
}),
);
expect(created.route).toEqual({ planned: true });
expect(created.tour).toMatchObject({ tour_type: 'kayak', boat_type: 'canoe', water_context: 'river' });
// Water at the canoe's speed, the portage carried at 2 km/h with its ten minutes for getting out and in.
expect(created.tour.duration).toBeGreaterThan(10);
const place = await findRow(orm(), Places, { id: created.tour.place_id });
const line = JSON.parse(String(place?.route_geometry)) as GeometryPoint[];
// The legs joined into one line, the point they share once.
expect(line).toHaveLength(4);
expect(line.every((point) => point[2] === 500)).toBe(true);
});
it('TOUR-PLAN-MCP-010: refuses a leg the water router cannot plan, and waits for its way without heights', async () => {
const f = await fixture();
const request = { tripId: f.trip.id, name: 'Isar', waypoints: PADDLE_POINTS, water_context: 'lake' as const };
paddleRoute.mockResolvedValueOnce({
legs: [paddled().legs[0], { status: 'failed', code: 'not_on_water', at: null }],
graph_rev: null,
});
await expect(mcp.createPaddleTour(request, ctx(f.user.id))).rejects.toThrow(
'Leg 2 could not be planned on the water (not_on_water)',
);
expect(await countRows(orm(), Places, { trip: f.trip.id })).toBe(0);
heights.mockRejectedValueOnce(new Error('height host down'));
const waiting = read(await mcp.createPaddleTour(request, ctx(f.user.id)));
expect(waiting.route).toEqual({ planned: false, why: 'router_unavailable', position: null });
expect(waiting.tour.route_pending).toBe(true);
});
});
describe('TourPlanMcp: create_ski_tour', () => {
it('TOUR-PLAN-MCP-011: saves the legs planned again on the piste data with its heights, its time, build and options', async () => {
const f = await fixture();
const points = PADDLE_POINTS.slice(0, 2);
const created = read(
await mcp.createSkiTour(
{ tripId: f.trip.id, name: 'Kandahar', waypoints: points, discipline: 'alpine' },
ctx(f.user.id),
),
);
expect(created.tour).toMatchObject({ tour_type: 'ski', ski_discipline: 'alpine', duration: 5 });
// The piste data had a height for every point: Valhalla is not asked.
expect(heights).not.toHaveBeenCalled();
const place = await findRow(orm(), Places, { id: created.tour.place_id });
expect(JSON.parse(String(place?.route_geometry))).toEqual([
[47.4, 11.0, 1800],
[47.41, 11.0, 1500],
]);
});
it('TOUR-PLAN-MCP-012: refuses a cross-country tour without its technique and a leg the piste router cannot plan', async () => {
const f = await fixture();
const base = { tripId: f.trip.id, name: 'Loipe', waypoints: PADDLE_POINTS.slice(0, 2) };
await expect(mcp.createSkiTour({ ...base, discipline: 'cross_country' }, ctx(f.user.id))).rejects.toThrow(
'a cross-country tour needs a technique',
);
skiRoute.mockResolvedValueOnce({
...skied(),
legs: [{ status: 'failed', code: 'loading', at: null, hint: null, detail: null }],
});
await expect(mcp.createSkiTour({ ...base, discipline: 'alpine' }, ctx(f.user.id))).rejects.toThrow(
'Leg 1 could not be planned on the piste data (loading)',
);
expect(await countRows(orm(), Places, { trip: f.trip.id })).toBe(0);
});
});
shared/src/assistant/cards/tour-route.card.spec.ts
+18
View File
@@ -157,6 +157,24 @@ describe('tourRouteCardSchema', () => {
});
});
describe('tourRouteCardSchema: bike tours and runs', () => {
it('TOURCARD-008: a bike tour or a run names its profile, a run its pace; a card drawn before reads without both', () => {
const bike = hike({
activity: 'bike',
routingProfile: 'gravel',
minutesBasis: 'router',
limit: null,
grades: null,
});
expect(tourRouteCardSchema.parse(bike).routingProfile).toBe('gravel');
const run = hike({ activity: 'run', routingProfile: 'trail', minutesBasis: 'pace', paceSecondsPerKm: 330 });
expect(tourRouteCardSchema.parse(run).paceSecondsPerKm).toBe(330);
expect(tourRouteCardSchema.parse(hike()).routingProfile).toBeUndefined();
expect(tourRouteCardSchema.safeParse(hike({ routingProfile: 'tandem' as never })).success).toBe(false);
expect(tourRouteCardSchema.safeParse(hike({ paceSecondsPerKm: 5 })).success).toBe(false);
});
});
describe('tourListCardSchema', () => {
const row = {
placeId: 61,
shared/src/assistant/cards/tour-route.card.ts
+18 -2
View File
@@ -3,7 +3,12 @@ import { skiColourSchemeSchema, skiRunDifficultySchema, skiSegmentKindSchema } f
import { HIKE_UNROUTED_REASONS } from '../../tours/hike-plan.schema';
import { HIKE_WARNING_KINDS } from '../../tours/hike-schedule';
import { tourPoiCategorySchema } from '../../tours/tour-poi-category';
import { tourMaxHikingDifficultySchema, tourTypeKeySchema } from '../../tours/tours.schema';
import {
BIKE_PROFILES,
RUN_PROFILES,
tourMaxHikingDifficultySchema,
tourTypeKeySchema,
} from '../../tours/tours.schema';
import { cardClockSchema, cardDateSchema, cardLatSchema, cardLngSchema, cardPointSchema, cardText } from './card-parts';
import { z } from 'zod';
@@ -95,6 +100,9 @@ export const TOUR_WARNING_KINDS = [...HIKE_WARNING_KINDS, 'legs_failed'] as cons
*/
export const TOUR_ROUTE_PROBLEMS = [...HIKE_UNROUTED_REASONS, 'ferry_only', 'not_planned'] as const;
/** The profile a bike tour or a run is planned for, as the Tours tab names it. */
export const TOUR_ROUTE_PROFILES = [...BIKE_PROFILES, ...RUN_PROFILES] as const;
export const tourRouteScheduleSchema = z.object({
date: cardDateSchema,
dayId: idSchema.nullable(),
@@ -136,7 +144,15 @@ export const tourRouteCardSchema = z.object({
minEleM: height.nullable(),
maxEleM: height.nullable(),
minutes: minutes.nullable(),
minutesBasis: z.enum(['din33466', 'router', 'planned', 'stations', 'piste']).nullable(),
/** pace: a run's distance at the runner's pace. */
minutesBasis: z.enum(['din33466', 'router', 'planned', 'stations', 'piste', 'pace']).nullable(),
/**
* A bike tour's or a run's profile (road, gravel, trail ...); null for every
* other activity. Left out by a card drawn before it was sent.
*/
routingProfile: z.enum(TOUR_ROUTE_PROFILES).nullable().optional(),
/** A run's pace in seconds per kilometre; null without one. Left out like the profile. */
paceSecondsPerKm: z.number().int().min(60).max(3_600).nullable().optional(),
/** The hiking limit the way was planned under, a setting rather than a grade of the path. */
limit: tourMaxHikingDifficultySchema.nullable(),
grades: z.object({ highest: sacStep.nullable(), unknownShare: z.number().min(0).max(1) }).nullable(),
shared/src/i18n/ar/assistantTour.ts
+1
View File
@@ -15,6 +15,7 @@ const assistantTour: TranslationStrings = {
'assistant.card.tour.adding': 'جارٍ التخطيط…',
'assistant.card.tour.added': 'أُضيفت إلى الرحلة',
'assistant.card.tour.askAgain': 'لم يعد بالإمكان التخطيط لهذا من هنا. اطلبه مرة أخرى.',
'assistant.card.tour.needsPace': 'أخبر المساعد بوتيرتك لحفظ هذا الجري.',
'assistant.card.tour.open': 'فتح في الجولات',
'assistant.card.tour.openPhone': 'فتح الجولة',
'assistant.card.tour.unsaved': 'احفظ الجولة التي تعدّلها أو تجاهلها أولًا',
shared/src/i18n/az/assistantTour.ts
+1
View File
@@ -15,6 +15,7 @@ const assistantTour: TranslationStrings = {
'assistant.card.tour.adding': 'Planlaşdırılır…',
'assistant.card.tour.added': 'Səyahətə əlavə edildi',
'assistant.card.tour.askAgain': 'Bunu artıq buradan planlaşdırmaq olmur. Yenidən soruşun.',
'assistant.card.tour.needsPace': 'Bu qaçışı yadda saxlamaq üçün köməkçiyə tempinizi deyin.',
'assistant.card.tour.open': 'Turlarda aç',
'assistant.card.tour.openPhone': 'Turu aç',
'assistant.card.tour.unsaved': 'Əvvəlcə redaktə etdiyiniz turu yadda saxlayın və ya ləğv edin',
shared/src/i18n/br/assistantTour.ts
+1
View File
@@ -15,6 +15,7 @@ const assistantTour: TranslationStrings = {
'assistant.card.tour.adding': 'Planejando…',
'assistant.card.tour.added': 'Adicionado à viagem',
'assistant.card.tour.askAgain': 'Isso não pode mais ser planejado daqui. Peça de novo.',
'assistant.card.tour.needsPace': 'Diga ao assistente o seu ritmo para salvar esta corrida.',
'assistant.card.tour.open': 'Abrir em Passeios',
'assistant.card.tour.openPhone': 'Abrir passeio',
'assistant.card.tour.unsaved': 'Salve ou descarte primeiro o passeio que você está editando',
shared/src/i18n/ca/assistantTour.ts
+1
View File
@@ -15,6 +15,7 @@ const assistantTour: TranslationStrings = {
'assistant.card.tour.adding': "S'està planificant…",
'assistant.card.tour.added': 'Afegit al viatge',
'assistant.card.tour.askAgain': 'Això ja no es pot planificar des d’aquí. Torna-ho a demanar.',
'assistant.card.tour.needsPace': 'Digues el teu ritme a l’assistent per desar aquesta cursa.',
'assistant.card.tour.open': 'Obre a Excursions',
'assistant.card.tour.openPhone': 'Obre l’excursió',
'assistant.card.tour.unsaved': 'Primer desa o descarta l’excursió que estàs editant',
shared/src/i18n/cs/assistantTour.ts
+1
View File
@@ -15,6 +15,7 @@ const assistantTour: TranslationStrings = {
'assistant.card.tour.adding': 'Plánuje se…',
'assistant.card.tour.added': 'Přidáno do cesty',
'assistant.card.tour.askAgain': 'Odsud to už naplánovat nejde. Zeptej se na to znovu.',
'assistant.card.tour.needsPace': 'Řekni asistentovi své tempo, aby se tento běh mohl uložit.',
'assistant.card.tour.open': 'Otevřít ve Výletech',
'assistant.card.tour.openPhone': 'Otevřít výlet',
'assistant.card.tour.unsaved': 'Nejprve uložte nebo zahoďte výlet, který upravujete',
shared/src/i18n/de/assistantTour.ts
+1
View File
@@ -15,6 +15,7 @@ const assistantTour: TranslationStrings = {
'assistant.card.tour.adding': 'Wird eingeplant…',
'assistant.card.tour.added': 'Zur Reise hinzugefügt',
'assistant.card.tour.askAgain': 'Das lässt sich hier nicht mehr einplanen. Frag einfach noch einmal danach.',
'assistant.card.tour.needsPace': 'Nenn dem Assistenten dein Tempo, um diesen Lauf zu speichern.',
'assistant.card.tour.open': 'In Touren öffnen',
'assistant.card.tour.openPhone': 'Tour öffnen',
'assistant.card.tour.unsaved': 'Speichere oder verwirf zuerst die Tour, die du gerade bearbeitest',
shared/src/i18n/en/assistantTour.ts
+1
View File
@@ -15,6 +15,7 @@ const assistantTour: TranslationStrings = {
'assistant.card.tour.adding': 'Planning it…',
'assistant.card.tour.added': 'Added to the trip',
'assistant.card.tour.askAgain': 'This can no longer be planned from here. Ask for it again.',
'assistant.card.tour.needsPace': 'Tell the assistant your pace to save this run.',
'assistant.card.tour.open': 'Open in Tours',
'assistant.card.tour.openPhone': 'Open tour',
'assistant.card.tour.unsaved': 'Save or discard the tour you are editing first',
shared/src/i18n/es/assistantTour.ts
+1
View File
@@ -15,6 +15,7 @@ const assistantTour: TranslationStrings = {
'assistant.card.tour.adding': 'Planificando…',
'assistant.card.tour.added': 'Añadido al viaje',
'assistant.card.tour.askAgain': 'Esto ya no se puede planificar desde aquí. Vuelve a pedirlo.',
'assistant.card.tour.needsPace': 'Dile al asistente tu ritmo para guardar esta carrera.',
'assistant.card.tour.open': 'Abrir en Excursiones',
'assistant.card.tour.openPhone': 'Abrir excursión',
'assistant.card.tour.unsaved': 'Primero guarda o descarta la excursión que estás editando',
shared/src/i18n/et/assistantTour.ts
+1
View File
@@ -15,6 +15,7 @@ const assistantTour: TranslationStrings = {
'assistant.card.tour.adding': 'Planeerin…',
'assistant.card.tour.added': 'Reisile lisatud',
'assistant.card.tour.askAgain': 'Seda ei saa siit enam planeerida. Küsi seda uuesti.',
'assistant.card.tour.needsPace': 'Ütle assistendile oma tempo, et see jooks salvestada.',
'assistant.card.tour.open': 'Ava retkedes',
'assistant.card.tour.openPhone': 'Ava retk',
'assistant.card.tour.unsaved': 'Salvesta või loobu kõigepealt retkest, mida muudad',
shared/src/i18n/fr/assistantTour.ts
+1
View File
@@ -15,6 +15,7 @@ const assistantTour: TranslationStrings = {
'assistant.card.tour.adding': 'Planification…',
'assistant.card.tour.added': 'Ajouté au voyage',
'assistant.card.tour.askAgain': "Ceci ne peut plus être planifié d'ici. Redemandez-le.",
'assistant.card.tour.needsPace': 'Indique ton allure à l’assistant pour enregistrer cette course.',
'assistant.card.tour.open': 'Ouvrir dans Sorties',
'assistant.card.tour.openPhone': 'Ouvrir la sortie',
'assistant.card.tour.unsaved': 'Enregistrez ou abandonnez d’abord la sortie en cours de modification',
shared/src/i18n/gr/assistantTour.ts
+1
View File
@@ -15,6 +15,7 @@ const assistantTour: TranslationStrings = {
'assistant.card.tour.adding': 'Προγραμματίζεται…',
'assistant.card.tour.added': 'Προστέθηκε στο ταξίδι',
'assistant.card.tour.askAgain': 'Αυτό δεν μπορεί πια να προγραμματιστεί από εδώ. Ζήτησέ το ξανά.',
'assistant.card.tour.needsPace': 'Πες στον βοηθό τον ρυθμό σου για να αποθηκευτεί αυτό το τρέξιμο.',
'assistant.card.tour.open': 'Άνοιγμα στις Εκδρομές',
'assistant.card.tour.openPhone': 'Άνοιγμα εκδρομής',
'assistant.card.tour.unsaved': 'Αποθηκεύστε ή απορρίψτε πρώτα την εκδρομή που επεξεργάζεστε',
shared/src/i18n/hu/assistantTour.ts
+1
View File
@@ -15,6 +15,7 @@ const assistantTour: TranslationStrings = {
'assistant.card.tour.adding': 'Tervezés…',
'assistant.card.tour.added': 'Hozzáadva az utazáshoz',
'assistant.card.tour.askAgain': 'Ezt innen már nem lehet megtervezni. Kérd újra.',
'assistant.card.tour.needsPace': 'Mondd meg az asszisztensnek a tempódat, hogy menthető legyen ez a futás.',
'assistant.card.tour.open': 'Megnyitás a Túrákban',
'assistant.card.tour.openPhone': 'Túra megnyitása',
'assistant.card.tour.unsaved': 'Előbb mentsd el vagy vesd el a szerkesztett túrát',
shared/src/i18n/id/assistantTour.ts
+1
View File
@@ -15,6 +15,7 @@ const assistantTour: TranslationStrings = {
'assistant.card.tour.adding': 'Sedang direncanakan…',
'assistant.card.tour.added': 'Ditambahkan ke perjalanan',
'assistant.card.tour.askAgain': 'Ini tidak bisa lagi direncanakan dari sini. Minta lagi.',
'assistant.card.tour.needsPace': 'Beri tahu asisten kecepatanmu untuk menyimpan lari ini.',
'assistant.card.tour.open': 'Buka di Tur',
'assistant.card.tour.openPhone': 'Buka tur',
'assistant.card.tour.unsaved': 'Simpan atau buang dulu tur yang sedang kamu edit',
shared/src/i18n/it/assistantTour.ts
+1
View File
@@ -15,6 +15,7 @@ const assistantTour: TranslationStrings = {
'assistant.card.tour.adding': 'Pianificazione…',
'assistant.card.tour.added': 'Aggiunto al viaggio',
'assistant.card.tour.askAgain': 'Non si può più pianificare da qui. Chiedilo di nuovo.',
'assistant.card.tour.needsPace': 'Di’ all’assistente il tuo passo per salvare questa corsa.',
'assistant.card.tour.open': 'Apri in Escursioni',
'assistant.card.tour.openPhone': 'Apri escursione',
'assistant.card.tour.unsaved': 'Prima salva o scarta l’escursione che stai modificando',
shared/src/i18n/ja/assistantTour.ts
+1
View File
@@ -15,6 +15,7 @@ const assistantTour: TranslationStrings = {
'assistant.card.tour.adding': '計画中…',
'assistant.card.tour.added': '旅行に追加しました',
'assistant.card.tour.askAgain': 'ここからはもう計画できません。もう一度頼んでください。',
'assistant.card.tour.needsPace': 'このランを保存するには、アシスタントにペースを伝えてください。',
'assistant.card.tour.open': 'ツアーで開く',
'assistant.card.tour.openPhone': 'ツアーを開く',
'assistant.card.tour.unsaved': '編集中のツアーを先に保存するか破棄してください',
shared/src/i18n/ko/assistantTour.ts
+1
View File
@@ -15,6 +15,7 @@ const assistantTour: TranslationStrings = {
'assistant.card.tour.adding': '계획하는 중…',
'assistant.card.tour.added': '여행에 추가했어요',
'assistant.card.tour.askAgain': '여기서는 더 이상 계획할 수 없어요. 다시 요청해 주세요.',
'assistant.card.tour.needsPace': '이 달리기를 저장하려면 어시스턴트에게 페이스를 알려 주세요.',
'assistant.card.tour.open': '투어에서 열기',
'assistant.card.tour.openPhone': '투어 열기',
'assistant.card.tour.unsaved': '편집 중인 투어를 먼저 저장하거나 취소하세요',
shared/src/i18n/nl/assistantTour.ts
+1
View File
@@ -15,6 +15,7 @@ const assistantTour: TranslationStrings = {
'assistant.card.tour.adding': 'Wordt ingepland…',
'assistant.card.tour.added': 'Toegevoegd aan de reis',
'assistant.card.tour.askAgain': 'Dit kan hier niet meer worden ingepland. Vraag er opnieuw om.',
'assistant.card.tour.needsPace': 'Geef de assistent je tempo om deze run op te slaan.',
'assistant.card.tour.open': 'Openen in Tochten',
'assistant.card.tour.openPhone': 'Tocht openen',
'assistant.card.tour.unsaved': 'Sla eerst de tocht op die je bewerkt, of gooi hem weg',
shared/src/i18n/pl/assistantTour.ts
+1
View File
@@ -15,6 +15,7 @@ const assistantTour: TranslationStrings = {
'assistant.card.tour.adding': 'Planowanie…',
'assistant.card.tour.added': 'Dodano do podróży',
'assistant.card.tour.askAgain': 'Tego nie da się już stąd zaplanować. Poproś o to jeszcze raz.',
'assistant.card.tour.needsPace': 'Podaj asystentowi swoje tempo, aby zapisać ten bieg.',
'assistant.card.tour.open': 'Otwórz w Wycieczkach',
'assistant.card.tour.openPhone': 'Otwórz wycieczkę',
'assistant.card.tour.unsaved': 'Najpierw zapisz lub odrzuć edytowaną wycieczkę',
shared/src/i18n/ru/assistantTour.ts
+1
View File
@@ -15,6 +15,7 @@ const assistantTour: TranslationStrings = {
'assistant.card.tour.adding': 'Планируется…',
'assistant.card.tour.added': 'Добавлено в поездку',
'assistant.card.tour.askAgain': 'Отсюда это уже не запланировать. Спросите ещё раз.',
'assistant.card.tour.needsPace': 'Сообщите ассистенту свой темп, чтобы сохранить эту пробежку.',
'assistant.card.tour.open': 'Открыть в Турах',
'assistant.card.tour.openPhone': 'Открыть тур',
'assistant.card.tour.unsaved': 'Сначала сохраните или отмените тур, который вы редактируете',
shared/src/i18n/sk/assistantTour.ts
+1
View File
@@ -15,6 +15,7 @@ const assistantTour: TranslationStrings = {
'assistant.card.tour.adding': 'Plánuje sa…',
'assistant.card.tour.added': 'Pridané do cesty',
'assistant.card.tour.askAgain': 'Odtiaľto sa to už naplánovať nedá. Opýtaj sa na to znova.',
'assistant.card.tour.needsPace': 'Povedz asistentovi svoje tempo, aby sa tento beh mohol uložiť.',
'assistant.card.tour.open': 'Otvoriť v Túrach',
'assistant.card.tour.openPhone': 'Otvoriť túru',
'assistant.card.tour.unsaved': 'Najprv uložte alebo zahoďte túru, ktorú upravujete',
shared/src/i18n/sv/assistantTour.ts
+1
View File
@@ -15,6 +15,7 @@ const assistantTour: TranslationStrings = {
'assistant.card.tour.adding': 'Planeras…',
'assistant.card.tour.added': 'Tillagd i resan',
'assistant.card.tour.askAgain': 'Det här kan inte längre planeras härifrån. Fråga efter det igen.',
'assistant.card.tour.needsPace': 'Berätta din takt för assistenten för att spara den här löprundan.',
'assistant.card.tour.open': 'Öppna i Turer',
'assistant.card.tour.openPhone': 'Öppna tur',
'assistant.card.tour.unsaved': 'Spara eller släng först turen du redigerar',
shared/src/i18n/th/assistantTour.ts
+1
View File
@@ -15,6 +15,7 @@ const assistantTour: TranslationStrings = {
'assistant.card.tour.adding': 'กำลังวางแผน…',
'assistant.card.tour.added': 'เพิ่มในทริปแล้ว',
'assistant.card.tour.askAgain': 'วางแผนจากตรงนี้ไม่ได้แล้ว โปรดขอใหม่อีกครั้ง',
'assistant.card.tour.needsPace': 'บอกเพซของคุณให้ผู้ช่วยทราบเพื่อบันทึกการวิ่งนี้',
'assistant.card.tour.open': 'เปิดในทัวร์',
'assistant.card.tour.openPhone': 'เปิดทัวร์',
'assistant.card.tour.unsaved': 'บันทึกหรือยกเลิกทัวร์ที่คุณกำลังแก้ไขก่อน',
shared/src/i18n/tr/assistantTour.ts
+1
View File
@@ -15,6 +15,7 @@ const assistantTour: TranslationStrings = {
'assistant.card.tour.adding': 'Planlanıyor…',
'assistant.card.tour.added': 'Geziye eklendi',
'assistant.card.tour.askAgain': 'Bu artık buradan planlanamıyor. Yeniden iste.',
'assistant.card.tour.needsPace': 'Bu koşuyu kaydetmek için asistana temponu söyle.',
'assistant.card.tour.open': 'Turlar sekmesinde aç',
'assistant.card.tour.openPhone': 'Turu aç',
'assistant.card.tour.unsaved': 'Önce düzenlediğiniz turu kaydedin ya da vazgeçin',
shared/src/i18n/uk/assistantTour.ts
+1
View File
@@ -15,6 +15,7 @@ const assistantTour: TranslationStrings = {
'assistant.card.tour.adding': 'Плануємо…',
'assistant.card.tour.added': 'Додано до подорожі',
'assistant.card.tour.askAgain': 'Звідси це вже не запланувати. Запитайте ще раз.',
'assistant.card.tour.needsPace': 'Скажіть асистенту свій темп, щоб зберегти цю пробіжку.',
'assistant.card.tour.open': 'Відкрити в Турах',
'assistant.card.tour.openPhone': 'Відкрити тур',
'assistant.card.tour.unsaved': 'Спершу збережіть або скасуйте тур, який ви редагуєте',
shared/src/i18n/vi/assistantTour.ts
+1
View File
@@ -15,6 +15,7 @@ const assistantTour: TranslationStrings = {
'assistant.card.tour.adding': 'Đang lên kế hoạch…',
'assistant.card.tour.added': 'Đã thêm vào chuyến đi',
'assistant.card.tour.askAgain': 'Không thể lên kế hoạch từ đây nữa. Hãy hỏi lại.',
'assistant.card.tour.needsPace': 'Hãy cho trợ lý biết tốc độ của bạn để lưu buổi chạy này.',
'assistant.card.tour.open': 'Mở trong Chuyến tham quan',
'assistant.card.tour.openPhone': 'Mở chuyến đi',
'assistant.card.tour.unsaved': 'Hãy lưu hoặc bỏ chuyến đi bạn đang chỉnh sửa trước',
shared/src/i18n/zh-TW/assistantTour.ts
+1
View File
@@ -15,6 +15,7 @@ const assistantTour: TranslationStrings = {
'assistant.card.tour.adding': '正在安排…',
'assistant.card.tour.added': '已加入旅程',
'assistant.card.tour.askAgain': '這裡已無法再加入計畫，請重新詢問。',
'assistant.card.tour.needsPace': '告訴助理你的配速即可儲存這次跑步。',
'assistant.card.tour.open': '在遊程中開啟',
'assistant.card.tour.openPhone': '開啟路線',
'assistant.card.tour.unsaved': '請先儲存或捨棄正在編輯的路線',
shared/src/i18n/zh/assistantTour.ts
+1
View File
@@ -15,6 +15,7 @@ const assistantTour: TranslationStrings = {
'assistant.card.tour.adding': '正在安排…',
'assistant.card.tour.added': '已加入行程',
'assistant.card.tour.askAgain': '这里已无法再加入计划，请重新询问。',
'assistant.card.tour.needsPace': '告诉助手你的配速即可保存这次跑步。',
'assistant.card.tour.open': '在游览中打开',
'assistant.card.tour.openPhone': '打开路线',
'assistant.card.tour.unsaved': '请先保存或放弃正在编辑的路线',
shared/src/index.ts
+3
View File
@@ -84,6 +84,9 @@ export * from './tours/walk-remaining';
export * from './tours/walk-ferry';
export * from './tours/tours.metrics';
export * from './tours/hiking-costing';
export * from './tours/tour-costing';
export * from './tours/tour-plan.schema';
export * from './tours/sport-tour-create.schema';
export * from './tours/hike-plan.schema';
export * from './tours/tour-hike.schema';
export * from './tours/tour-display.schema';
shared/src/tours/sport-tour-create.schema.spec.ts
+38
View File
@@ -0,0 +1,38 @@
import { paddleTourCreateRequestSchema, skiTourCreateRequestSchema } from './sport-tour-create.schema';
import { describe, expect, it } from 'vitest';
const POINTS = [
{ lat: 48.1, lng: 11.6, name: 'Put-in' },
{ lat: 48.15, lng: 11.62 },
];
describe('paddleTourCreateRequestSchema', () => {
it('SPORT-CREATE-001: a paddle tour names its water; the boat, styles and speeds may be left out', () => {
expect(
paddleTourCreateRequestSchema.safeParse({ name: 'Isar', waypoints: POINTS, water_context: 'river' }).success,
).toBe(true);
expect(paddleTourCreateRequestSchema.safeParse({ name: 'Isar', waypoints: POINTS }).success).toBe(false);
expect(
paddleTourCreateRequestSchema.safeParse({ name: 'Isar', waypoints: POINTS, water_context: 'sea' }).success,
).toBe(false);
expect(
paddleTourCreateRequestSchema.safeParse({ name: 'Isar', waypoints: [POINTS[0]], water_context: 'lake' }).success,
).toBe(false);
});
});
describe('skiTourCreateRequestSchema', () => {
it('SPORT-CREATE-002: a cross-country tour needs its technique, no other discipline takes one', () => {
const base = { name: 'Loipe', waypoints: POINTS };
expect(skiTourCreateRequestSchema.safeParse({ ...base, discipline: 'alpine' }).success).toBe(true);
const missing = skiTourCreateRequestSchema.safeParse({ ...base, discipline: 'cross_country' });
expect(missing.error?.issues[0]?.path).toEqual(['technique']);
expect(
skiTourCreateRequestSchema.safeParse({ ...base, discipline: 'cross_country', technique: 'skating' }).success,
).toBe(true);
expect(skiTourCreateRequestSchema.safeParse({ ...base, discipline: 'alpine', technique: 'classic' }).success).toBe(
false,
);
});
});
shared/src/tours/sport-tour-create.schema.ts
+101
View File
@@ -0,0 +1,101 @@
import { MAX_PADDLE_ROUTE_LEGS, paddleLockPolicySchema } from '../paddle/paddle-route.schema';
import { MAX_SKI_ROUTE_LEGS } from '../ski/ski-route.schema';
import { portageSpeedKmhSchema } from './paddle-plan.schema';
import { skiDisciplineSchema, skiIssues, skiRouteOptionsSchema, skiTechniqueSchema } from './ski.schema';
import { hikeDayIdSchema, hikeStartTimeSchema, plannedMinutesSchema } from './tour-hike.schema';
import {
paddleBoatTypeSchema,
paddleLakeStyleSchema,
paddleSpeedKmhSchema,
paddleWaterContextSchema,
tourDescriptionSchema,
tourNameSchema,
tourWaypointSchema,
} from './tours.schema';
import { z } from 'zod';
/**
* A paddle tour or a ski tour the assistant planned with plan_paddle_route
* or plan_ski_route, saved once the traveller said yes. The legs run from
* each point to the next; the server plans them again with the same router
* (both are deterministic over the same data), joins them into one line with
* its heights and saves the tour the way the planner's save does. A leg that
* cannot be planned refuses the tour; nothing is saved. Nothing here carries
* a line from the caller.
*/
const { lat, lng, name } = tourWaypointSchema.shape;
const sportPointSchema = z
.object({ lat, lng, name: name.describe('What the point is, such as a put-in, a lift station or a hut') })
.strict();
export type SportTourPoint = z.infer<typeof sportPointSchema>;
const dayFields = {
planned_duration_minutes: plannedMinutesSchema.optional(),
day_id: hikeDayIdSchema.optional().describe('The day of the trip the tour is put on, as list_days gives it'),
start_time: hikeStartTimeSchema
.optional()
.describe('When the tour starts on that day, HH:MM, kept as the start of its visit; only with day_id'),
};
export const paddleTourCreateRequestSchema = z
.object({
name: tourNameSchema.describe('What the paddle tour is called'),
description: tourDescriptionSchema.describe('A few words about the tour for the travellers, up to 2000 characters'),
waypoints: z
.array(sportPointSchema)
.min(2)
.max(MAX_PADDLE_ROUTE_LEGS + 1)
.describe(
'The points on the water in order: the put-in, the points on the way and the take-out; each leg runs from one to the next, as plan_paddle_route planned them',
),
boat_type: paddleBoatTypeSchema.optional().describe('The boat: kayak (the default), canoe, sup or other'),
water_context: paddleWaterContextSchema.describe('The water the tour is on: river or lake'),
lake_style: paddleLakeStyleSchema
.optional()
.describe('direct crosses lakes straight (the default), shore keeps near the shore'),
lock_policy: paddleLockPolicySchema
.optional()
.describe('auto (whichever is quicker, the default), use the locks, or portage round them'),
paddle_speed_kmh: paddleSpeedKmhSchema
.optional()
.describe("The paddling speed in km/h the time is reckoned with; the boat's starting value when left out"),
portage_speed_kmh: portageSpeedKmhSchema
.optional()
.describe('The carrying speed on a portage in km/h; 2 when left out'),
...dayFields,
})
.strict();
export type PaddleTourCreateRequest = z.infer<typeof paddleTourCreateRequestSchema>;
export const skiTourCreateRequestSchema = z
.object({
name: tourNameSchema.describe('What the ski tour is called'),
description: tourDescriptionSchema.describe('A few words about the tour for the travellers, up to 2000 characters'),
waypoints: z
.array(sportPointSchema)
.min(2)
.max(MAX_SKI_ROUTE_LEGS + 1)
.describe(
'The points in order: the start, the points on the way (a lift station, a hut, a summit) and the end; each leg runs from one to the next, as plan_ski_route planned them',
),
discipline: skiDisciplineSchema.describe(
'alpine, snowboard, cross_country, touring, snowshoe or winter_hike, as plan_ski_route was asked',
),
technique: skiTechniqueSchema
.optional()
.describe('Cross-country only, and needed there: classic, skating or unknown (the skier does not mind)'),
options: skiRouteOptionsSchema.optional().describe('The options plan_ski_route was asked with'),
...dayFields,
})
.strict()
.superRefine((value, ctx) => {
const issues = skiIssues(true, { ski_discipline: value.discipline, ski_technique: value.technique ?? null });
for (const issue of issues) {
const path = issue.path[0] === 'ski_technique' ? ['technique'] : ['discipline'];
ctx.addIssue({ code: 'custom', path, message: issue.message });
}
});
export type SkiTourCreateRequest = z.infer<typeof skiTourCreateRequestSchema>;
shared/src/tours/tour-costing.spec.ts
+22
View File
@@ -0,0 +1,22 @@
import { BIKE_COSTING, bikeCosting, RUN_COSTING, runCosting } from './tour-costing';
import { BIKE_PROFILES, RUN_PROFILES } from './tours.schema';
import { describe, expect, it } from 'vitest';
describe('tour costing (BIK-01, RUN-01)', () => {
it('TOUR-COST-001: every bike profile asks the bicycle costing for its own bicycle type', () => {
expect(BIKE_PROFILES.map((profile) => bikeCosting(profile).bicycle_type)).toEqual([
'Hybrid',
'Road',
'Cross',
'Mountain',
]);
expect(bikeCosting('road')).toBe(BIKE_COSTING.road);
});
it('TOUR-COST-002: a run avoids ferries whatever its profile, and only a trail run takes T2 paths', () => {
for (const profile of RUN_PROFILES) expect(runCosting(profile).use_ferry).toBe(0);
expect(runCosting('running')).toEqual({ use_tracks: 0, use_ferry: 0 });
expect(RUN_COSTING.trail.max_hiking_difficulty).toBe(2);
});
});
shared/src/tours/tour-costing.ts
+72
View File
@@ -0,0 +1,72 @@
import type { BikeProfile, RunProfile } from './tours.schema';
/**
* What a bike tour and a run ask Valhalla for, by their profile: the
* bicycle costing of a bike tour and the pedestrian costing of a run. The
* planner in the browser and the server's tour routing both read them here,
* so a ride or a run is weighed alike wherever it is planned. A hike's own
* costing is `hikingCosting`.
*/
export type TourCostingOptions = Readonly<Record<string, number | string>>;
/**
* BIK-01 to BIK-04: what each bike profile asks Valhalla's bicycle costing for.
* Every one was checked against the public instance with trace_attributes over
* the routes it gave, before it was offered (shares of the length):
* - touring, Hybrid with bad surfaces avoided: Garmisch station to the Eckbauer
* 92 % asphalt and no gravel, where gravel took 18 % gravel on farm tracks.
* - road, Road at full surface avoidance: Herrsching to Andechs 100 % asphalt
* over 6.2 km, where touring took 4.98 km with 7 % dirt and 10 % compacted.
* - gravel, Cross with surfaces barely avoided: Munich Marienplatz to the
* Englischer Garten 39 % compacted paths along the Isar, touring 9 %.
* - mtb, Mountain with no surface avoidance and roads least wanted: Garmisch
* to the Eckbauer 63 % tracks and 38 % gravel.
* `use_roads` and the bicycle type also set the router's riding speed, so the
* time it gives is the profile's. None of it says a way is rideable or safe.
*/
export const BIKE_COSTING: Readonly<Record<BikeProfile, TourCostingOptions>> = {
touring: { bicycle_type: 'Hybrid', use_roads: 0.2, avoid_bad_surfaces: 1 },
road: { bicycle_type: 'Road', use_roads: 0.5, avoid_bad_surfaces: 1 },
gravel: { bicycle_type: 'Cross', use_roads: 0.1, avoid_bad_surfaces: 0.25 },
mtb: { bicycle_type: 'Mountain', use_roads: 0, avoid_bad_surfaces: 0 },
};
/**
* RUN-01, RUN-02: what each run profile asks Valhalla's pedestrian costing
* for. A run is run, so a ferry only where no way on land exists
* (`use_ferry` 0). Checked with trace_attributes against the public instance
* on 20.10.2026 (shares of the length):
* - running keeps to runnable, mostly paved ways: farm and forest tracks only
* where there is no other way (`use_tracks` 0), and no hiking limit, so the
* router keeps to the ways it takes for walking anyway (T1). Berlin S
* Grunewald into the forest went from 95 % tracks with 3 % paved to 67 %
* smooth paved paths over 3.58 km instead of 3.50 km; Munich Großhesseloher
* Brücke to Pullach from 79 % to 88 % smooth asphalt and no track left;
* Marienplatz to the Englischer Garten stayed as it was.
* - trail takes tracks wherever they serve (`use_tracks` 1) and admits
* mountain paths up to T2 (`max_hiking_difficulty` 2), never T3 and above.
* Above Freiburg Günterstal up to the Schauinsland it went from 82 % roads
* and 83 % paved (running) to 78 % forest tracks and 81 % compacted, gravel
* and dirt over 9.57 km instead of 10.15 km; Rathen to the Bastei took 28 % of T2
* path that running leaves out; Heidelberg's old town, all streets, stayed
* as it was. Leaning on footways (`walkway_factor`) was tried and left out:
* along the Isar it moved the run onto paved footways, from 33 % to 18 %
* unpaved.
* The router's own time is a walker's and is never used: a run's time is its
* distance at the runner's pace, whatever the profile. Nothing here says a
* way can be run.
*/
export const RUN_COSTING: Readonly<Record<RunProfile, TourCostingOptions>> = {
running: { use_tracks: 0, use_ferry: 0 },
trail: { use_tracks: 1, use_ferry: 0, max_hiking_difficulty: 2 },
};
/** The bicycle costing of a bike tour of this profile. */
export function bikeCosting(profile: BikeProfile): TourCostingOptions {
return BIKE_COSTING[profile];
}
/** The pedestrian costing of a run of this profile. */
export function runCosting(profile: RunProfile): TourCostingOptions {
return RUN_COSTING[profile];
}
shared/src/tours/tour-hike.schema.ts
+21 -17
View File
@@ -60,7 +60,7 @@ export const TOUR_GPX_TEXT_MAX = 1_000_000;
* over several days whether a day's stage ends there (MDT-01), where the
* night is spent and the next stage starts.
*/
const hikeStopSchema = hikePlanPointSchema
export const hikeStopSchema = hikePlanPointSchema
.extend({
stage_end: z
.boolean()
@@ -72,7 +72,7 @@ const hikeStopSchema = hikePlanPointSchema
.strict();
export type HikeStop = z.infer<typeof hikeStopSchema>;
const hikeWaypointsSchema = z
export const hikeWaypointsSchema = z
.array(hikeStopSchema)
.min(2)
.max(HIKE_MAX_WAYPOINTS)
@@ -99,7 +99,10 @@ export function hikeStageIssues(
);
}
function refineStages(value: { waypoints?: readonly HikeStop[]; round_trip?: boolean }, ctx: z.RefinementCtx): void {
export function refineStages(
value: { waypoints?: readonly HikeStop[]; round_trip?: boolean },
ctx: z.RefinementCtx,
): void {
if (!value.waypoints) return;
for (const issue of hikeStageIssues(value.waypoints, value.round_trip)) {
ctx.addIssue({ code: 'custom', path: issue.path, message: issue.message });
@@ -114,22 +117,31 @@ const hikePreferencesSchema = hikingPreferencesSchema
.nullable()
.describe('Steep climbs, steps or ferries the way avoids where there is a way round');
const roundTripSchema = z.boolean().describe('The hike ends back at its start: the way back is planned too');
export const roundTripSchema = z.boolean().describe('The hike ends back at its start: the way back is planned too');
const plannedMinutesSchema = plannedTourDurationMinutesSchema.describe(
export const plannedMinutesSchema = plannedTourDurationMinutesSchema.describe(
'How long the travellers plan to be out, in minutes, breaks included; left out the walking time stands alone',
);
const hikeDateSchema = z
export const hikeDateSchema = z
.string()
.regex(/^\d{4}-\d{2}-\d{2}$/)
.describe(
'The day the hike is planned for, YYYY-MM-DD, where it is on no day of the trip; day_id takes its own date',
);
const hikeDayIdSchema = idSchema.describe('The day of the trip the hike is planned on, as list_days gives it');
export const hikeDayIdSchema = idSchema.describe('The day of the trip the hike is planned on, as list_days gives it');
const hikeStartTimeSchema = clockTimeSchema.describe('When the hike starts, HH:MM');
export const hikeStartTimeSchema = clockTimeSchema.describe('When the hike starts, HH:MM');
export const variantLabelSchema = z
.string()
.trim()
.min(1)
.max(HIKE_VARIANT_LABEL_MAX)
.describe(
'A short name for this way when several are compared, such as "short and steep" or "by the lake"; given back as it is',
);
export const hikeProposeRequestSchema = z
.object({
@@ -138,15 +150,7 @@ export const hikeProposeRequestSchema = z
max_hiking_difficulty: hikeLimitSchema.optional(),
hiking_preferences: hikePreferencesSchema.optional(),
round_trip: roundTripSchema.optional(),
variant_label: z
.string()
.trim()
.min(1)
.max(HIKE_VARIANT_LABEL_MAX)
.optional()
.describe(
'A short name for this way when several are compared, such as "short and steep" or "by the lake"; given back as it is',
),
variant_label: variantLabelSchema.optional(),
day_id: hikeDayIdSchema.optional(),
date: hikeDateSchema.optional(),
start_time: hikeStartTimeSchema.optional(),
shared/src/tours/tour-plan.schema.spec.ts
+61
View File
@@ -0,0 +1,61 @@
import { tourPlanCreateRequestSchema, tourProposalSchema, tourProposeRequestSchema } from './tour-plan.schema';
import { describe, expect, it } from 'vitest';
const POINTS = [
{ lat: 47.9, lng: 11.1 },
{ lat: 47.95, lng: 11.15, name: 'Herrsching' },
];
describe('tourProposeRequestSchema', () => {
it('TOUR-PLAN-001: a bike tour and a run are proposed with their own profile, the profile optional', () => {
expect(tourProposeRequestSchema.safeParse({ name: 'Lake', activity: 'bike', waypoints: POINTS }).success).toBe(
true,
);
const run = { name: 'Isar', activity: 'run', run_profile: 'trail', waypoints: POINTS };
expect(tourProposeRequestSchema.parse(run).run_profile).toBe('trail');
});
it('TOUR-PLAN-002: refuses a profile of the other kind, a pace on a bike tour, a hike and a stage at the start', () => {
const bad = [
{ name: 'X', activity: 'bike', run_profile: 'trail', waypoints: POINTS },
{ name: 'X', activity: 'bike', run_pace_seconds_per_km: 360, waypoints: POINTS },
{ name: 'X', activity: 'run', bike_profile: 'road', waypoints: POINTS },
{ name: 'X', activity: 'hike', waypoints: POINTS },
{ name: 'X', activity: 'bike', waypoints: [{ ...POINTS[0], stage_end: true }, POINTS[1]] },
{ name: 'X', activity: 'bike', max_hiking_difficulty: 3, waypoints: POINTS },
];
for (const request of bad) expect(tourProposeRequestSchema.safeParse(request).success).toBe(false);
});
});
describe('tourPlanCreateRequestSchema', () => {
it("TOUR-PLAN-003: a run is created only with the runner's pace, a bike tour without one", () => {
const run = { name: 'Isar', activity: 'run', waypoints: POINTS };
const refused = tourPlanCreateRequestSchema.safeParse(run);
expect(refused.success).toBe(false);
expect(refused.error?.issues[0]?.path).toEqual(['run_pace_seconds_per_km']);
expect(tourPlanCreateRequestSchema.safeParse({ ...run, run_pace_seconds_per_km: 330 }).success).toBe(true);
expect(tourPlanCreateRequestSchema.safeParse({ ...run, run_pace_seconds_per_km: 30 }).success).toBe(false);
const bike = {
name: 'Lake',
activity: 'bike',
bike_profile: 'road',
waypoints: POINTS,
day_id: 4,
start_time: '09:00',
};
expect(tourPlanCreateRequestSchema.safeParse(bike).success).toBe(true);
});
});
describe('tourProposalSchema', () => {
it("TOUR-PLAN-004: holds a hike's limit, preferences and grades at null and knows a pace as a time's basis", () => {
const shape = tourProposalSchema.shape;
expect(shape.max_hiking_difficulty.safeParse(null).success).toBe(true);
expect(shape.max_hiking_difficulty.safeParse(2).success).toBe(false);
expect(shape.duration_basis.safeParse('pace').success).toBe(true);
expect(shape.duration_basis.safeParse('din33466').success).toBe(false);
expect(shape.activity.safeParse('run').success).toBe(true);
});
});
shared/src/tours/tour-plan.schema.ts
+146
View File
@@ -0,0 +1,146 @@
import { runPaceSecondsPerKmSchema } from './run-pace';
import { includeGeometryFlagSchema } from './tour-display.schema';
import {
hikeDateSchema,
hikeDayIdSchema,
hikeProposalSchema,
hikeStartTimeSchema,
hikeWaypointsSchema,
plannedMinutesSchema,
refineStages,
roundTripSchema,
variantLabelSchema,
} from './tour-hike.schema';
import { bikeProfileSchema, runProfileSchema, tourDescriptionSchema, tourNameSchema } from './tours.schema';
import { z } from 'zod';
/**
* A bike tour or a run an assistant plans with the traveller over MCP, the
* way a hike is planned (propose_hike, create_hike): proposed first, read
* only, as often as ways are compared, and created once the traveller said
* yes. The server plans the way through the points with the costing of the
* tour's profile (`bikeCosting`, `runCosting`), its heights and its time: a
* bike tour the router's riding time for its profile, a run its distance at
* the runner's pace. Nothing here carries a line from the caller.
*/
/** The tour types planned this way besides a hike, which keeps its own tools. */
export const TOUR_PLAN_ACTIVITIES = ['bike', 'run'] as const;
export const tourPlanActivitySchema = z.enum(TOUR_PLAN_ACTIVITIES);
export type TourPlanActivity = z.infer<typeof tourPlanActivitySchema>;
const activitySchema = tourPlanActivitySchema.describe(
'bike for a bike tour, run for a run; a hike is planned with propose_hike, a city walk with propose_city_walk',
);
const bikeProfileField = bikeProfileSchema.describe(
'A bike tour only, what it is ridden on: touring (paved ways, cycle paths and quiet roads, the default), road (asphalt only, a road bike), gravel (gravel and farm tracks) or mtb (rough tracks and trails, a mountain bike)',
);
const runProfileField = runProfileSchema.describe(
'A run only: running (runnable, mostly paved ways in towns, parks and along rivers, the default) or trail (forest tracks and natural paths up to T2 mountain paths)',
);
const runPaceField = runPaceSecondsPerKmSchema.describe(
"A run only: the runner's own pace in seconds per kilometre, 360 for 6:00 min/km; the run's time is its distance at this pace",
);
/** What belongs to which activity: a profile of its own kind, and a pace on a run only. */
function refineActivity(
value: {
activity: TourPlanActivity;
bike_profile?: unknown;
run_profile?: unknown;
run_pace_seconds_per_km?: unknown;
},
ctx: z.RefinementCtx,
): void {
const add = (path: string, message: string) => ctx.addIssue({ code: 'custom', path: [path], message });
if (value.activity === 'bike') {
if (value.run_profile !== undefined) add('run_profile', 'run_profile belongs to a run');
if (value.run_pace_seconds_per_km !== undefined) add('run_pace_seconds_per_km', 'a pace belongs to a run');
} else if (value.bike_profile !== undefined) {
add('bike_profile', 'bike_profile belongs to a bike tour');
}
}
const tourPlanShape = {
activity: activitySchema,
bike_profile: bikeProfileField.optional(),
run_profile: runProfileField.optional(),
run_pace_seconds_per_km: runPaceField.optional(),
waypoints: hikeWaypointsSchema.describe(
'The points the tour goes through in order: its start, the points on the way and its end. For a round trip leave the end out and set round_trip. A tour over several days marks the stop of each night with stage_end',
),
round_trip: roundTripSchema.optional(),
};
export const tourProposeRequestSchema = z
.object({
name: tourNameSchema.describe('What the tour is called, such as "Round the Ammersee"'),
...tourPlanShape,
variant_label: variantLabelSchema.optional(),
day_id: hikeDayIdSchema.optional(),
date: hikeDateSchema.optional(),
start_time: hikeStartTimeSchema.optional(),
along: z
.boolean()
.optional()
.describe(
'Looks for water, food, toilets and viewpoints along the way; true when left out, false when comparing ways',
),
include_geometry: includeGeometryFlagSchema,
})
.strict()
.superRefine(refineStages)
.superRefine(refineActivity);
export type TourProposeRequest = z.infer<typeof tourProposeRequestSchema>;
export const tourPlanCreateRequestSchema = z
.object({
name: tourNameSchema.describe('What the tour is called'),
description: tourDescriptionSchema.describe('A few words about the tour for the travellers, up to 2000 characters'),
...tourPlanShape,
planned_duration_minutes: plannedMinutesSchema.optional(),
day_id: hikeDayIdSchema.optional().describe('The day of the trip the tour is put on, as list_days gives it'),
start_time: hikeStartTimeSchema
.optional()
.describe('When the tour starts on that day, HH:MM, kept as the start of its visit; only with day_id'),
})
.strict()
.superRefine(refineStages)
.superRefine(refineActivity)
.superRefine((value, ctx) => {
// The planner saves a run only with a pace: without one it has no time at all.
if (value.activity === 'run' && value.run_pace_seconds_per_km === undefined) {
ctx.addIssue({
code: 'custom',
path: ['run_pace_seconds_per_km'],
message: "a run is saved with the runner's pace: ask for it",
});
}
});
export type TourPlanCreateRequest = z.infer<typeof tourPlanCreateRequestSchema>;
/** How a bike tour's or a run's time was reckoned: the router's riding time, or the distance at the runner's pace. */
export const TOUR_PLAN_DURATION_BASES = ['router', 'pace'] as const;
/**
* What propose_tour answers: a hike's proposal (the way, its measures, its
* points with where and when each is reached, the places along it, the day)
* for a bike tour or a run, with its activity and profile. A hike's limit,
* preferences and SAC grades are a hike's alone and stay null. A run without
* a pace has no time.
*/
export const tourProposalSchema = hikeProposalSchema.extend({
activity: tourPlanActivitySchema,
bike_profile: bikeProfileSchema.nullable(),
run_profile: runProfileSchema.nullable(),
run_pace_seconds_per_km: runPaceSecondsPerKmSchema.nullable(),
duration_basis: z.enum(TOUR_PLAN_DURATION_BASES).nullable(),
max_hiking_difficulty: z.null(),
hiking_preferences: z.null(),
sac: z.null(),
});
export type TourProposal = z.infer<typeof tourProposalSchema>;
wiki/MCP-Addon-Tools.md
+5 -1
View File
@@ -275,7 +275,7 @@ Each tool asks for the scope of what it writes, so the scopes differ per tool. T
### Tours _(Tours addon required)_
The saved tours of a trip, as the Tours list and the tour detail show them, how far a city walk got on a day, paddle legs planned on the water, a city walk prepared from a briefing, a change to a saved city walk prepared for review and saved once the traveller confirmed it, a saved change taken back the same way, a hike planned on the server with its heights and SAC grades, created, changed or taken in from a GPX file once the traveller confirmed it, and the tours the user has done, summed across their trips as the Atlas shows them. `take_over_tour`, `create_city_walk`, `create_hike`, `update_tour`, `import_tour_gpx`, `save_tour_change`, `undo_tour_change`, `assign_tour_track`, `unassign_tour_track`, `set_tour_activity_excluded`, `save_tour_to_collection`, `take_over_collection_tour`, `delete_collection_tour`, `link_tour_packing` and `unlink_tour_packing` write; every other tool here only reads. The collection tools need the Collections addon as well, the packing tools the Lists addon. Tours someone is still drawing in the planner are not saved yet and do not show here.
The saved tours of a trip, as the Tours list and the tour detail show them, how far a city walk got on a day, paddle legs planned on the water, a city walk prepared from a briefing, a change to a saved city walk prepared for review and saved once the traveller confirmed it, a saved change taken back the same way, a hike planned on the server with its heights and SAC grades, created, changed or taken in from a GPX file once the traveller confirmed it, a bike tour or a run planned on the server for its profile and created the same way, a paddle or ski tour saved from its plan, and the tours the user has done, summed across their trips as the Atlas shows them. `take_over_tour`, `create_city_walk`, `create_hike`, `create_tour`, `create_paddle_tour`, `create_ski_tour`, `update_tour`, `import_tour_gpx`, `save_tour_change`, `undo_tour_change`, `assign_tour_track`, `unassign_tour_track`, `set_tour_activity_excluded`, `save_tour_to_collection`, `take_over_collection_tour`, `delete_collection_tour`, `link_tour_packing` and `unlink_tour_packing` write; every other tool here only reads. The collection tools need the Collections addon as well, the packing tools the Lists addon. Tours someone is still drawing in the planner are not saved yet and do not show here.
| Tool | Description | Scope |
|---|---|---|
@@ -305,6 +305,10 @@ The saved tours of a trip, as the Tours list and the tour detail show them, how
| `create_city_walk` | Creates a city walk from stations the traveller confirmed (for instance `stations_for_create` of `propose_city_walk`), through the same creation the planner's save uses: a key for every station, its name, stay, importance, protection, opening hours and the place of the trip it stands for. The way on foot is planned by the same router as for the proposal, and the walk is saved with it, its distance and its walking time. Where the router gives no way, the walk is saved with its stations only (`route_pending`), says why, and has no line, distance or walking time until someone opens it in the planner, where TREK plans the way on foot and the walk can be saved with it. Needs `place_edit` on the trip | `trips:write` |
| `propose_hike` | Plans a named hike for the traveller to look at, without saving anything: the way on foot through its points in order (start, points on the way, each with its kind of place where it is one, end; `round_trip` comes back to the start), on paths no harder than `max_hiking_difficulty` on the SAC scale (T1 to T6, T2 when left out) and avoiding steep climbs, steps or ferries where there is a way round (`hiking_preferences`). The way is planned by TREK's Valhalla router with the planner's hiking costing (the instance an admin set, else the public FOSSGIS one), through the same paced queue as the road trip. Answers the distance, ascent and descent, the walking time without breaks (by DIN 33466 from the heights where every point has one, else the router's), the lowest and highest point (with where it lies along the way), the SAC grades OpenStreetMap records along the way (the hardest, up to 80 graded stretches, neighbours joined with the harder grade kept, and how much is unknown, which is never read as easy), each point with where it lies along the way, how far it was moved onto a way, the walking minutes from the start and, with `start_time`, its arrival, and up to 12 summits, huts, drinking water and viewpoints within 250 m of the way (`along`; left out with `along: false`, and none where they could not be searched). With `day_id` (whose date it takes) or `date` it plans the day: the arrival (on the next day past midnight), sunrise and sunset and the weather by the hour at the highest point (to about a kilometre), from the forecast, as observed for a past day (which knows no likelihood of rain), or, further out, from last year's day; without a start the latest one that is back half an hour before sunset. It warns of a start before sunrise, an arrival after sunset or within the hour before it, and of the first walking hour with thunderstorms or rain more likely than not, these two on a forecast only; without the weather the day still answers, without sun, hours or warnings. With `include_geometry` it adds the line (up to 300 points) and height profile (up to 200 samples) for drawing (`line_geometry`, `profile_geometry`). Where no way is planned it says why: no Valhalla (a routing server of the traveller's own knows no hiking limit), the router not answering, no way within the limit, a point more than 300 m from any way, or a way too long for one hike (past the router's own distance limit, or more than 10,000 points, whose heights would hold the router's queue up for everyone). A planned way with every height is kept for 15 minutes (the last 64 per instance, up to 200,000 line points together), so a hike created or changed from the proposal saves the line it showed. `variant_label` is given back, so several ways can be compared | `trips:read` |
| `create_hike` | Creates a hike from points the traveller confirmed (usually those of `propose_hike`), through the same creation the planner's save uses: its points in order as start, points on the way and end with their names and kinds of place, the way planned by the same router (the line a proposal of the last 15 minutes showed) and saved whole with the height of every point, its distance, ascent, descent, walking time, hiking limit, preferences and planned time. Where the router does not answer, for the way or for its heights, the hike is saved with its points only (`route_pending`), says so, and TREK plans the way when someone opens it in the planner. Any other reason the proposal names (no Valhalla, no way within the limit, a point off every way, a way too long) refuses the hike with why, and nothing is saved, since the planner could not plan it either. With `day_id` it is put on that day of the trip in the same write, `start_time` kept as the start of that visit, and the trip is told of the tour and the visit once both are saved (`assignment` names the visit; `day_edit` is needed as well). Needs `place_edit` on the trip | `trips:write` |
| `propose_tour` | Plans a named bike tour (`activity` `bike`) or run (`activity` `run`) for the traveller to look at, without saving anything, the way `propose_hike` plans a hike: through its points in order (`round_trip` back to the start), by TREK's Valhalla router with the costing the tour planner uses for the profile. A bike tour's `bike_profile` is `touring` (paved ways, cycle paths and quiet roads, the default), `road` (asphalt only), `gravel` (gravel and farm tracks) or `mtb` (rough tracks and trails); a run's `run_profile` is `running` (mostly paved ways, the default) or `trail` (forest tracks and natural paths up to T2). A bike tour's time is the router's riding time for its profile; a run's is its distance at `run_pace_seconds_per_km`, the runner's own pace, and a run without a pace has no time. Answers what `propose_hike` answers (distance, ascent, descent, the points with where and when each is reached, places along the way, the day with its sun, weather and warnings, or why no way was planned) with the activity, profile and pace, and no hiking limit or SAC grades. With `include_geometry` it adds the line for drawing | `trips:read` |
| `create_tour` | Creates a bike tour or a run from points the traveller confirmed (usually those of `propose_tour`), through the same creation the planner's save uses: its points, the way planned again by the same router for the same profile and saved whole with its heights, its distance, climb, descent and time, its profile and a run's pace (a run is created only with one). Where the router does not answer, for the way or for its heights, the tour is saved with its points only (`route_pending`); any other reason refuses it and nothing is saved. With `day_id` it is put on that day in the same write, `start_time` kept as the start of that visit (`day_edit` is needed as well). Needs `place_edit` on the trip | `trips:write` |
| `create_paddle_tour` | Saves a paddle tour from a plan of `plan_paddle_route` the traveller confirmed: its points (the start of the first leg and the end of every leg), the boat, lake style and lock policy it was planned with, and `water_context` (`river` or `lake`). Each leg is planned again on the water by the same router; a leg that cannot be planned refuses the tour and nothing is saved. The legs are joined into one line with the height of every point and timed with the planner's estimate: water at the paddling speed (the boat's starting value when none is given), each portage the router carries round at the carrying speed with its time to get out and in. Without heights the tour is saved with its points only (`route_pending`). With `day_id` it is put on that day in the same write (`day_edit` too). Needs `place_edit` on the trip | `trips:write` |
| `create_ski_tour` | Saves a ski or winter tour from a plan of `plan_ski_route` the traveller confirmed: its points, its discipline (a cross-country tour with its technique) and the options it was planned with. Each leg is planned again on the piste data by the same router; a leg that cannot be planned refuses the tour and nothing is saved. The legs are joined into one line with the piste data's heights (Valhalla's where one is missing), the piste router's time, the options as the discipline reads them and the piste data build they were planned on. Without heights the tour is saved with its points only (`route_pending`). With `day_id` it is put on that day in the same write (`day_edit` too). Needs `place_edit` on the trip | `trips:write` |
| `update_tour` | Changes a saved hike against the `revision` it was read at: a new name, description or planned time keeps its way; new points, a new hiking limit or new preferences plan the way anew as `propose_hike` does, and so does a hike still waiting for its way. A hike changed since that revision is refused as a conflict before anything is planned, and a new way that cannot be planned, or not with its heights, is refused with the reason, leaving the hike as it was. A new point standing where a saved one stood (within 25 m) keeps that point's link to a place of the trip and its name. A hike with a section drawn by hand (a via ferrata, a free line, a ferry) or split into stages takes new points only in the planner, the hand-drawn one a new limit or new preferences too. A recorded track without points of its own takes only new points, which plan it over and keep the recording; every other tour type is refused (a city walk changes through `prepare_tour_change` and `save_tour_change`). The hike stays on its days. Needs `place_edit` on the trip | `trips:write` |
| `import_tour_gpx` | Takes in the tracks and routes of a GPX file, passed as its text, as tours of the trip, one each, through the same import as the planner's file import: a hike unless another type is named (a bike import with its profile, a run with its profile, a paddle import with its boat and water, a ski import with its discipline). A track already in the trip under the same name and start is skipped and counted; a file without a track or route is refused. Needs `place_edit` on the trip | `trips:write` |
| `prepare_tour_change` | Prepares a change to a saved city walk for the traveller to review, without saving anything: no tour, station, visit or day plan changes, and turning it down keeps the plan as it was. The changes apply in order and name the saved stations by their keys: `add` (a new station after a station; a spontaneous stop on the way is an add after the station the traveller is at), `remove`, `replace` and `move`. A protected station, or one visited or skipped on any day of the walk, is never removed, replaced or moved, nothing is put before the last station already done, and a leg drawn by hand stays as drawn, the closing leg of a loop included; such a change is refused, and with it the whole proposal, naming every change and why. Another type of tour, or a walk that is a recorded track without stations of its own, is refused as well: so far only a city walk takes prepared changes. The answer names the tour and the `revision` it was prepared on (a save has to name it, and a tour changed since is refused rather than overwritten), the stations after the change with what changed each and where it stood before, what was removed, the way on foot before and after planned by the same router TREK uses for city walks and its change in metres and minutes (the distance and walking time stored with the walk given apart), the stays as far as known before and after, every leg after the change with the new ones marked, `data_gaps` for what could not be worked out (no way from the router, stays not known, no arrival times, shaping points dropped because the leg they steered changed), a warning for a station of importance must removed or replaced, each new station that is not yet a place of the trip as `create_place` takes it to keep it as a place instead (a station linked to a place of the trip is left out), whether the traveller may change the trip's places at all (`can_save`) and the `proposal_id` a save of it names | `trips:read` |