Skip to content
This repository has been archived by the owner on Apr 10, 2024. It is now read-only.

add plannedArrival/plannedDeparture #20

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

add plannedArrival/plannedDeparture #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8025b16
format code using prettier
derhuerst Aug 16, 2022
a66792a
add leg.planned{Departure,Arrival}
derhuerst Apr 29, 2021
849eaf3
parse LineRef as leg.line.id 💥
derhuerst Apr 29, 2021
4b56aea
add leg.tripId
derhuerst Apr 29, 2021
c900f43
WIP
derhuerst Oct 13, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions src/RequestAndParse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ export { Element as DOMElement } from "domhandler";
const DEBUG = /(^|,)trias-client(,|$)/.test(process.env.DEBUG || "");

export async function request(url: string, requestorRef: string, headers: { [key: string]: string }, reqBody: string): Promise<AxiosResponse<string>> {

// Convert all header keys to lower case, to make sure that you actually overwrite the content-type header when specifying Content-Type
// HTTP headers are case-insensitive, so this shouldn't be a problem
for (const header in headers) {
Expand All @@ -28,7 +27,7 @@ export async function request(url: string, requestorRef: string, headers: { [key
// - text/xml (RFC 7303, previously RFC 3023)
// https://en.wikipedia.org/wiki/XML_and_MIME
"content-type": "application/xml",
"accept": "application/xml",
accept: "application/xml",
...headers,
},
data: reqBody,
Expand Down
2 changes: 1 addition & 1 deletion src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { TRIASDeparturesHandler } from "./trias/TRIASDeparturesHandler";
import { TRIASJourneysHandler } from "./trias/TRIASJourneysHandler";
import { TRIASStopsHandler } from "./trias/TRIASStopsHandler";

export const getClient = (options: ClientOptions) : TRIASClient => {
export const getClient = (options: ClientOptions): TRIASClient => {
return new TRIASClient(options);
};

Expand Down
8 changes: 4 additions & 4 deletions src/trias/TRIASDeparturesHandler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ export class TRIASDeparturesHandler {

if (options.includeSituations) {
for (const situationEl of selectAll("PtSituation", doc)) {

const summary = getText(selectOne("Summary", situationEl));
const detail = getText(selectOne("Detail", situationEl));
const startTime = getText(selectOne("StartTime", situationEl));
Expand All @@ -42,8 +41,8 @@ export class TRIASDeparturesHandler {
description: detail || "",
validFrom: startTime || "",
validTo: endTime || "",
priority: priority || ""
}
priority: priority || "",
};

situations.push(situation);
}
Expand Down Expand Up @@ -72,6 +71,7 @@ export class TRIASDeparturesHandler {
const direction = getText(selectOne("DestinationText Text", departureEl));
if (direction) departure.direction = direction;

// todo: planned*
const timetabledTime = getText(selectOne("TimetabledTime", departureEl));
if (timetabledTime) departure.departure = this.parseResponseTime(timetabledTime);

Expand Down Expand Up @@ -101,7 +101,7 @@ export class TRIASDeparturesHandler {
const result: DeparturesResult = {
success: true,
departures,
}
};
if (options.includeSituations) result.situations = situations;

return result;
Expand Down
36 changes: 21 additions & 15 deletions src/trias/TRIASJourneysHandler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,7 @@ export class TRIASJourneysHandler {
if (options.arrivalTime) arrTime = this.parseRequestTime(options.arrivalTime);
else if (options.departureTime) depTime = this.parseRequestTime(options.departureTime);

const via = (options.via || [])
.map((stationID) => this.parseRequestViaStation(stationID)).join("");
const via = (options.via || []).map((stationID) => this.parseRequestViaStation(stationID)).join("");

const payload = TRIAS_TR.replace("$ORIGIN", options.origin)
.replace("$VIA", via)
Expand All @@ -42,7 +41,6 @@ export class TRIASJourneysHandler {

if (options.includeSituations) {
for (const situationEl of selectAll("PtSituation", doc)) {

const summary = getText(selectOne("Summary", situationEl));
const detail = getText(selectOne("Detail", situationEl));
const startTime = getText(selectOne("StartTime", situationEl));
Expand All @@ -54,8 +52,8 @@ export class TRIASJourneysHandler {
description: detail || "",
validFrom: startTime || "",
validTo: endTime || "",
priority: priority || ""
}
priority: priority || "",
};

situations.push(situation);
}
Expand Down Expand Up @@ -97,10 +95,13 @@ export class TRIASJourneysHandler {
if (startStationName) origin.name = startStationName;

const startTime = getText(selectOne("TimetabledTime", legBoardEl));
if (startTime) leg.departure = this.parseResponseTime(startTime);
if (startTime) leg.departure = leg.plannedDeparture = this.parseResponseTime(startTime);

const startRealtime = getText(selectOne("EstimatedTime", legBoardEl));
if (startRealtime) leg.departureDelay = moment(startRealtime).unix() - moment(leg.departure).unix();
if (startRealtime) {
leg.departure = this.parseResponseTime(startRealtime);
leg.departureDelay = moment(leg.departure).unix() - moment(leg.plannedDeparture).unix();
}

const startPlatform = getText(selectOne("PlannedBay Text", legBoardEl));
if (startPlatform) leg.departurePlatform = startPlatform;
Expand All @@ -120,10 +121,13 @@ export class TRIASJourneysHandler {
if (endStationName) destination.name = endStationName;

const endTime = getText(selectOne("TimetabledTime", legAlightEl));
if (endTime) leg.arrival = this.parseResponseTime(endTime);
if (endTime) leg.arrival = leg.plannedArrival = this.parseResponseTime(endTime);

const endRealtime = getText(selectOne("EstimatedTime", legAlightEl));
if (endRealtime) leg.arrivalDelay = moment(endRealtime).unix() - moment(leg.arrival).unix();
if (endRealtime) {
leg.arrival = this.parseResponseTime(endRealtime);
leg.arrivalDelay = moment(leg.arrival).unix() - moment(leg.plannedArrival).unix();
}

const endPlatform = getText(selectOne("PlannedBay Text", legAlightEl));
if (endPlatform) leg.arrivalPlatform = endPlatform;
Expand All @@ -134,11 +138,13 @@ export class TRIASJourneysHandler {
line: "",
};

const lineName = getText(selectOne("PublishedLineName Text", legEl)) || getText(selectOne("Name Text", legEl));
if (lineName && leg.line) {
leg.line.id = lineName;
leg.line.line = lineName;
}
const tripId = getText(selectOne("JourneyRef", legEl));
if (tripId) leg.tripId = tripId;

const lineId = getText(selectOne("LineRef", legEl));
if (lineId && leg.line) leg.line.id = lineId;
const lineName = getText(selectOne("PublishedLineName Text", legEl));
if (lineName && leg.line) leg.line.line = lineName;

const direction = getText(selectOne("DestinationText Text", legEl));
if (direction) leg.direction = direction;
Expand Down Expand Up @@ -230,7 +236,7 @@ export class TRIASJourneysHandler {
const result: JourneysResult = {
success: true,
journeys: trips,
}
};
if (options.includeSituations) result.situations = situations;

return result;
Expand Down
5 changes: 4 additions & 1 deletion src/types/fptf.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,15 +52,18 @@ interface FPTFJourney {
}

interface FPTFLeg {
tripId?: string; // Not included in FPTF
line?: FPTFLine; // Not included in FPTF
mode: FPTFMode;
subMode?: FPTFSubmode;
direction: string; // Not included in FPTF
origin: string | FPTFStop | FPTFLocation;
destination: string | FPTFStop | FPTFLocation;
plannedDeparture?: string; // Not included in FPTF
departure: string;
departureDelay?: number;
departurePlatform?: string;
plannedArrival?: string; // Not included in FPTF
arrival: string;
arrivalDelay?: number;
arrivalPlatform?: string;
Expand Down Expand Up @@ -112,7 +115,7 @@ interface Ticket {
}

interface Situation {
title: string,
title: string;
description: string;
validFrom: string;
validTo: string;
Expand Down
22 changes: 22 additions & 0 deletions src/types/results.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,25 @@ interface StopsResult extends Result {
stops?: FPTFStop[];
}

interface Ticket {
id: string;
name: string;
faresAuthorityRef: string;
faresAuthorityName: string;
price: number | null;
// todo: <NetPrice>
currency: string | null;
// todo: <VatRate>
tariffLevel: string | null;
// todo: <TariffLevelLabel>
travelClass: string | null; // todo: make an enum
// todo: <RequiredCard>
validFor: string | null; // todo: make an enum
validityDuration: string | null;
// todo: <ValidityDurationText>
// todo: <ValidityFareZones>
// todo: <ValidityAreaText>
// todo: <InfoUrl>
// todo: <SaleUrl>
// todo: <BookingInfo>
}