linting

* Add BMIS number support for business customer rates

Introduces a new `bmisNumber` option to journey requests, allowing bahn.business customers to access corporate rates by providing their 7-digit BMIS number. Adds documentation and a `createBusinessClient` helper for convenience. The request payload now includes a `firmenZugehoerigkeit` object when a BMIS number is set.

* Update cspell.config.json

Update cspell.config.json to fix spell check issues in PR #30

cspell.config.json

@@ -95,6 +95,8 @@
     "bitmasks",
     "Blaschkoallee",
     "Blissestr",
+    "bmis",
+    "BMIS",
     "BNWNZF",
     "Böhme",
     "BONVOYO",
@@ -195,6 +197,7 @@
     "Fehrbelliner",
     "Fernbf",
     "Fernverkehr",
+    "firmen",
     "Flexpreis",
     "Flix",
     "Fltr",
@@ -263,6 +266,7 @@
     "Hohenzollerndamm",
     "Hüngheim",
     "IBNR",
+    "identifikationsart",
     "Ihren",
     "Ihrer",
     "Informationen",
@@ -610,6 +614,7 @@
     "Zoologischer",
     "Zuege",
     "zugart",
+    "Zugehoerigkeit",
     "zugattrib",
     "zugattribute",
     "Zuges",
@@ -627,7 +632,11 @@
     "Intervalle",
     "tagesbest",
     "dbbahnhof",
-    "cancelation"
+    "Deutschlandticket",
+    "fahrverguenstigungen",
+    "cancelation",
+    "MOTIS",
+    "motis"
   ],
   "ignorePaths": [
     "docs/dumps/**",

docs/journeys.md

@@ -81,6 +81,7 @@ With `opt`, you can override the default options, which look like this:
 	firstClass: false, // first or second class for tickets
 	loyaltyCard: null, // BahnCards etc., see below
 	language: 'en', // language to get results in
+	bmisNumber: null, // 7-digit BMIS number for business customer rates
 }
 ```
 
@@ -316,6 +317,27 @@ hafas.journeys(from, to, {
 })
 ```
 
+## Using the `bmisNumber` option
+
+bahn.business customers with a BMIS number can get their corporate rates and corporate tariffs by providing their 7-digit BMIS number:
+
+```js
+// Option 1: Using the bmisNumber parameter directly
+await client.journeys(from, to, {
+	bmisNumber: '1234567' // Your 7-digit BMIS number
+})
+
+// Option 2: Using the createBusinessClient helper function
+import {createBusinessClient} from 'db-vendo-client'
+import {profile as dbProfile} from 'db-vendo-client/p/db/index.js'
+
+const businessClient = createBusinessClient(dbProfile, userAgent, '1234567')
+// Now all journey searches will automatically include the BMIS number
+await businessClient.journeys(from, to)
+```
+
+When a BMIS number is provided, the request will include a `firmenZugehoerigkeit` object with the BMIS number and identification type, allowing business customers to access their special rates and conditions.
+
 ## The `routingMode` option
 
 The `routingMode` option is not supported by db-vendo-client. The behavior will be the same as the [`HYBRID` mode of hafas-client](https://github.com/public-transport/hafas-client/blob/main/p/db/readme.md#using-the-routingmode-option), i.e. cancelled trains/infeasible journeys will also be contained for informational purpose.

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,9 @@ 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,
+			bmisNumber: null, // 7-digit BMIS number for business customer rates
 		}, opt);
 
 		if (opt.when !== undefined) {
@@ -239,6 +242,9 @@ 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,
+			bmisNumber: null, // 7-digit BMIS number for business customer rates
 		}, opt);
 
 		const req = profile.formatRefreshJourneyReq({profile, opt}, refreshToken);
@@ -391,7 +397,33 @@ const createClient = (profile, userAgent, opt = {}) => {
 	return client;
 };
 
+const createBusinessClient = (profile, userAgent, bmisNumber, opt = {}) => {
+	if (!bmisNumber || typeof bmisNumber !== 'string') {
+		throw new TypeError('bmisNumber must be a non-empty string');
+	}
+
+	// Create a client with BMIS number included in all journey requests
+	const client = createClient(profile, userAgent, opt);
+
+	// Wrap journeys method to always include BMIS number
+	const originalJourneys = client.journeys;
+	client.journeys = async (from, to, opt = {}) => {
+		return originalJourneys(from, to, {...opt, bmisNumber});
+	};
+
+	// Wrap refreshJourney method to always include BMIS number
+	if (client.refreshJourney) {
+		const originalRefreshJourney = client.refreshJourney;
+		client.refreshJourney = async (refreshToken, opt = {}) => {
+			return originalRefreshJourney(refreshToken, {...opt, bmisNumber});
+		};
+	}
+
+	return client;
+};
+
 export {
 	createClient,
+	createBusinessClient,
 	loadEnrichedStationData,
 };

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/db/index.js

@@ -1,5 +1,4 @@
 import dbnavBase from '../dbnav/base.json' with { type: 'json' };
-import dbregioguideBase from '../dbregioguide/base.json' with { type: 'json' };
 import {products} from '../../lib/products.js';
 
 // journeys()
@@ -26,12 +25,11 @@ const {nearbyEndpoint} = dbnavBase;
 
 // trip()
 import {formatTripReq} from './trip-req.js';
-const tripEndpoint_dbnav = dbnavBase.tripEndpoint;
+const {tripEndpoint} = dbnavBase;
-const tripEndpoint_dbregioguide = dbregioguideBase.tripEndpoint;
 
 // arrivals(), departures()
-import {formatStationBoardReq} from '../dbregioguide/station-board-req.js';
+import {formatStationBoardReq} from '../dbnav/station-board-req.js';
-const {boardEndpoint} = dbregioguideBase;
+const {boardEndpoint} = dbnavBase;
 
 const profile = {
 	locale: 'de-DE',
@@ -55,7 +53,7 @@ const profile = {
 	nearbyEndpoint,
 
 	formatTripReq,
-	tripEndpoint_dbnav, tripEndpoint_dbregioguide,
+	tripEndpoint,
 
 	formatStationBoardReq,
 	boardEndpoint,

p/db/trip-req.js

@@ -1,16 +1,9 @@
 import {formatTripReq as hafasFormatTripReq} from '../dbnav/trip-req.js';
-import {formatTripReq as risTripReq} from '../dbregioguide/trip-req.js';
-
 
 const formatTripReq = ({profile, opt}, id) => {
 	const _profile = {...profile};
-	if (id.includes('#')) {
+	_profile['tripEndpoint'] = profile.tripEndpoint;
-		_profile['tripEndpoint'] = profile.tripEndpoint_dbnav;
+	return hafasFormatTripReq({profile: _profile, opt}, id);
-		return hafasFormatTripReq({profile: _profile, opt}, id);
-	}
-
-	_profile['tripEndpoint'] = profile.tripEndpoint_dbregioguide;
-	return risTripReq({profile: _profile, opt}, id);
 };
 
 export {

p/dbnav/journeys-req.js

@@ -4,11 +4,15 @@ const formatBaseJourneysReq = (ctx) => {
 	// TODO opt.accessibility
 	// TODO routingMode
 	const travellers = ctx.profile.formatTravellers(ctx);
-	return {
+	const baseReq = {
 		autonomeReservierung: false,
 		einstiegsTypList: [
 			'STANDARD',
 		],
+		fahrverguenstigungen: {
+			deutschlandTicketVorhanden: ctx.opt.deutschlandTicketDiscount,
+			nurDeutschlandTicketVerbindungen: ctx.opt.deutschlandTicketConnectionsOnly,
+		},
 		klasse: travellers.klasse,
 		reisendenProfil: {
 			reisende: travellers.reisende.map(t => {
@@ -23,6 +27,16 @@ const formatBaseJourneysReq = (ctx) => {
 		},
 		reservierungsKontingenteVorhanden: false,
 	};
+
+	// Add business customer affiliation if BMIS number is provided
+	if (ctx.opt.bmisNumber) {
+		baseReq.firmenZugehoerigkeit = {
+			bmisNr: ctx.opt.bmisNumber,
+			identifikationsart: 'BMIS',
+		};
+	}
+
+	return baseReq;
 };
 
 const formatJourneysReq = (ctx, from, to, when, outFrwd, journeysRef) => {

p/dbregioguide/index.js

@@ -15,7 +15,7 @@ const profile = {
 	journeysOutFrwd: false,
 	departuresGetPasslist: false,
 	departuresStbFltrEquiv: true,
-	trip: false,
+	trip: true,
 	radar: false,
 	refreshJourney: false,
 	journeysFromTrip: false,

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.10.0",
 	"lockfileVersion": 3,
 	"requires": true,
 	"packages": {
 		"": {
 			"name": "db-vendo-client",
-			"version": "6.8.0",
+			"version": "6.10.0",
 			"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.10.0",
 	"type": "module",
 	"main": "index.js",
 	"files": [

readme.md

@@ -27,21 +27,21 @@ Depending on the configured profile, db-vendo-client will use multiple different
 | -------------         | -------------     | ------------- | ------------- | ------------- | ------------- |
 | no API key required   | ✅                | ✅ |  ✅ | ✅ | ❌ |
 | all above endpoints supported | ✅              | ✅ | except `stop()` | only boards | only boards |
-| duration for boards   | up to 12h         | always 1h | always 1h | up to 6h, only from current time | up to 12h |
+| duration for boards   | always 1h         | always 1h | always 1h | up to 6h, only from current time | up to 12h |
-| remarks               | not for boards    | for boards only most important remarks | all remarks on boards and journeys | most remarks | all  remarks |
+| remarks               | for boards only most important remarks    | for boards only most important remarks | all remarks on boards and journeys | most remarks | all  remarks |
-| cancelled trips       | contained with cancelled flag in journeys, not contained in boards | contained with cancelled flag | contained with cancelled flag | contained with cancelled flag | contained with cancelled flag |
+| cancelled trips       | contained with cancelled flag | contained with cancelled flag | contained with cancelled flag | contained with cancelled flag | contained with cancelled flag |
 | tickets               | only for `refreshJourney()`, mutually exclusive with polylines | only for `refreshJourney()`, mutually exclusive with polylines | only for `refreshJourney()`, mutually exclusive with polylines | ❌ | ❌ |
-| polylines             | only for `refreshJourney()` (mutually exclusive with tickets) and for `trip()` (only for HAFAS trip ids) | only for `refreshJourney()/trip()`, mutually exclusive with tickets | only for `refreshJourney()/trip()`, mutually exclusive with tickets | ❌ | ❌ |
+| polylines             | only for `refreshJourney()/trip()`, mutually exclusive with tickets | only for `refreshJourney()/trip()`, mutually exclusive with tickets | only for `refreshJourney()/trip()`, mutually exclusive with tickets | ❌ | ❌ |
-| trip ids used         | HAFAS trip ids for journeys, RIS trip ids for boards (static on train splits?) | HAFAS trip ids | HAFAS trip ids | RIS trip ids | RIS trip ids | 
+| trip ids used         | HAFAS trip ids | HAFAS trip ids | HAFAS trip ids | RIS trip ids | RIS trip ids | 
-| line.id/fahrtNr used  | actual fahrtNr | actual fahrtNr for journeys, unreliable/route id for boards and `trip()` | unreliable/route id | unreliable/route id | ✅ |
+| line.id/fahrtNr used  | actual fahrtNr for journeys, unreliable/route id for boards and `trip()` | actual fahrtNr for journeys, unreliable/route id for boards and `trip()` | unreliable/route id | unreliable/route id | ✅ |
-| adminCode/operator    | ✅ | only for journeys | only operator | only adminCode | ✅ |
+| adminCode/operator    | only for journeys | only for journeys | only operator | only adminCode | ✅ |
 | stopovers             | not in boards | not in boards | ✅ | some | ✅ |
 | assumed backend API stability | less stable | more stable | less stable | less stable | more stable |
-| quotas | 60 requests per minute for journeys, unknown for boards (IPv4) | 60 requests per minute (IPv4) | aggressive blocking (IPv4/IPv6) | ? | depends on API key |
+| quotas | 60 requests per minute (IPv4) | 60 requests per minute (IPv4) | aggressive blocking (IPv4/IPv6) | ? | depends on API key |
 
 
 > [!IMPORTANT]
-> If you think that for your project, quotas may become an issue, [consider alternative ways to obtain the data you need.](https://github.com/derhuerst/db-rest/blob/6/docs/readme.md#why-not-to-use-this-api).
+> If you think that for your project, quotas may become an issue, [consider alternative ways to obtain the data you need.](https://github.com/derhuerst/db-rest/blob/6/docs/readme.md#why-not-to-use-this-api), e.g. [motis-fptf-client](https://github.com/motis-project/motis-fptf-client) (a drop-in replacement for db-vendo-client/hafas-client) in conjunction with https://transitous.org or a self-hosted [MOTIS](https://github.com/motis-project/motis) instance.
 
 Feel free to report anything that you stumble upon via Issues or create a PR :)
 
@@ -92,6 +92,7 @@ There are [community-maintained TypeScript typings available as `@types/hafas-cl
 - [hafas-client](https://github.com/public-transport/hafas-client/) – including further related projects
 - [hafas-rest-api](https://github.com/public-transport/hafas-rest-api/) – expose a hafas-client or db-vendo-client instance as a REST API
 - [db-rest](https://github.com/derhuerst/db-rest/) – for the legacy DB HAFAS endpoint
+- [motis-fptf-client](https://github.com/motis-project/motis-fptf-client) – a drop-in replacement for db-vendo-client/hafas-client wrapping a [MOTIS](https://github.com/motis-project/motis) instance
 - [`*.transport.rest`](https://transport.rest/) – Public APIs wrapping some HAFAS endpoints.
 
 ## Contributing

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/db-trip.js

@@ -38,10 +38,10 @@ tap.test('db trip(): dynamic request formatting', (t) => {
 
 	const reqDbNav = profile.formatTripReq(ctx, tripIdHafas);
 	delete reqDbNav.headers['X-Correlation-ID'];
-	const reqDbRegioGuide = profile.formatTripReq(ctx, tripIdRis);
+	// const reqDbRegioGuide = profile.formatTripReq(ctx, tripIdRis);
 
 	t.same(reqDbNav, reqDbNavExpected);
-	t.same(reqDbRegioGuide, reqDbRegioGuideExpected);
+	// t.same(reqDbRegioGuide, reqDbRegioGuideExpected);
 
 	t.end();
 });

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,