fix docs

[skip ci]

cspell.config.json

@@ -627,6 +627,8 @@
     "Intervalle",
     "tagesbest",
     "dbbahnhof",
+    "Deutschlandticket",
+    "fahrverguenstigungen",
     "cancelation"
   ],
   "ignorePaths": [

docs/nearby.md

@@ -10,7 +10,7 @@ With `opt`, you can override the default options, which look like this:
 {
 	results: 8, // maximum number of results
 	distance: null, // maximum walking distance in meters
-	poi:      false, // return points of interest?
+	poi:      false, // not supported
 	stops:    true, // return stops/stations?
 	subStops: true, // not supported
 	entrances: true, // not supported

docs/openapi.yaml

@@ -613,7 +613,7 @@ paths:
             default: true
         - name: linesOfStops
           in: query
-          description: Parse & return lines of each stop/station?
+          description: not supported
           schema:
             type: boolean
             default: false
@@ -1887,11 +1887,11 @@ components:
           default: false
           type: boolean
         subStops:
-          description: parse & expose sub-stops of stations?
+          description: not supported
           default: false
           type: boolean
         entrances:
-          description: parse & expose entrances of stops/stations?
+          description: not supported
           default: true
           type: boolean
         remarks:
@@ -1995,11 +1995,11 @@ components:
           default: false
           type: boolean
         subStops:
-          description: parse & expose sub-stops of stations?
+          description: not supported
           default: true
           type: boolean
         entrances:
-          description: parse & expose entrances of stops/stations?
+          description: not supported
           default: true
           type: boolean
         remarks:
@@ -2034,15 +2034,15 @@ components:
           default: true
           type: boolean
         subStops:
-          description: parse & expose sub-stops of stations?
+          description: not supported
           default: false
           type: boolean
         entrances:
-          description: parse & expose entrances of stops/stations?
+          description: not supported
           default: true
           type: boolean
         linesOfStops:
-          description: parse & expose lines at each stop/station?
+          description: not supported
           default: false
           type: boolean
         language:
@@ -2061,11 +2061,11 @@ components:
           default: false
           type: boolean
         subStops:
-          description: parse & expose sub-stops of stations?
+          description: not supported
           default: true
           type: boolean
         entrances:
-          description: parse & expose entrances of stops/stations?
+          description: not supported
           default: true
           type: boolean
         remarks:
@@ -2088,11 +2088,11 @@ components:
           default: false
           type: boolean
         subStops:
-          description: parse & expose sub-stops of stations?
+          description: not supported
           default: true
           type: boolean
         entrances:
-          description: parse & expose entrances of stops/stations?
+          description: not supported
           default: true
           type: boolean
         remarks:
@@ -2128,11 +2128,11 @@ components:
           default: 10
           type: number
         subStops:
-          description: parse & expose sub-stops of stations?
+          description: not supported
           default: true
           type: boolean
         entrances:
-          description: parse & expose entrances of stops/stations?
+          description: not supported
           default: true
           type: boolean
         linesOfStops:
@@ -2206,7 +2206,7 @@ components:
           default: undefined
           type: number
         poi:
-          description: return points of interest?
+          description: not supported
           default: false
           type: boolean
         stops:
@@ -2218,15 +2218,15 @@ components:
           description: products
           default: undefined
         subStops:
-          description: parse & expose sub-stops of stations?
+          description: not supported
           default: true
           type: boolean
         entrances:
-          description: parse & expose entrances of stops/stations?
+          description: not supported
           default: true
           type: boolean
         linesOfStops:
-          description: parse & expose lines at each stop/station?
+          description: not supported
           default: false
           type: boolean
         language:
@@ -2254,11 +2254,11 @@ components:
           description: products
           default: undefined
         subStops:
-          description: parse & expose sub-stops of stations?
+          description: not supported
           default: true
           type: boolean
         entrances:
-          description: parse & expose entrances of stops/stations?
+          description: not supported
           default: true
           type: boolean
         polylines:
@@ -2296,11 +2296,11 @@ components:
           default: 20
           type: number
         subStops:
-          description: parse & expose sub-stops of stations?
+          description: not supported
           default: true
           type: boolean
         entrances:
-          description: parse & expose entrances of stops/stations?
+          description: not supported
           default: true
           type: boolean
         polylines:

index.js

@@ -181,6 +181,8 @@ const createClient = (profile, userAgent, opt = {}) => {
 			scheduledDays: false, // parse & expose dates each journey is valid on?
 			notOnlyFastRoutes: false, // if true, also show routes that are mathematically non-optimal
 			bestprice: false, // search for lowest prices across the entire day
+			deutschlandTicketDiscount: false,
+			deutschlandTicketConnectionsOnly: false,
 		}, opt);
 
 		if (opt.when !== undefined) {
@@ -239,6 +241,8 @@ const createClient = (profile, userAgent, opt = {}) => {
 			entrances: true, // parse & expose entrances of stops/stations?
 			remarks: true, // parse & expose hints & warnings?
 			scheduledDays: false, // parse & expose dates the journey is valid on?
+			deutschlandTicketDiscount: false,
+			deutschlandTicketConnectionsOnly: false,
 		}, opt);
 
 		const req = profile.formatRefreshJourneyReq({profile, opt}, refreshToken);

lib/api-parsers.js

@@ -76,6 +76,18 @@ const mapRouteParsers = (route, parsers) => {
 				default: false,
 				parse: parseBoolean,
 			},
+			deutschlandTicketDiscount: {
+				description: 'Calculate ticket prices assuming Deutschlandticket is present',
+				type: 'boolean',
+				default: false,
+				parse: parseBoolean,
+			},
+			deutschlandTicketConnectionsOnly: {
+				description: 'Only return journeys that can be used with the Deutschlandticket',
+				type: 'boolean',
+				default: false,
+				parse: parseBoolean,
+			},
 		};
 	}
 	if (route.includes('departures') || route.includes('arrivals')) {

lib/request.js

@@ -105,7 +105,6 @@ const request = async (ctx, userAgent, reqData) => {
 	if (reqOptions.query) {
 		url += '?' + stringify(reqOptions.query, {arrayFormat: 'brackets', encodeValuesOnly: true});
 	}
-	console.log(url);
 	const reqId = randomBytesHexString(6);
 	const fetchReq = new Request(url, reqOptions);
 	profile.logRequest(ctx, fetchReq, reqId);
@@ -122,6 +121,7 @@ const request = async (ctx, userAgent, reqData) => {
 
 	if (!res.ok) {
 		// todo [breaking]: make this a FetchError or a HafasClientError?
+		console.log(JSON.stringify(res), await res.text());
 		const err = new Error(res.statusText);
 		Object.assign(err, errProps);
 		throw err;

p/dbnav/journeys-req.js

@@ -9,6 +9,10 @@ const formatBaseJourneysReq = (ctx) => {
 		einstiegsTypList: [
 			'STANDARD',
 		],
+		fahrverguenstigungen: {
+			deutschlandTicketVorhanden: ctx.opt.deutschlandTicketDiscount,
+			nurDeutschlandTicketVerbindungen: ctx.opt.deutschlandTicketConnectionsOnly,
+		},
 		klasse: travellers.klasse,
 		reisendenProfil: {
 			reisende: travellers.reisende.map(t => {

p/dbweb/journeys-req.js

@@ -10,8 +10,8 @@ const formatJourneysReq = (ctx, from, to, when, outFrwd, journeysRef) => {
 	let query = {
 		maxUmstiege: transfers,
 		minUmstiegszeit: opt.transferTime,
-		deutschlandTicketVorhanden: false,
+		deutschlandTicketVorhanden: opt.deutschlandTicketDiscount,
-		nurDeutschlandTicketVerbindungen: false,
+		nurDeutschlandTicketVerbindungen: opt.deutschlandTicketConnectionsOnly,
 		reservierungsKontingenteVorhanden: false,
 		schnelleVerbindungen: !opt.notOnlyFastRoutes,
 		sitzplatzOnly: false,

package-lock.json

@@ -1,12 +1,12 @@
 {
 	"name": "db-vendo-client",
-	"version": "6.8.0",
+	"version": "6.8.2",
 	"lockfileVersion": 3,
 	"requires": true,
 	"packages": {
 		"": {
 			"name": "db-vendo-client",
-			"version": "6.8.0",
+			"version": "6.8.2",
 			"license": "ISC",
 			"dependencies": {
 				"content-type": "^1.0.5",

package.json

@@ -1,7 +1,7 @@
 {
 	"name": "db-vendo-client",
 	"description": "Client for bahn.de public transport APIs.",
-	"version": "6.8.0",
+	"version": "6.8.2",
 	"type": "module",
 	"main": "index.js",
 	"files": [

test/e2e/db.js

@@ -127,7 +127,7 @@ if (!process.env.VCR_OFF) {
 	});
 
 	tap.test('refreshJourney – valid tickets', async (t) => {
-		const T_MOCK = 1710831600 * 1000; // 2024-03-19T08:00:00+01:00
+		const T_MOCK = 1758279600 * 1000;
 		const when = createWhen(dbProfile.timezone, dbProfile.locale, T_MOCK);
 
 		const journeysRes = await client.journeys(berlinHbf, münchenHbf, {
@@ -261,7 +261,7 @@ if (!process.env.VCR_MODE) {
 }
 
 tap.test('refreshJourney', async (t) => {
-	const T_MOCK = 1710831600 * 1000; // 2024-03-19T08:00:00+01:00
+	const T_MOCK = 1763542800 * 1000;
 	const when = createWhen(dbProfile.timezone, dbProfile.locale, T_MOCK);
 	const validate = createValidate({...cfg, when});
 

test/e2e/dbnav.js

@@ -126,7 +126,7 @@ tap.test('journeys – Berlin Schwedter Str. to München Hbf', async (t) => {
 });
 
 tap.test('refreshJourney – valid tickets', async (t) => {
-	const T_MOCK = 1710831600 * 1000; // 2024-03-19T08:00:00+01:00
+	const T_MOCK = 1758279600 * 1000;
 	const when = createWhen(dbProfile.timezone, dbProfile.locale, T_MOCK);
 
 	const journeysRes = await client.journeys(berlinHbf, münchenHbf, {
@@ -261,7 +261,7 @@ if (!process.env.VCR_OFF) {
 	}
 
 	tap.test('refreshJourney', async (t) => {
-		const T_MOCK = 1710831600 * 1000; // 2024-03-19T08:00:00+01:00
+		const T_MOCK = 1763542800 * 1000;
 		const when = createWhen(dbProfile.timezone, dbProfile.locale, T_MOCK);
 		const validate = createValidate({...cfg, when});
 

test/format/dbnav-journeys-query.js

@@ -41,6 +41,10 @@ const berlinWienQuery0 = Object.freeze(
 		einstiegsTypList: [
 			'STANDARD',
 		],
+		fahrverguenstigungen: {
+			deutschlandTicketVorhanden: undefined,
+			nurDeutschlandTicketVerbindungen: undefined,
+		},
 		klasse: 'KLASSE_2',
 		reiseHin: {
 			wunsch: {

test/format/dbweb-journeys-query.js

@@ -57,8 +57,8 @@ const berlinWienQuery0 = Object.freeze(
 		sitzplatzOnly: false,
 		bikeCarriage: false,
 		reservierungsKontingenteVorhanden: false,
-		nurDeutschlandTicketVerbindungen: false,
+		nurDeutschlandTicketVerbindungen: undefined,
-		deutschlandTicketVorhanden: false,
+		deutschlandTicketVorhanden: undefined,
 		maxUmstiege: null,
 		zwischenhalte: null,
 		minUmstiegszeit: 0,