gtfs-realtime-bindings 1.1.0 → 2.0.0

package/Dockerfile

@@ -1,4 +1,4 @@
-FROM node:18.12.1-alpine
+FROM node:22-alpine
 
 WORKDIR /lib
 COPY nodejs/package.json /lib/package.json

package/README.md

@@ -11,9 +11,15 @@ These bindings are designed to be used in the [Node.js](http://nodejs.org/)
 environment, but with some effort, they can probably be used in other
 JavaScript environments as well.
 
-We use the [ProtoBuf.js](https://github.com/dcodeIO/ProtoBuf.js) library for
+We use the [ProtoBuf.js](https://github.com/protobufjs/protobuf.js) library for
 JavaScript Protocol Buffer support.
 
+## Breaking Changes
+
+### Version 2.0.0
+
+Version 2.0.0 requires **Node.js 22 or later**. If you are using an older version of Node.js, please continue using version `1.x`.
+
 ## Add the Dependency
 
 To use the `gtfs-realtime-bindings` classes in your own project, you need to
@@ -48,9 +54,9 @@ import fetch from "node-fetch";
         // e.g. x-api-key is the header value used for NY's MTA GTFS APIs
       },
     });
-    if (!res.ok) {
-      const error = new Error(`${res.url}: ${res.status} ${res.statusText}`);
-      error.response = res;
+    if (!response.ok) {
+      const error = new Error(`${response.url}: ${response.status} ${response.statusText}`);
+      error.response = response;
       throw error;
       process.exit(1);
     }
@@ -74,5 +80,5 @@ import fetch from "node-fetch";
 For more details on the naming conventions for the JavaScript classes generated
 from the
 [gtfs-realtime.proto](https://github.com/google/transit/blob/master/gtfs-realtime/proto/gtfs-realtime.proto),
-check out the [ProtoBuf.js project](https://github.com/dcodeIO/ProtoBuf.js/wiki)
+check out the [ProtoBuf.js project](https://github.com/protobufjs/protobuf.js)
 which we use to handle our Protocol Buffer serialization.

package/UPDATING.md

@@ -4,50 +4,46 @@
 
 #### One-Time Setup
 
-1. Download and install [Docker](https://docs.docker.com/get-docker/)
+1. Download and install [Node.js](https://nodejs.org/) >= 22 (see `engines` in `package.json`).
 
 #### Every time node package dependencies change
 
-1. Download and install [Node.js](https://www.npmjs.com/get-npm) (check the `package.json` for `engines` version).
+1. Edit the dependency versions using `npm install` and/or `npm remove` inside the `nodejs/` folder.
 
-1. Edit the dependency versions in using `npm install` and/or `npm remove`.
-
-1. Re-generate the code by following instructions below.
+1. Re-generate the code by following the instructions below.
 
 #### Re-generating the code
 
-1. Run the following from the project root folder:
+1. Install dependencies from the `nodejs/` folder:
 
     ```
-    docker build -t gtfs-nodejs -f nodejs/Dockerfile .
-    # -it to make sure docker run can be killed with ctrl-c
-    # -t uses TTY, which causes linux to include carriage returns, which are stripped using tr
-    docker run -it --rm gtfs-nodejs cat /lib/gtfs-realtime.js | tr -d '\r' > nodejs/gtfs-realtime.js
-    docker run -it --rm gtfs-nodejs cat /lib/gtfs-realtime.d.ts | tr -d '\r' > nodejs/gtfs-realtime.d.ts
+    cd nodejs
+    npm ci
     ```
 
-1. Add the license header back to the generated source file.
+1. Re-generate the JS bindings and TypeScript types from the root of the project:
+
+    ```
+    npm run buildProto
+    ```
 
 1. Test the generated code:
 
     ```
-    npm run test
+    npm test
     ```
 
 1. Update the version number in `package.json`.
 
 ## Publishing a new release
 
-#### Every release
+Releases are published to npm automatically via GitHub Actions when a change to the `nodejs/` folder
+is merged into `master`, provided the version in `package.json` has been bumped.
 
-Log in with your account on NPM that has permissions for https://www.npmjs.com/package/gtfs-realtime-bindings:
+To publish manually (e.g. for testing), log in with an npm account that has permissions for
+https://www.npmjs.com/package/gtfs-realtime-bindings and run from the `nodejs/` folder:
 
 ```
 npm login
-```
-
-Publish the package to NPM:
-
-```
 npm publish
 ```