gtfs-to-html 2.10.0 → 2.10.1

package/dist/index.d.ts

@@ -51,9 +51,7 @@ interface Config {
     useParentStation?: boolean;
     verbose?: boolean;
     zipOutput?: boolean;
-    log?: (text: string) => void;
-    logWarning?: (text: string) => void;
-    logError?: (text: string) => void;
+    logFunction?: (text: string) => void;
 }
 
 declare const gtfsToHtml: (initialConfig: Config) => Promise<string>;

package/dist/index.js

@@ -106,6 +106,7 @@ import {
   cloneDeep,
   compact,
   countBy,
+  difference,
   entries,
   every as every2,
   find,
@@ -155,6 +156,163 @@ import { getShapesAsGeoJSON, getStopsAsGeoJSON } from "gtfs";
 import { flatMap } from "lodash-es";
 import simplify from "@turf/simplify";
 import { featureCollection, round } from "@turf/helpers";
+
+// src/lib/log-utils.ts
+import { clearLine, cursorTo } from "node:readline";
+import { noop } from "lodash-es";
+import * as colors from "yoctocolors";
+import { getFeedInfo } from "gtfs";
+import Table from "cli-table";
+function generateLogText(outputStats, config) {
+  const feedInfo = getFeedInfo();
+  const feedVersion = feedInfo.length > 0 && feedInfo[0].feed_version ? feedInfo[0].feed_version : "Unknown";
+  const logText = [
+    `Feed Version: ${feedVersion}`,
+    `GTFS-to-HTML Version: ${config.gtfsToHtmlVersion}`,
+    `Date Generated: ${(/* @__PURE__ */ new Date()).toISOString()}`,
+    `Timetable Page Count: ${outputStats.timetablePages}`,
+    `Timetable Count: ${outputStats.timetables}`,
+    `Calendar Service ID Count: ${outputStats.calendars}`,
+    `Route Count: ${outputStats.routes}`,
+    `Trip Count: ${outputStats.trips}`,
+    `Stop Count: ${outputStats.stops}`
+  ];
+  for (const agency of config.agencies) {
+    if (agency.url) {
+      logText.push(`Source: ${agency.url}`);
+    } else if (agency.path) {
+      logText.push(`Source: ${agency.path}`);
+    }
+  }
+  if (outputStats.warnings.length > 0) {
+    logText.push("", "Warnings:", ...outputStats.warnings);
+  }
+  return logText.join("\n");
+}
+function log(config) {
+  if (config.verbose === false) {
+    return noop;
+  }
+  if (config.logFunction) {
+    return config.logFunction;
+  }
+  return (text, overwrite) => {
+    if (overwrite === true && process.stdout.isTTY) {
+      clearLine(process.stdout, 0);
+      cursorTo(process.stdout, 0);
+    } else {
+      process.stdout.write("\n");
+    }
+    process.stdout.write(text);
+  };
+}
+function logWarning(config) {
+  if (config.logFunction) {
+    return config.logFunction;
+  }
+  return (text) => {
+    process.stdout.write(`
+${formatWarning(text)}
+`);
+  };
+}
+function logError(config) {
+  if (config.logFunction) {
+    return config.logFunction;
+  }
+  return (text) => {
+    process.stdout.write(`
+${formatError(text)}
+`);
+  };
+}
+function formatWarning(text) {
+  const warningMessage = `${colors.underline("Warning")}: ${text}`;
+  return colors.yellow(warningMessage);
+}
+function formatError(error) {
+  const messageText = error instanceof Error ? error.message : error;
+  const errorMessage = `${colors.underline("Error")}: ${messageText.replace(
+    "Error: ",
+    ""
+  )}`;
+  return colors.red(errorMessage);
+}
+function logStats(config) {
+  if (config.logFunction) {
+    return noop;
+  }
+  return (stats) => {
+    const table = new Table({
+      colWidths: [40, 20],
+      head: ["Item", "Count"]
+    });
+    table.push(
+      ["\u{1F4C4} Timetable Pages", stats.timetablePages],
+      ["\u{1F551} Timetables", stats.timetables],
+      ["\u{1F4C5} Calendar Service IDs", stats.calendars],
+      ["\u{1F504} Routes", stats.routes],
+      ["\u{1F68D} Trips", stats.trips],
+      ["\u{1F6D1} Stops", stats.stops],
+      ["\u26D4\uFE0F Warnings", stats.warnings.length]
+    );
+    log(config)(table.toString());
+  };
+}
+var generateProgressBarString = (barTotal, barProgress, size2 = 40) => {
+  const line = "-";
+  const slider = "=";
+  if (!barTotal) {
+    throw new Error("Total value is either not provided or invalid");
+  }
+  if (!barProgress && barProgress !== 0) {
+    throw new Error("Current value is either not provided or invalid");
+  }
+  if (isNaN(barTotal)) {
+    throw new Error("Total value is not an integer");
+  }
+  if (isNaN(barProgress)) {
+    throw new Error("Current value is not an integer");
+  }
+  if (isNaN(size2)) {
+    throw new Error("Size is not an integer");
+  }
+  if (barProgress > barTotal) {
+    return slider.repeat(size2 + 2);
+  }
+  const percentage = barProgress / barTotal;
+  const progress = Math.round(size2 * percentage);
+  const emptyProgress = size2 - progress;
+  const progressText = slider.repeat(progress);
+  const emptyProgressText = line.repeat(emptyProgress);
+  return progressText + emptyProgressText;
+};
+function progressBar(formatString, barTotal, config) {
+  let barProgress = 0;
+  if (config.verbose === false) {
+    return {
+      increment: noop,
+      interrupt: noop
+    };
+  }
+  if (barTotal === 0) {
+    return null;
+  }
+  const renderProgressString = () => formatString.replace("{value}", barProgress).replace("{total}", barTotal).replace("{bar}", generateProgressBarString(barTotal, barProgress));
+  log(config)(renderProgressString(), true);
+  return {
+    interrupt(text) {
+      logWarning(config)(text);
+      log(config)("");
+    },
+    increment() {
+      barProgress += 1;
+      log(config)(renderProgressString(), true);
+    }
+  };
+}
+
+// src/lib/geojson-utils.ts
 var mergeGeojson = (...geojsons) => featureCollection(flatMap(geojsons, (geojson) => geojson.features));
 var truncateGeoJSONDecimals = (geojson, config) => {
   for (const feature of geojson.features) {
@@ -182,18 +340,6 @@ var truncateGeoJSONDecimals = (geojson, config) => {
   }
   return geojson;
 };
-var simplifyGeoJSON = (geojson, config) => {
-  try {
-    const simplifiedGeojson = simplify(geojson, {
-      tolerance: 1 / 10 ** config.coordinatePrecision,
-      highQuality: true
-    });
-    return truncateGeoJSONDecimals(simplifiedGeojson, config);
-  } catch {
-    config.logWarning("Unable to simplify geojson");
-    return truncateGeoJSONDecimals(geojson, config);
-  }
-};
 function getTimetableGeoJSON(timetable, config) {
   const shapesGeojsons = timetable.route_ids.map(
     (routeId) => getShapesAsGeoJSON({
@@ -210,13 +356,35 @@ function getTimetableGeoJSON(timetable, config) {
     })
   );
   const geojson = mergeGeojson(...shapesGeojsons, ...stopsGeojsons);
-  return simplifyGeoJSON(geojson, config);
+  let simplifiedGeojson;
+  try {
+    simplifiedGeojson = simplify(geojson, {
+      tolerance: 1 / 10 ** config.coordinatePrecision,
+      highQuality: true
+    });
+  } catch {
+    timetable.warnings.push(
+      `Timetable ${timetable.timetable_id} - Unable to simplify geojson`
+    );
+    simplifiedGeojson = geojson;
+  }
+  return truncateGeoJSONDecimals(simplifiedGeojson, config);
 }
 function getAgencyGeoJSON(config) {
   const shapesGeojsons = getShapesAsGeoJSON();
   const stopsGeojsons = getStopsAsGeoJSON();
   const geojson = mergeGeojson(shapesGeojsons, stopsGeojsons);
-  return simplifyGeoJSON(geojson, config);
+  let simplifiedGeojson;
+  try {
+    simplifiedGeojson = simplify(geojson, {
+      tolerance: 1 / 10 ** config.coordinatePrecision,
+      highQuality: true
+    });
+  } catch {
+    logWarning(config)("Unable to simplify geojson");
+    simplifiedGeojson = geojson;
+  }
+  return truncateGeoJSONDecimals(simplifiedGeojson, config);
 }
 
 // src/lib/template-functions.ts
@@ -334,7 +502,7 @@ function formatTripNameForCSV(trip, timetable) {
 }
 
 // package.json
-var version = "2.10.0";
+var version = "2.10.1";
 
 // src/lib/utils.ts
 var isTimepoint = (stoptime) => {
@@ -564,7 +732,7 @@ var getTimetableNotesForTimetable = (timetable, config) => {
       continue;
     }
     if (noteReference.stop_id === "" || noteReference.stop_id === null) {
-      config.logWarning(
+      timetable.warnings.push(
         `Timetable Note Reference for note_id=${noteReference.note_id} has a \`stop_sequence\` but no \`stop_id\` - ignoring`
       );
       continue;
@@ -797,9 +965,19 @@ var getStopOrder = (timetable, config) => {
       config
     );
     const stopIds = longestTripStoptimes.map((stoptime) => stoptime.stop_id);
-    config.logWarning(
-      `Timetable ${timetable.timetable_id} stops are unable to be topologically sorted and has no \`timetable_stop_order.txt\`. Falling back to using the using the stop order from trip with most stoptimes, but this can result in timetables with some stops missing. Try manually specifying stops with \`timetable_stop_order.txt\`.`
+    const missingStopIds = difference(
+      uniq(
+        timetable.orderedTrips.flatMap(
+          (trip) => trip.stoptimes.map((stoptime) => stoptime.stop_id)
+        )
+      ),
+      uniq(stopIds)
     );
+    if (missingStopIds.length > 0) {
+      timetable.warnings.push(
+        `Timetable ${timetable.timetable_id} stops are unable to be topologically sorted and has no \`timetable_stop_order.txt\`. Falling back to using the using the stop order from trip with most stoptimes, but this does not include stop_ids ${new Intl.ListFormat("en", { style: "long", type: "conjunction" }).format(missingStopIds)}. Try manually specifying stops with \`timetable_stop_order.txt\`. Read more at https://gtfstohtml.com/docs/timetable-stop-order`
+      );
+    }
     return duplicateStopsForDifferentArrivalDeparture(
       stopIds,
       timetable,
@@ -1974,166 +2152,10 @@ async function renderPdf(htmlPath) {
   await browser.close();
 }
 
-// src/lib/log-utils.ts
-import { clearLine, cursorTo } from "node:readline";
-import { noop } from "lodash-es";
-import * as colors from "yoctocolors";
-import { getFeedInfo } from "gtfs";
-import Table from "cli-table";
-function generateLogText(outputStats, config) {
-  const feedInfo = getFeedInfo();
-  const feedVersion = feedInfo.length > 0 && feedInfo[0].feed_version ? feedInfo[0].feed_version : "Unknown";
-  const logText = [
-    `Feed Version: ${feedVersion}`,
-    `GTFS-to-HTML Version: ${config.gtfsToHtmlVersion}`,
-    `Date Generated: ${(/* @__PURE__ */ new Date()).toISOString()}`,
-    `Timetable Page Count: ${outputStats.timetablePages}`,
-    `Timetable Count: ${outputStats.timetables}`,
-    `Calendar Service ID Count: ${outputStats.calendars}`,
-    `Route Count: ${outputStats.routes}`,
-    `Trip Count: ${outputStats.trips}`,
-    `Stop Count: ${outputStats.stops}`
-  ];
-  for (const agency of config.agencies) {
-    if (agency.url) {
-      logText.push(`Source: ${agency.url}`);
-    } else if (agency.path) {
-      logText.push(`Source: ${agency.path}`);
-    }
-  }
-  if (outputStats.warnings.length > 0) {
-    logText.push("", "Warnings:", ...outputStats.warnings);
-  }
-  return logText.join("\n");
-}
-function log(config) {
-  if (config.verbose === false) {
-    return noop;
-  }
-  if (config.logFunction) {
-    return config.logFunction;
-  }
-  return (text, overwrite) => {
-    if (overwrite === true && process.stdout.isTTY) {
-      clearLine(process.stdout, 0);
-      cursorTo(process.stdout, 0);
-    } else {
-      process.stdout.write("\n");
-    }
-    process.stdout.write(text);
-  };
-}
-function logWarning(config) {
-  if (config.logFunction) {
-    return config.logFunction;
-  }
-  return (text) => {
-    process.stdout.write(`
-${formatWarning(text)}
-`);
-  };
-}
-function logError(config) {
-  if (config.logFunction) {
-    return config.logFunction;
-  }
-  return (text) => {
-    process.stdout.write(`
-${formatError(text)}
-`);
-  };
-}
-function formatWarning(text) {
-  const warningMessage = `${colors.underline("Warning")}: ${text}`;
-  return colors.yellow(warningMessage);
-}
-function formatError(error) {
-  const messageText = error instanceof Error ? error.message : error;
-  const errorMessage = `${colors.underline("Error")}: ${messageText.replace(
-    "Error: ",
-    ""
-  )}`;
-  return colors.red(errorMessage);
-}
-function logStats(stats, config) {
-  if (config.logFunction) {
-    return;
-  }
-  const table = new Table({
-    colWidths: [40, 20],
-    head: ["Item", "Count"]
-  });
-  table.push(
-    ["\u{1F4C4} Timetable Pages", stats.timetablePages],
-    ["\u{1F551} Timetables", stats.timetables],
-    ["\u{1F4C5} Calendar Service IDs", stats.calendars],
-    ["\u{1F504} Routes", stats.routes],
-    ["\u{1F68D} Trips", stats.trips],
-    ["\u{1F6D1} Stops", stats.stops],
-    ["\u26D4\uFE0F Warnings", stats.warnings.length]
-  );
-  config.log(table.toString());
-}
-var generateProgressBarString = (barTotal, barProgress, size2 = 40) => {
-  const line = "-";
-  const slider = "=";
-  if (!barTotal) {
-    throw new Error("Total value is either not provided or invalid");
-  }
-  if (!barProgress && barProgress !== 0) {
-    throw new Error("Current value is either not provided or invalid");
-  }
-  if (isNaN(barTotal)) {
-    throw new Error("Total value is not an integer");
-  }
-  if (isNaN(barProgress)) {
-    throw new Error("Current value is not an integer");
-  }
-  if (isNaN(size2)) {
-    throw new Error("Size is not an integer");
-  }
-  if (barProgress > barTotal) {
-    return slider.repeat(size2 + 2);
-  }
-  const percentage = barProgress / barTotal;
-  const progress = Math.round(size2 * percentage);
-  const emptyProgress = size2 - progress;
-  const progressText = slider.repeat(progress);
-  const emptyProgressText = line.repeat(emptyProgress);
-  return progressText + emptyProgressText;
-};
-function progressBar(formatString, barTotal, config) {
-  let barProgress = 0;
-  if (config.verbose === false) {
-    return {
-      increment: noop,
-      interrupt: noop
-    };
-  }
-  if (barTotal === 0) {
-    return null;
-  }
-  const renderProgressString = () => formatString.replace("{value}", barProgress).replace("{total}", barTotal).replace("{bar}", generateProgressBarString(barTotal, barProgress));
-  config.log(renderProgressString(), true);
-  return {
-    interrupt(text) {
-      config.logWarning(text);
-      config.log("");
-    },
-    increment() {
-      barProgress += 1;
-      config.log(renderProgressString(), true);
-    }
-  };
-}
-
 // src/lib/gtfs-to-html.ts
 var gtfsToHtml = async (initialConfig) => {
   const config = setDefaultConfig(initialConfig);
   const timer = new Timer();
-  config.log = log(config);
-  config.logWarning = logWarning(config);
-  config.logError = logError(config);
   const agencyKey = config.agencies.map(
     (agency) => agency.agencyKey ?? agency.agency_key ?? "unknown"
   ).join("-");
@@ -2144,7 +2166,7 @@ var gtfsToHtml = async (initialConfig) => {
     openDb2(config);
   } catch (error) {
     if (error?.code === "SQLITE_CANTOPEN") {
-      config.logError(
+      logError(config)(
         `Unable to open sqlite database "${config.sqlitePath}" defined as \`sqlitePath\` config.json. Ensure the parent directory exists or remove \`sqlitePath\` from config.json.`
       );
     }
@@ -2252,12 +2274,12 @@ var gtfsToHtml = async (initialConfig) => {
     outputPath,
     config.zipOutput ? "/timetables.zip" : ""
   );
-  config.log(
+  log(config)(
     `${agencyKey}: ${config.outputFormat.toUpperCase()} timetables created at ${fullOutputPath}`
   );
-  logStats(stats, config);
+  logStats(config)(stats);
   const seconds = Math.round(timer.time() / 1e3);
-  config.log(
+  log(config)(
     `${agencyKey}: ${config.outputFormat.toUpperCase()} timetable generation required ${seconds} seconds`
   );
   timer.stop();