chore(deps): lock file maintenance

Bumps [express](https://github.com/expressjs/express) from 4.18.2 to 4.19.2.
- [Release notes](https://github.com/expressjs/express/releases)
- [Changelog](https://github.com/expressjs/express/blob/master/History.md)
- [Commits](https://github.com/expressjs/express/compare/4.18.2...4.19.2)

---
updated-dependencies:
- dependency-name: express
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

.github/renovate.json

@@ -0,0 +1,13 @@
+{
+    "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+    "extends": [
+        "config:recommended"
+    ],
+    "configMigration": true,
+    "lockFileMaintenance": {
+        "enabled": true,
+        "automerge": true,
+        "automergeType": "branch",
+        "ignoreTests": true
+    }
+}

.github/workflows/docker-image.yml

@@ -6,18 +6,7 @@ on:
 jobs:
   lint-test:
     name: lint, build & test
-    runs-on: ubuntu-latest
+    uses: './.github/workflows/lint-test.yml'
-    steps:
-    - name: checkout
-      uses: actions/checkout@v3
-    - name: setup Node
-      uses: actions/setup-node@v3
-      with:
-        node-version: 18.x
-    - run: npm install
-    - run: npm run lint
-    - run: npm run build
-    - run: npm test
 
   build-and-publish:
     name: build & publish Docker image
@@ -25,11 +14,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: check out the repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+      - name: set up QEMU
+        uses: docker/setup-qemu-action@v3
       - name: configure Docker to use buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
       - name: log in to Docker Hub
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKER_ACCESS_TOKEN }}
@@ -38,6 +29,7 @@ jobs:
         with:
           context: .
           push: true
+          platforms: linux/amd64,linux/arm64
           tags: |
             derhuerst/db-rest:6
             derhuerst/db-rest:latest
@@ -47,7 +39,7 @@ jobs:
 
       # this is for the public-transport/infrastructure cluster
       - name: log in to GitHub Container Registry
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           registry: ghcr.io
           username: ${{ github.repository_owner }}
@@ -63,7 +55,10 @@ jobs:
         with:
           context: .
           push: true
-          tags: ghcr.io/${{github.repository}}:v6_${{steps.hash.outputs.hash}}_${{steps.datetime.outputs.datetime}}
+          platforms: linux/amd64,linux/arm64
+          tags: |
+            ghcr.io/${{github.repository}}:v6
+            ghcr.io/${{github.repository}}:v6_${{steps.hash.outputs.hash}}_${{steps.datetime.outputs.datetime}}
           # https://docs.docker.com/build/ci/github-actions/examples/#github-cache
           cache-from: type=gha
           cache-to: type=gha,mode=max,oci-mediatypes=true,compression=zstd

.github/workflows/lint-test.yml

@@ -0,0 +1,35 @@
+name: lint, build & test
+on:
+  push:
+    branches:
+      - '*'
+  pull_request:
+    branches:
+      - '*'
+  workflow_call:
+
+jobs:
+  lint-test:
+    name: lint, build & test
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version:
+          - '16.x'
+          - '18.x'
+          - '20.x'
+          - '22.x'
+
+    steps:
+    - name: checkout
+      uses: actions/checkout@v4
+    - name: setup Node
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+
+    - run: npm ci
+
+    - run: npm run lint
+    - run: npm run build
+    - run: npm test

.gitignore

@@ -5,7 +5,6 @@ Thumbs.db
 node_modules
 npm-debug.log
 
-/package-lock.json
 /dump.rdb
 
 /docs/*.html

Dockerfile

@@ -3,8 +3,8 @@ WORKDIR /app
 
 # install dependencies
 RUN apk add --update git bash
-ADD package.json /app
+ADD package.json package-lock.json /app
-RUN npm install
+RUN npm ci
 
 # build documentation
 ADD . /app

build/api-docs.js

@@ -61,7 +61,7 @@ Uses [\`hafasClient.journeys()\`](https://github.com/public-transport/hafas-clie
 \`from\` (A), \`to\` (B), and the optional \`via\` must each have one of these formats:
 
 - as stop/station ID (e.g. \`from=8010159\` for *Halle (Saale) Hbf*)
-- as a POI (e.g. \`from.id=991561765&from.latitude=51.48364&from.longitude=11.98084\` for *Halle+(Saale),+Stadtpark+Halle+(Grünanlagen)*)
+- as a POI (e.g. \`from.id=991561765&from.latitude=51.48364&from.longitude=11.98084&from.name=Halle+(Saale),+Stadtpark+Halle+(Grünanlagen)\` for *Halle (Saale), Stadtpark Halle (Grünanlagen)*)
 - as an address (e.g. \`from.latitude=51.25639&from.longitude=7.46685&from.address=Hansestadt+Breckerfeld,+Hansering+3\` for *Hansestadt Breckerfeld, Hansering 3*)
 
 ### Pagination

docs/readme.md

@@ -4,17 +4,21 @@
 
 [![API status](https://badgen.net/uptime-robot/status/m793274556-25c5e9bbab0297d91cda7134)](https://stats.uptimerobot.com/57wNLs39M/793274556)
 
-Because it wraps [an API](https://github.com/public-transport/hafas-client/blob/6/readme.md#background) of [Deutsche Bahn](https://de.wikipedia.org/wiki/Deutsche_Bahn), it **includes most of the long-distance and regional traffic, as well as some international trains and local buses**. Essentially, it returns whatever data the [*DB Navigator* app](https://www.bahn.de/p/view/service/mobile/db-navigator.shtml) shows, **including realtime delays and disruptions**.
+Because it wraps [an API](https://github.com/public-transport/hafas-client/blob/6/readme.md#background) of [Deutsche Bahn](https://de.wikipedia.org/wiki/Deutsche_Bahn), it **includes most of the long-distance and regional traffic, as well as some international trains and local buses**. Essentially, it returns whatever data the [*DB Navigator* app](https://www.bahn.de/p/view/service/mobile/db-navigator.shtml) shows*, **including realtime delays and disruptions**.
+
+*When comparing results from this API to what the DB Navigator app shows there might be occasional differences due to them utilizing different, not 100% identical backends.*
 
 - [Getting Started](getting-started.md)
-- [API documentation](api.md)
+- [API documentation](api.md) (run `npm run build` to generate)
-- [OpenAPI playground](https://petstore.swagger.io/?url=https%3A%2F%2Fv6.db.transport.rest%2F.well-known%2Fservice-desc%0A)
+- [OpenAPI playground with API documentation](https://petstore.swagger.io/?url=https%3A%2F%2Fv6.db.transport.rest%2F.well-known%2Fservice-desc%0A)
 
 ## Why use this API?
 
 ### Realtime Data
 
-This API returns realtime data whenever its upstream, the [API for DB's mobile app](https://github.com/public-transport/hafas-client/blob/6/p/db/readme.md), provides it.
+This API returns realtime data whenever it is upstream. The [API for DB's mobile app](https://github.com/public-transport/hafas-client/blob/6/p/db/readme.md) provides it.
+
+*Note: Different endpoints might remove realtime data like delays and cancellations at different times, i.e. after a journey's arrival.*
 
 ### No API Key
 

license.md

@@ -1,4 +1,4 @@
-Copyright (c) 2022, Jannis R
+Copyright (c) 2024, Jannis R
 
 Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
 

package.json

@@ -2,9 +2,19 @@
 	"private": true,
 	"name": "db-rest",
 	"description": "A clean REST API wrapping around the Deutsche Bahn API.",
-	"version": "6.0.1",
+	"version": "6.0.5",
 	"type": "module",
+	"bin": {
+		"db-rest": "./index.js"
+	},
 	"main": "index.js",
+	"files": [
+		"docs",
+		"lib",
+		"routes",
+		"api.js",
+		"index.js"
+	],
 	"author": "Jannis R <mail@jannisr.de>",
 	"homepage": "https://github.com/derhuerst/db-rest/tree/6",
 	"repository": "derhuerst/db-rest",
@@ -37,12 +47,12 @@
 	},
 	"devDependencies": {
 		"@derhuerst/technical-docs-cli": "^1.5.0",
-		"axios": "~1.1",
+		"axios": "^1.6.1",
 		"eslint": "^8.12.0",
 		"get-port": "^6.1.2",
 		"ndjson": "^2.0.0",
 		"pino-pretty": "^9.1.1",
-		"tap-min": "^2.0.0",
+		"tap-min": "^3.0.0",
 		"tape": "^5.5.2"
 	},
 	"scripts": {

readme.md

@@ -15,14 +15,16 @@
 
 ## installing & running
 
-`db-rest` expects a [Redis](https://redis.io/) server running on `127.0.0.1:6379` (default port), but you can set the `REDIS_URL` environment variable to change this.
+### access to Redis
+
+It is recommended that you let `bvg-rest` cache HAFAS responses within a [Redis](https://redis.io/) cache. To use this feature, set `$REDIS_URL` (e.g. to `redis://localhost:6379/1` when running Redis locally).
 
 ### via Docker
 
-A Docker image [is available as `derhuerst/db-rest:6`](https://hub.docker.com/r/derhuerst/db-rest:6).
+A Docker image [is available as `docker.io/derhuerst/db-rest:6`](https://hub.docker.com/r/docker.io/derhuerst/db-rest:6).
 
 ```shell
-docker run -d -p 3000:3000 derhuerst/db-rest:6
+docker run -d -p 3000:3000 docker.io/derhuerst/db-rest:6
 ```
 
 *Note:* The Docker image does not contain the Redis server.
@@ -47,6 +49,7 @@ To keep the API running permanently, use tools like [`forever`](https://github.c
 
 ## Related Projects
 
+- [`DB-Adapter-v6`](https://github.com/olech2412/DB-Adapter-v6) – A Java API client for `db-rest`.
 - [`vbb-rest`](https://github.com/derhuerst/vbb-rest) – A clean REST API wrapping around the VBB API.
 - [`bvg-rest`](https://github.com/derhuerst/bvg-rest) – A clean REST API wrapping around the BVG API.
 - [`hvv-rest`](https://github.com/derhuerst/hvv-rest) – A clean REST API wrapping around the HVV API.