clean up the API

[derhuerst]

• remove departure.trip & movement.trip – They have a confusing name and may not even be the trip nr all the time. – 1269773
• split departure.line into dep.trip & dep.trip.line – dep.line.id/arr.line.id & dep.line.fahrtNr/arr.line.fahrtNr don't make sense. id (as it currently is) and fahrtNr are properties of the trip/vehicle, not the line.
• addresses have an ID too – find a way to differentiate them from POIs – addresses have an ID too – find a way to differentiate them from POIs #42
• rename journey.refreshToken to journey.id

[derhuerst]

• leg.mode = 'walking' implies that leg.mode always contains the mode of the line of the leg, but it doesn't. – 02c95ff

[derhuerst]

• rename leg.id to leg.tripId – 8e0b334

[derhuerst]

• remove or rename line.productCode – 8dd4ef5
• remove or rename line.class – 8dd4ef5

[derhuerst]

• rename station(id) to stop(id) – 94fb64d

[derhuerst]

• parseFormat/formatDate/formatTime: (profile, ...) => {} -> (profile) => (...) => {}

  • hafas-client/format/time.js

    Line 7 in 129caa7

    // todo: change to `(profile) => (when) => {}`

  • hafas-client/parse/date-time.js

    Line 7 in 129caa7

    // todo: change to `(profile) => (date, time) => {}`

  • hafas-client/format/date.js

    Line 7 in 129caa7

    // todo: change to `(profile) => (when) => {}`

[derhuerst]

• remove profile.journeysNumF (51f4a66) – ÖBB needs it.

  • hafas-client/index.js

    Lines 172 to 177 in 129caa7

    	// With protocol version `1.16`, the VBB endpoint fails with
    	// `CGI_READ_FAILED` if you pass `numF`, the parameter for the number
    	// of results. To circumvent this, we loop here, collecting journeys
    	// until we have enough.
    	// see https://github.com/public-transport/hafas-client/pull/23#issuecomment-370246163
    	// todo: check if `numF` is supported again, revert this change

  • hafas-client/index.js

    Line 225 in 129caa7

    if (journeys.length >= opt.results) { // collected enough

[derhuerst]

• profiles: rename nationalExp -> nationalExpress – c13138c

[derhuerst]

• formerScheduled{Arrival|Departure}Platform -> scheduled{Arrival|Departure}Platform – 969c045

[derhuerst]

• movement.nextStops -> movement.nextStopovers – b4d763f

[derhuerst]

• remove movement.trip movement.trip -> movement.fahrtNr – 1269773

[derhuerst]

• leg.mode (from FPTF) vs leg.line.mode
• leg.public (from FPTF) vs leg.line.public
• leg.operator (from FPTF) vs leg.line.operator

[derhuerst]

• locations: rename opt.stations to opt.stops

[derhuerst]

• rename profile.formatStation/profile.parseStation -> profile.formatStop/profile.parseStop

[derhuerst]

• rename opt.stationLines -> opt.linesOfStops

[derhuerst]

• trip.line.fahrtNr -> trip.fahrtNr, leg.line.fahrtNr -> leg.fahrtNr
• add trip.name to differentiate it from trip.line.name

[derhuerst]

• movement.location -> movement.position

[derhuerst]

• move profile = {...defaultProfile, ...profile} from index.js/throttle.js/retry.js to p/*/index.js

[derhuerst]

• hafas-client/parse/warning.js

  Line 17 in d2bca32

  // todo: rename `Loc` -> `Location` [breaking]

• hafas-client/parse/warning.js

  Line 25 in d2bca32

  // todo: rename `Loc` -> `Location` [breaking]

[derhuerst]

• sometimes, line.fahrtNr is actually more of a route ID #194

[derhuerst]

• parsePolyline: return LineString instead of FeatureCollection #217