@tmlmobilidade/gtfs-rt 20260216.1651.10

package/dist/decode.d.ts

@@ -0,0 +1,7 @@
+import { type GtfsRtFeedMessage } from '@tmlmobilidade/types';
+/**
+ * Decodes a GTFS-RT feed from an ArrayBuffer or Buffer.
+ * @param buffer The GTFS-RT feed as an ArrayBuffer or Buffer.
+ * @returns The decoded GTFS-RT feed as a JavaScript object.
+ */
+export declare function decodeGtfsRtFeed(buffer: ArrayBuffer | Buffer): Promise<GtfsRtFeedMessage>;

package/dist/decode.js

@@ -0,0 +1,26 @@
+/* * */
+import { initProto } from './init-proto.js';
+/**
+ * Decodes a GTFS-RT feed from an ArrayBuffer or Buffer.
+ * @param buffer The GTFS-RT feed as an ArrayBuffer or Buffer.
+ * @returns The decoded GTFS-RT feed as a JavaScript object.
+ */
+export async function decodeGtfsRtFeed(buffer) {
+    //
+    //
+    // Initialize the protobufjs root
+    // with the GTFS-RT .proto file
+    const protoRoot = await initProto();
+    //
+    // Check if the buffer is an ArrayBuffer
+    // and convert it to a Node.js Buffer if necessary
+    if (buffer instanceof ArrayBuffer) {
+        buffer = Buffer.from(buffer);
+    }
+    //
+    // Decode the GTFS-RT feed using the protobufjs root
+    const feedMessageType = protoRoot.lookupType('transit_realtime.FeedMessage');
+    const message = feedMessageType.decode(buffer);
+    return feedMessageType.toObject(message);
+    //
+}

package/dist/encode.d.ts

@@ -0,0 +1,7 @@
+import { type GtfsRtFeedMessage } from '@tmlmobilidade/types';
+/**
+ * Encodes a GTFS-RT feed into an ArrayBuffer.
+ * @param feedMessage The GTFS-RT feed as a JavaScript object.
+ * @returns The encoded GTFS-RT feed as an ArrayBuffer.
+ */
+export declare function encodeGtfsRtFeed(feedMessage: GtfsRtFeedMessage): Promise<Uint8Array<ArrayBufferLike>>;

package/dist/encode.js

@@ -0,0 +1,20 @@
+/* * */
+import { initProto } from './init-proto.js';
+/**
+ * Encodes a GTFS-RT feed into an ArrayBuffer.
+ * @param feedMessage The GTFS-RT feed as a JavaScript object.
+ * @returns The encoded GTFS-RT feed as an ArrayBuffer.
+ */
+export async function encodeGtfsRtFeed(feedMessage) {
+    //
+    //
+    // Initialize the protobufjs root
+    // with the GTFS-RT .proto file
+    const protoRoot = await initProto();
+    //
+    // Encode the GTFS-RT feed using the protobufjs root
+    const feedMessageType = protoRoot.lookupType('transit_realtime.FeedMessage');
+    const message = feedMessageType.fromObject(feedMessage);
+    return feedMessageType.encode(message).finish();
+    //
+}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './decode.js';
+export * from './encode.js';

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from './decode.js';
+export * from './encode.js';

package/dist/init-proto.d.ts

@@ -0,0 +1,7 @@
+import protobufjs from 'protobufjs';
+/**
+ * Initializes the protobufjs Root by loading
+ * the GTFS Realtime .proto definition file.
+ * @returns The initialized protobufjs Root.
+ */
+export declare function initProto(): Promise<protobufjs.Root>;

package/dist/init-proto.js

@@ -0,0 +1,45 @@
+/* * */
+import fs from 'node:fs';
+import path from 'node:path';
+import protobufjs from 'protobufjs';
+/* * */
+const PROTO_SPEC_FILE_URL = 'https://gtfs.org/documentation/realtime/gtfs-realtime.proto';
+const PROTO_SPEC_FILE_PATH = '/tmp/go-gtfs-rt/gtfs-realtime.proto';
+/* * */
+let PROTO_ROOT_INSTANCE = null;
+/**
+ * Initializes the protobufjs Root by loading
+ * the GTFS Realtime .proto definition file.
+ * @returns The initialized protobufjs Root.
+ */
+export async function initProto() {
+    //
+    //
+    // If the protobufjs Root has already been initialized,
+    // return the existing instance to avoid redundant work.
+    if (PROTO_ROOT_INSTANCE)
+        return PROTO_ROOT_INSTANCE;
+    //
+    // Check if the .proto file already exists locally.
+    // If not, download a fresh copy from the GTFS Realtime specification.
+    if (!fs.existsSync(PROTO_SPEC_FILE_PATH)) {
+        // Download the .proto definition file
+        const response = await fetch(PROTO_SPEC_FILE_URL);
+        const protoText = await response.text();
+        // Get the directory of the path where the .proto file will be saved
+        const dirPath = path.dirname(PROTO_SPEC_FILE_PATH);
+        // Create the directory if it doesn't exist
+        if (!fs.existsSync(dirPath))
+            fs.mkdirSync(dirPath, { recursive: true });
+        // Save the .proto file locally so it can be loaded by protobufjs
+        fs.writeFileSync(PROTO_SPEC_FILE_PATH, protoText);
+    }
+    //
+    // Load the .proto file using protobufjs,
+    // save the initialized Root instance
+    // in a global variable and return it.
+    const protoRoot = new protobufjs.Root();
+    PROTO_ROOT_INSTANCE = protoRoot.loadSync(PROTO_SPEC_FILE_PATH, { keepCase: true });
+    return PROTO_ROOT_INSTANCE;
+    //
+}

package/package.json

@@ -0,0 +1,49 @@
+{
+	"name": "@tmlmobilidade/gtfs-rt",
+	"version": "20260216.1651.10",
+	"author": {
+		"email": "iso@tmlmobilidade.pt",
+		"name": "TML-ISO"
+	},
+	"license": "AGPL-3.0-or-later",
+	"homepage": "https://github.com/tmlmobilidade/go#readme",
+	"bugs": {
+		"url": "https://github.com/tmlmobilidade/go/issues"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/tmlmobilidade/go.git"
+	},
+	"keywords": [
+		"public transit",
+		"tml",
+		"transportes metropolitanos de lisboa",
+		"go"
+	],
+	"publishConfig": {
+		"access": "public"
+	},
+	"type": "module",
+	"files": [
+		"dist"
+	],
+	"main": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"scripts": {
+		"build": "tsc && resolve-tspaths",
+		"lint": "eslint ./src/ && tsc --noEmit",
+		"lint:fix": "eslint ./src/ --fix",
+		"watch": "tsc-watch --onSuccess 'resolve-tspaths'"
+	},
+	"dependencies": {
+		"protobufjs": "8.0.0"
+	},
+	"devDependencies": {
+		"@tmlmobilidade/tsconfig": "*",
+		"@tmlmobilidade/types": "*",
+		"@types/node": "25.2.2",
+		"resolve-tspaths": "0.8.23",
+		"tsc-watch": "7.2.0",
+		"typescript": "5.9.3"
+	}
+}