npm - @tmlmobilidade/generate-offer-files - Versions diffs - 20251021.1643.15 → 20251229.1447.48 - Mend

@tmlmobilidade/generate-offer-files 20251021.1643.15 → 20251229.1447.48

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/dist/index.d.ts ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ #!/usr/bin/env node
2	+ export {};

package/dist/index.js CHANGED Viewed

@@ -1,8 +1,8 @@
 #!/usr/bin/env node
 /* * */
 import { generateOfferOutput } from './main.js';
-import LOGGER from '@helperkits/logger';
-import { ASCII_CM_SHORT } from '@tmlmobilidade/lib';
+import { ASCII_CM_SHORT } from '@tmlmobilidade/consts';
+import { Logger } from '@tmlmobilidade/logger';
 import { validateOperationalDate } from '@tmlmobilidade/types';
 import { Command } from 'commander';
 import fs from 'fs';
@@ -30,29 +30,29 @@ import fs from 'fs';
         options.endDate = validateOperationalDate(options.endDate);
     }
     catch (error) {
-        LOGGER.divider();
-        LOGGER.error(`--start-date and/or --end-date are not valid:`, error.message);
-        LOGGER.divider();
+        Logger.divider();
+        Logger.error(`--start-date and/or --end-date are not valid:`, error.message);
+        Logger.divider();
         return;
     }
     //
     // Ensure the output directory exists and is empty
     if (fs.existsSync(options.outputDir) && !options.override) {
-        LOGGER.divider();
-        LOGGER.error(`Output directory "${options.outputDir}" already exists. Please remove it or change it before running the script.`);
-        LOGGER.divider();
+        Logger.divider();
+        Logger.error(`Output directory "${options.outputDir}" already exists. Please remove it or change it before running the script.`);
+        Logger.divider();
         return;
     }
     if (fs.existsSync(options.outputDir) && options.override) {
-        LOGGER.info(`Output directory "${options.outputDir}" already exists. It will be overridden.`);
+        Logger.info(`Output directory "${options.outputDir}" already exists. It will be overridden.`);
         fs.rmSync(options.outputDir, { recursive: true });
     }
     fs.mkdirSync(options.outputDir, { recursive: true });
     //
     // Log the ASCII art
-    LOGGER.spacer(3);
+    Logger.spacer(3);
     console.log(ASCII_CM_SHORT);
-    LOGGER.spacer(3);
+    Logger.spacer(3);
     //
     // Start the offer generation process
     await generateOfferOutput(options.file, options.startDate, options.endDate, options.outputDir, options.feedId);

package/dist/main.d.ts ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ import { type OperationalDate } from '@tmlmobilidade/types';
2	+ export declare function generateOfferOutput(filePath: string, startDate: OperationalDate, endDate: OperationalDate, outputDir: string, feedId: null \| string): Promise<void>;

package/dist/main.js CHANGED Viewed

@@ -1,9 +1,10 @@
 /* * */
-import LOGGER from '@helperkits/logger';
-import TIMETRACKER from '@helperkits/timer';
-import { JsonWriter } from '@helperkits/writer';
+import { Dates, getOperationalDatesFromRange } from '@tmlmobilidade/dates';
+import { toMetersFromKilometersOrMeters } from '@tmlmobilidade/geo';
+import { Logger } from '@tmlmobilidade/logger';
+import { Timer } from '@tmlmobilidade/timer';
 import { validateGtfsCalendar, validateGtfsCalendarDate, validateGtfsRouteExtended, validateGtfsStopExtended, validateGtfsStopTime, validateGtfsTripExtended } from '@tmlmobilidade/types';
-import { Dates, getOperationalDatesFromRange, toMetersFromKilometersOrMeters } from '@tmlmobilidade/utils';
+import { JsonWriter } from '@tmlmobilidade/writers';
 import { parse as csvParser } from 'csv-parse';
 import extract from 'extract-zip';
 import fs from 'fs';
@@ -11,8 +12,8 @@ import fs from 'fs';
 export async function generateOfferOutput(filePath, startDate, endDate, outputDir, feedId) {
     try {
         //
-        LOGGER.init();
-        const globalTimer = new TIMETRACKER();
+        Logger.init();
+        const globalTimer = new Timer();
         //
         // Setup the JSON batch writers to speed up the writing process and
         // reduce the number of filesystem operations. These writers keep data
@@ -39,20 +40,20 @@ export async function generateOfferOutput(filePath, startDate, endDate, outputDi
         try {
             fs.rmSync(workdirPath, { recursive: true });
             fs.mkdirSync(workdirPath, { recursive: true });
-            LOGGER.success('Prepared working directory.');
-            LOGGER.spacer(1);
+            Logger.success('Prepared working directory.');
+            Logger.spacer(1);
         }
         catch (error) {
-            LOGGER.error(`Error preparing workdir path "${workdirPath}".`, error);
+            Logger.error(`Error preparing workdir path "${workdirPath}".`, error);
             process.exit(1);
         }
         try {
             await unzipFile(filePath, extractDirPath);
-            LOGGER.success(`Unzipped GTFS file from "${filePath}" to "${extractDirPath}".`);
-            LOGGER.spacer(1);
+            Logger.success(`Unzipped GTFS file from "${filePath}" to "${extractDirPath}".`);
+            Logger.spacer(1);
         }
         catch (error) {
-            LOGGER.error('Error unzipping the file.', error);
+            Logger.error('Error unzipping the file.', error);
             process.exit(1);
         }
         //
@@ -71,7 +72,7 @@ export async function generateOfferOutput(filePath, startDate, endDate, outputDi
         // that are valid between the given start_date and end_date.
         try {
             //
-            LOGGER.info(`Reading zip entry "calendar.txt"...`);
+            Logger.info(`Reading zip entry "calendar.txt"...`);
             const parseEachRow = async (data) => {
                 //
                 //
@@ -120,17 +121,17 @@ export async function generateOfferOutput(filePath, startDate, endDate, outputDi
             // Setup the CSV parsing operation only if the file exists
             if (fs.existsSync(`${extractDirPath}/calendar.txt`)) {
                 await parseCsvFile(`${extractDirPath}/calendar.txt`, parseEachRow);
-                LOGGER.success(`Finished processing "calendar.txt"`);
-                LOGGER.spacer(1);
+                Logger.success(`Finished processing "calendar.txt"`);
+                Logger.spacer(1);
             }
             else {
-                LOGGER.info(`Optional file "calendar.txt" not found. This may or may not be an error. Proceeding...`);
-                LOGGER.spacer(1);
+                Logger.info(`Optional file "calendar.txt" not found. This may or may not be an error. Proceeding...`);
+                Logger.spacer(1);
             }
             //
         }
         catch (error) {
-            LOGGER.error('Error processing "calendar.txt" file.', error);
+            Logger.error('Error processing "calendar.txt" file.', error);
             throw new Error('✖︎ Error processing "calendar.txt" file.');
         }
         /* * */
@@ -141,7 +142,7 @@ export async function generateOfferOutput(filePath, startDate, endDate, outputDi
         // present in calendar.txt and are between the given start and end dates.
         try {
             //
-            LOGGER.info(`Reading zip entry "calendar_dates.txt"...`);
+            Logger.info(`Reading zip entry "calendar_dates.txt"...`);
             const parseEachRow = async (data) => {
                 //
                 //
@@ -180,17 +181,17 @@ export async function generateOfferOutput(filePath, startDate, endDate, outputDi
             // Setup the CSV parsing operation only if the file exists
             if (fs.existsSync(`${extractDirPath}/calendar_dates.txt`)) {
                 await parseCsvFile(`${extractDirPath}/calendar_dates.txt`, parseEachRow);
-                LOGGER.success(`Finished processing "calendar_dates.txt"`);
-                LOGGER.spacer(1);
+                Logger.success(`Finished processing "calendar_dates.txt"`);
+                Logger.spacer(1);
             }
             else {
-                LOGGER.info(`Optional file "calendar_dates.txt" not found. This may or may not be an error. Proceeding...`);
-                LOGGER.spacer(1);
+                Logger.info(`Optional file "calendar_dates.txt" not found. This may or may not be an error. Proceeding...`);
+                Logger.spacer(1);
             }
             //
         }
         catch (error) {
-            LOGGER.error('Error processing "calendar_dates.txt" file.', error);
+            Logger.error('Error processing "calendar_dates.txt" file.', error);
             throw new Error('✖︎ Error processing "calendar_dates.txt" file.');
         }
         /* * */
@@ -201,7 +202,7 @@ export async function generateOfferOutput(filePath, startDate, endDate, outputDi
         // Only include trips which have the referenced service IDs saved before.
         try {
             //
-            LOGGER.info(`Reading zip entry "trips.txt"...`);
+            Logger.info(`Reading zip entry "trips.txt"...`);
             const parseEachRow = async (data) => {
                 // Validate the current row against the proper type
                 const validatedData = validateGtfsTripExtended(data);
@@ -217,12 +218,12 @@ export async function generateOfferOutput(filePath, startDate, endDate, outputDi
             //
             // Setup the CSV parsing operation
             await parseCsvFile(`${extractDirPath}/trips.txt`, parseEachRow);
-            LOGGER.success(`Finished processing "trips.txt"`);
-            LOGGER.spacer(1);
+            Logger.success(`Finished processing "trips.txt"`);
+            Logger.spacer(1);
             //
         }
         catch (error) {
-            LOGGER.error('Error processing "trips.txt" file.', error);
+            Logger.error('Error processing "trips.txt" file.', error);
             throw new Error('✖︎ Error processing "trips.txt" file.');
         }
         /* * */
@@ -232,7 +233,7 @@ export async function generateOfferOutput(filePath, startDate, endDate, outputDi
         // For routes, only include the ones referenced in the filtered trips.
         try {
             //
-            LOGGER.info(`Reading zip entry "routes.txt"...`);
+            Logger.info(`Reading zip entry "routes.txt"...`);
             const parseEachRow = async (data) => {
                 // Validate the current row against the proper type
                 const validatedData = validateGtfsRouteExtended(data);
@@ -246,12 +247,12 @@ export async function generateOfferOutput(filePath, startDate, endDate, outputDi
             //
             // Setup the CSV parsing operation
             await parseCsvFile(`${extractDirPath}/routes.txt`, parseEachRow);
-            LOGGER.success(`Finished processing "routes.txt"`);
-            LOGGER.spacer(1);
+            Logger.success(`Finished processing "routes.txt"`);
+            Logger.spacer(1);
             //
         }
         catch (error) {
-            LOGGER.error('Error processing "routes.txt" file.', error);
+            Logger.error('Error processing "routes.txt" file.', error);
             throw new Error('✖︎ Error processing "routes.txt" file.');
         }
         /* * */
@@ -262,7 +263,7 @@ export async function generateOfferOutput(filePath, startDate, endDate, outputDi
         // By saving all of them, we also speed up the processing of each stop_time by including the stop data right away.
         try {
             //
-            LOGGER.info(`Reading zip entry "stops.txt"...`);
+            Logger.info(`Reading zip entry "stops.txt"...`);
             const parseEachRow = async (data) => {
                 // Validate the current row against the proper type
                 const validatedData = validateGtfsStopExtended(data);
@@ -272,12 +273,12 @@ export async function generateOfferOutput(filePath, startDate, endDate, outputDi
             //
             // Setup the CSV parsing operation
             await parseCsvFile(`${extractDirPath}/stops.txt`, parseEachRow);
-            LOGGER.success(`Finished processing "stops.txt"`);
-            LOGGER.spacer(1);
+            Logger.success(`Finished processing "stops.txt"`);
+            Logger.spacer(1);
             //
         }
         catch (error) {
-            LOGGER.error('Error processing "stops.txt" file.', error);
+            Logger.error('Error processing "stops.txt" file.', error);
             throw new Error('✖︎ Error processing "stops.txt" file.');
         }
         /* * */
@@ -289,7 +290,7 @@ export async function generateOfferOutput(filePath, startDate, endDate, outputDi
         // right away to avoid another lookup later.
         try {
             //
-            LOGGER.info(`Reading zip entry "stop_times.txt"...`);
+            Logger.info(`Reading zip entry "stop_times.txt"...`);
             const parseEachRow = async (data) => {
                 //
                 //
@@ -318,12 +319,12 @@ export async function generateOfferOutput(filePath, startDate, endDate, outputDi
             //
             // Setup the CSV parsing operation
             await parseCsvFile(`${extractDirPath}/stop_times.txt`, parseEachRow);
-            LOGGER.success(`Finished processing "stop_times.txt"`);
-            LOGGER.spacer(1);
+            Logger.success(`Finished processing "stop_times.txt"`);
+            Logger.spacer(1);
             //
         }
         catch (error) {
-            LOGGER.error('Error processing "stop_times.txt" file.', error);
+            Logger.error('Error processing "stop_times.txt" file.', error);
             throw new Error('✖︎ Error processing "stop_times.txt" file.');
         }
         /* * */
@@ -341,7 +342,7 @@ export async function generateOfferOutput(filePath, startDate, endDate, outputDi
                 const stopTimesData = savedStopTimes.get(currentTrip.trip_id);
                 const routeData = savedRoutes.get(currentTrip.route_id);
                 if (!stopTimesData || stopTimesData.length === 0) {
-                    LOGGER.error(`Trip ${currentTrip.trip_id} has no path data. Skipping...`);
+                    Logger.error(`Trip ${currentTrip.trip_id} has no path data. Skipping...`);
                     continue;
                 }
                 //
@@ -474,21 +475,21 @@ export async function generateOfferOutput(filePath, startDate, endDate, outputDi
             //
         }
         catch (error) {
-            LOGGER.error('Error transforming or saving Offer documents.', error);
+            Logger.error('Error transforming or saving Offer documents.', error);
             throw new Error('✖︎ Error transforming or saving Offer documents.');
         }
         //
         offerStopsWriter.close();
         offerJourneysWriter.close();
-        LOGGER.spacer(1);
-        LOGGER.success(`Total OfferJourneys written: ${totalOfferJourneysCounter}`);
-        LOGGER.success(`Total OfferStops written: ${totalOfferStopsCounter}`);
-        LOGGER.terminate(`Finished processing GTFS file. Run took ${globalTimer.get()}`);
+        Logger.spacer(1);
+        Logger.success(`Total OfferJourneys written: ${totalOfferJourneysCounter}`);
+        Logger.success(`Total OfferStops written: ${totalOfferStopsCounter}`);
+        Logger.terminate(`Finished processing GTFS file. Run took ${globalTimer.get()}`);
         //
     }
     catch (error) {
-        LOGGER.error('An error occurred. Halting execution.', error);
-        LOGGER.error('Retrying in 10 seconds...');
+        Logger.error('An error occurred. Halting execution.', error);
+        Logger.error('Retrying in 10 seconds...');
         setTimeout(() => {
             process.exit(0); // End process
         }, 10000); // after 10 seconds

package/dist/types.d.ts ADDED Viewed

@@ -0,0 +1,94 @@
+export interface OfferJourney {
+    agencyId: string;
+    arrivalTime: string;
+    bikesAllowed: number;
+    blockId: string;
+    circular: number;
+    continuousDropOff: number;
+    continuousPickup: number;
+    date: string;
+    dayType: number;
+    dayTypeName: string;
+    departureTime: string;
+    directionId: number;
+    endShiftId: string;
+    endStopCode: string;
+    endStopId: string;
+    endStopName: string;
+    feedId: string;
+    holiday: number;
+    holidayName: string;
+    lineId: string;
+    lineLongName: string;
+    lineShortName: string;
+    pathType: number;
+    patternId: string;
+    patternShortName: string;
+    period: number;
+    periodName: string;
+    routeColor: string;
+    routeDesc: string;
+    routeDestination: string;
+    routeId: string;
+    routeLongName: string;
+    routeOrigin: string;
+    routeShortName: string;
+    routeTextColor: string;
+    routeType: string;
+    rowId: number;
+    school: string;
+    shapeId: string;
+    startShiftId: string;
+    startStopCode: string;
+    startStopId: string;
+    startStopName: string;
+    tripHeadsign: string;
+    tripId: string;
+    tripLength: number;
+    wheelchairAccessible: number;
+}
+export interface OfferStop {
+    arrivalTime: string;
+    bench: number;
+    continuousDropOff: number;
+    continuousPickup: number;
+    date: string;
+    departureTime: string;
+    dropOffType: number;
+    entranceRestriction: number;
+    equipment: number;
+    exitRestriction: number;
+    feedId: string;
+    locationType: number;
+    municipality: number;
+    municipalityFare1: null;
+    municipalityFare2: null;
+    networkMap: number;
+    parentStation: string;
+    pickupType: number;
+    platformCode: string;
+    preservationState: number;
+    realTimeInformation: number;
+    region: string;
+    rowId: number;
+    schedule: number;
+    shapeDistTraveled: number;
+    shelter: number;
+    signalling: number;
+    slot: number;
+    stopCode: string;
+    stopDesc: string;
+    stopHeadsign: string;
+    stopId: string;
+    stopIdStepp: string;
+    stopLat: number;
+    stopLon: number;
+    stopName: string;
+    stopRemarks: string;
+    stopSequence: number;
+    tariff: number;
+    timepoint: number;
+    tripId: string;
+    wheelchairBoarding: number;
+    zoneShift: number;
+}

package/package.json CHANGED Viewed

@@ -1,45 +1,47 @@
 {
 	"name": "@tmlmobilidade/generate-offer-files",
 	"description": "A CLI tool to generate legacy offer files for TML Mobilidade.",
-	"version": "20251021.1643.15",
-	"author": "João de Vasconcelos",
+	"version": "20251229.1447.48",
+	"author": {
+		"email": "iso@tmlmobilidade.pt",
+		"name": "TML-ISO"
+	},
 	"license": "AGPL-3.0-or-later",
 	"type": "module",
 	"files": [
 		"dist"
 	],
-	"main": "dist/index.js",
+	"main": "./dist/index.js",
 	"bin": {
 		"generate-offer-files": "dist/index.js"
 	},
-	"types": "dist/index.d.ts",
+	"types": "./dist/index.d.ts",
 	"scripts": {
-		"build": "npm run clean && tsc && resolve-tspaths",
-		"clean": "rm -rf dist",
-		"dev": "tsx watch ./src/index.ts",
+		"build": "tsc && resolve-tspaths",
+		"dev": "tsx watch src/index.ts",
 		"lint": "eslint .",
 		"lint:fix": "eslint . --fix",
 		"start": "tsc && resolve-tspaths && node dist/index.js"
 	},
 	"dependencies": {
-		"@helperkits/logger": "20250628.901.58",
-		"@helperkits/timer": "20240627.34.23",
-		"@helperkits/writer": "20251010.1959.27",
+		"@tmlmobilidade/consts": "*",
+		"@tmlmobilidade/geo": "*",
 		"@tmlmobilidade/interfaces": "*",
-		"@tmlmobilidade/lib": "*",
+		"@tmlmobilidade/logger": "*",
+		"@tmlmobilidade/timer": "*",
 		"@tmlmobilidade/utils": "*",
-		"commander": "14.0.1",
+		"@tmlmobilidade/writers": "*",
+		"commander": "14.0.2",
 		"csv-parse": "6.1.0",
 		"extract-zip": "2.0.1",
 		"gtfs-types": "5.1.0"
 	},
 	"devDependencies": {
-		"@carrismetropolitana/eslint": "20250622.1204.50",
 		"@tmlmobilidade/tsconfig": "*",
 		"@tmlmobilidade/types": "*",
-		"@types/node": "24.9.1",
+		"@types/node": "25.0.3",
 		"resolve-tspaths": "0.8.23",
-		"tsx": "4.20.6",
+		"tsx": "4.21.0",
 		"typescript": "5.9.3"
 	}
-}
+}