fix(deps): update entur packages (major)

[renovate]

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
@entur/form	3.4.7 -> 7.1.10
@entur/icons	1.20.0 -> 6.17.1
@entur/sdk	1.11.1 -> 5.3.0

---

Release Notes

entur/sdk (@​entur/sdk)

v5.3.0

Compare Source

added missing vehicleType field in getVehicles

v5.2.2

Compare Source

v5.2.1

Compare Source

• Add pricePlan to mobility graphql query for Vehicle #​262

v5.2.0

Compare Source

• We've updated the JourneyPlannerTypes #​260
• We've updated dependencies

v5.1.0

Compare Source

• We've updated the JourneyPlannerTypes #​259
  • Some types that were erroneously nullable are now non-nullable
• We've updated dependencies #​258

v5.0.0

Compare Source

💥 Breaking

• Deprecated method getStopPlaceFacilities is removed. (#​247) use getStopPlace from the NsrClient instead: https://sdk.entur.org/interfaces/NsrClient.html
• Deprecated method getScootersByPosition and friends are removed (#​243). Use getVehicles from the MobilityClient instead: https://sdk.entur.org/interfaces/MobilityClient.html

👋 Deprecations

The times they are a-changing! With this release, we have deprecated all of the methods and types related to the deprecated JourneyPlanner v1 API. #​257 That's most of this SDK!

We encourage all users to migrate to the next version of the API, JourneyPlanner v3. We will not migrate the the existing methods of this SDK to v3. Instead, we recommend you to write your own, tailor-made queries and use your GraphQL library of choice, like Apollo. This way, you can leverage the full power of GraphQL and get optimized requests and responses.

You can still use our generated JourneyPlannerTypes for usage with TypeScript, or even generate your own response types using a generator like GraphQL Code Generator. That's the one we're using to make JourneyPlannerTypes.

🔧 Docs and Maintenance

We've swapped Docz with TypeDoc (#​252) and released a brand new documentation website: https://sdk.entur.org. Now we generate the documentation based on our TypeScript types and TSDoc comments. This way our documentation will be more correct and any documentation we write will also be available in your editor through your TypeScript plugin.

v4.4.0

Compare Source

We now expose generated TypeScript client types for JourneyPlanner v3. You can use these to type your responses from custom GraphQL queries against JourneyPlanner v3.

import { JourneyPlannerTypes } from '@​entur/sdk'

v4.3.0

Compare Source

This one adds vehicleTypesAvailable to Station. #​240

Use this to know which vehicle types are serviced by a station.

v4.2.2

Compare Source

Include repository details in package.json. #​239

Having this available provides a number of benefits to security tooling. For example, it allows for greater trust by checking for signed commits, contributors to a release and validating history with the project. It also allows for comparison between the source code and the published artifact in order to detect attacks on authors during the publication process.

v4.2.1

Compare Source

The type of focus.scale was incorrectly set to string, but should be number. This is now fixed. (#​238)

v4.2.0

Compare Source

getStationsById

getStationsById is a new method for getting station info based on a list of IDs. (#​236 thanks @​bendiksk)

While getStations is good for finding all stations within a certain area, getStationsById works in the case where you have a set of IDs beforehand, which you want to get updated data about.

v4.1.1

Compare Source

This release fixes the crashing geocoder.reverse method and adds some validation of its mandatory point parameter. #​234

v4.1.0

Compare Source

GeocoderClient

A new GeocoderClient implementation is here: #​232.

The new geocoder methods (autocomplete and reverse) will replace the getFeatures and getFeaturesReverse methods. The new methods have the following benefits:

• Naming of methods and parameters are much closer to those of the API (https://developer.entur.org/pages-geocoder-api)
• Proper GeoJSON types are used (from @types/geojson), improving compatibility with other GeoJSON-based libraries.
• The TSDoc documentation is significantly better, giving better intellisense in editors.

If you are using getFeatures and/or getFeaturesReverse you should consider migrating to the new geocoder methods. getFeatures and getFeaturesReverse will be deprecated in a future minor version, and therefore also removed in a future major versjon.

EnturService -> EnturClient

We have been using the term EnturService, createEnturService in our docs and code. This is now EnturClient and createEnturClient. #​233

v4.0.0

Compare Source

Breaking Changes 💥

• Removed deprecated modes and related utils (isRail, isBus, etc.) #​229
• Removed deprecated methods journeyPlannerQuery and nsrQuery #​230
• Removed types for deprecated boundary params for geocoder #​231

v3.8.0

Compare Source

Deprecated getStopPlaceFacilities #​228

Use the NSR methods you need instead, like getStopPlace and getParkingsForStopPlace.

v3.7.0

Compare Source

Implemented methods for the NSR Read API #​224

You will find documentation under the "NSR" menu: https://sdk.entur.org/nsr/getFareZone

If you are using getStopPlaceFacilities you should consider replacing it with the new nsr methods, as it will get deprecated in an upcoming version.

v3.6.2

Compare Source

Improvements

Ability to set custom headers in API requests

v3.6.1

Compare Source

Improvements

Vehicles from the mobility API will now include the field "rentalApps".
The field include links to operator's applications on different platforms such as iOS and Android.

v3.6.0

Compare Source

New Features

Mobility v2

Support for the new Mobility v2 API is added, with the following three methods:

• getVehicles
• getOperators
• getStations

Improvements

LIFT mode is now one of the default search modes https://github.com/entur/sdk/pull/219

Deprecations

Situation.lines is deprecated, and its TypeScript type made optional (although you will always get an array). https://github.com/entur/sdk/pull/217. If you rely on this information on situations, you should use the JourneyPlanner API directly.

The getScootersByPosition method is effectively deprecated as the Scooters API is deprecated. You should use the new Mobility v2 methods (introduced in this version) instead.

v3.5.0

Compare Source

• Added bookingArrangements fields to Leg
• Deprecated bookingArrangements in Line and EstimatedCalls.

v3.4.0

Compare Source

• New: Adds focus params to getFeature (#​204) - thanks @​mikaelbr
• Internal: Format all docs files with Prettier

v3.3.0

Compare Source

Updated BookingArrangements fields, and added the fields to serviceJourney and estimatedCalls.

BookingAccess-type was converted from boolean to enum. May be breaking change, but the field was never queried.

v3.2.0

Compare Source

All request functions takes fetch options as last argument. Currently only AbortSignal is supported

v3.1.0

Compare Source

• ⚡ A new Scooter operator has been added to the list of operators: Bolt.
• 🛴 A new Scooter interface is now also exported: StandardScooter. This interface is similar to the two existing ones, but without any battery information (it has neither a battery nor batteryLevel field). It is currently only used by the new operator: Bolt.

v3.0.1

Compare Source

BatteryScooter and BatteryLevelScooter interfaces are now exported.

v3.0.0

Compare Source

💥 Breaking Changes

New Mode enums #​188

Will likely change how you are using the LegMode, QueryMode and TransportMode types if you're using TypeScript. These mode types are now enums instead of union types. This might make them slightly harder to use in some cases, as TypeScript says QueryMode.BUS !== LegMode.BUS, although they are actually the same string "bus". But the good thing about this is that it forces you have a better understanding of what the different mode types mean, which will likely mean you're not using QueryMode for everything or using LegMode where you should be using TransportMode, and so on.

• LegMode: The modes that a Leg can have in the result from findTrips, getTripPatterns
• QueryMode: The values accepted for the modes parameter of getTripPatterns
• TransportMode: Transit modes that can appear on departures (bus, rail, metro, ...)

Removed situations from EstimatedCall query #​194

This field was deprecated in v2.1.0. Removing it is breaking, but will significantly reduce network payloads for getTripPatterns.

Deleted deprecated Category type

Use FeatureCategory instead.

Deleted libdef.flow.js #​195

The Flow types were deprecated in v2 and including them in the repo now will be misleading. Flow definitions for versions < 3 can be found in the flow-typed repo: https://github.com/flow-typed/flow-typed/tree/master/definitions/npm/%40entur

Deprecations

• Individual exports of mode constants are deprecated. Use enums instead. (#​188)
• Mode checker functions (isRail, isBus, ...) are deprecated. Write your own if needed. (#​188)

🔧 Improvements

Auto-generated libdef #​189

Hopefully non-breaking, but some types might be exported a slightly different way.

v2.1.1

Compare Source

tariff_zones is now added to the Feature.properties type. Thanks @​torfjor #​197

v2.1.0

Compare Source

Deprecated: startTime and endTime on TripPattern #​184

Use expectedStartTime and expectedEndTime instead.

getDeparturesBetweenStopPlaces performance boost #​190

The query for getDeparturesBetweenStopPlaces asked for many fields on Leg that weren't used. The legToDepartureMapper function only took a certain set of fields from Leg and turned it into a Departure. With this change, only the fields used by the mapper are requested. This will lead to smaller network payloads and hopefully slightly faster calls.

Separated EstimatedCall and Departure types #​186

Departure has been an alias for EstimatedCall, but now they mean different things and got a slight difference in the situation field.

The problem is that the same data is requested for an EstimatedCall on the trip calls (getTripPatterns) as for the departure calls (getDeparturesXxx methods). One rarily needs this much data on a trip call, which leads to unnecessarily big payloads for getTripPatterns.

One example is that situations is being aggregated on the Leg level, and therefore also requesting situations per fromEstimatedCall, toEstimatedCall and intermediateEstimatedCalls is unlikely to be very useful.

Removing situations from EstimatedCall is a breaking change which requires a major version bump. In this version, EstimatedCall.situation is simply deprecated. We will remove it, probably already in the next major version.

EstimatedCall.situations is set to be optional in the TypeScript declaration, although it will still always be returned as an array. You might have to make some code changes to satisfy TypeScript. This is arguably a breaking type change, but we want to give you an extra heads-up that this field is deprecated.

Migrating away from EstimatedCall.situations

In most cases using Leg.situations should be sufficient. These will also consider the validity period of the situations.
If you need more details about specific departures, you should check out the getDeparturesXxx methods.

v2.0.0

Compare Source

Breaking Changes 💥

This release removes a deprecated query field and some deprecated constants.

detail is removed, use advice instead #​181

The field detail on Situations is now removed. Migration is simple: Replace your usage of situation.detail with situation.advice:

-const info = mySituation.detail
+const info = mySituation.advice

FeatureCategory constants are removed, use enum instead #​182

We have exported feature category constants both as individual constants and as an object/enum. Now the individual exports are gone. Please use the FeatureCategory enum instead:

-import { ONSTREET_BUS } from '@​entur/sdk'
+import { FeatureCategory } from '@​entur/sdk'

-console.log(ONSTREET_BUS)
+console.log(FeatureCategory.ONSTREET_BUS)

Flow Definitions are now Deprecated 👋

We will no longer update libdef.flow.js. Instead, we will move it to the flow-typed repo: https://github.com/flow-typed/flow-typed/pull/3945. libdef.flow.js will be removed in a future major version.

---

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.

---

• If you want to rebase/retry this PR, check this box

---

This PR has been generated by Mend Renovate. View repository job log here.

[github-actions]

Visit the preview URL for this PR (updated for commit 15a7b22):

https://ent-shamash-dev--pr120-renovate-major-entur-j17s6dw9.web.app

_{(expires Wed, 05 Jun 2024 11:19:42 GMT)}

_{🔥 via Firebase Hosting GitHub Action 🌎}

_{Sign: 500c97a3b6e3042f8d1f2786e215b2cda18eccce}

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud