@routebot/constants 0.3.66 → 0.3.68

package/constants/constants.js

@@ -10,6 +10,11 @@ const USER_TYPES = {
   SCHOOL_PARENT: "2",
   PERSONEL: "10",
   ADMIN: "1000",
+  // POI (Point of Interest) — NOT a real person/app user. A lightweight reusable "place"
+  // (hotel, park, venue) used as an ordered stop inside a Tour service. Has no phone/
+  // relations and is excluded from all normal user/personel/parent listings.
+  // See: backend/modules/tour-builder/.
+  POI: "POI",
 };
 
 const CLIENT_ROLES = {

package/constants/login-code.constants.js

@@ -0,0 +1,32 @@
+// Personal mobile login codes (SMS-less countries, e.g. US).
+// Alphabet is intentionally restricted for easy typing across keyboards/locales:
+// - No I, L, O, 0, 1 (ambiguous when read aloud / transcribed)
+// - No Q, W (missing or awkward on many non-English layouts)
+const LOGIN_CODE_ALPHABET = "ABCDEFGHJKMNPRSTUVYZ23456789";
+const LOGIN_CODE_LENGTH = 8;
+
+const LOGIN_CODE_PATTERN = new RegExp(`^[${LOGIN_CODE_ALPHABET}]{${LOGIN_CODE_LENGTH}}$`);
+
+const normalizeLoginCode = (input) => {
+  const upper = (input || "").toString().toUpperCase();
+  let out = "";
+  for (const ch of upper) {
+    if (LOGIN_CODE_ALPHABET.includes(ch)) {
+      out += ch;
+    }
+  }
+  return out;
+};
+
+const isValidLoginCode = (code) => {
+  if (code == null || code === "") return true;
+  return LOGIN_CODE_PATTERN.test(code);
+};
+
+module.exports = {
+  LOGIN_CODE_ALPHABET,
+  LOGIN_CODE_LENGTH,
+  LOGIN_CODE_PATTERN,
+  normalizeLoginCode,
+  isValidLoginCode,
+};

package/constants/service.constants.js

@@ -6,6 +6,10 @@ const SERVICE_TYPES = {
   TRANSFER_PERSONEL: "TRANSFER_PERSONEL", // happens 1 time, date required
   TRANSFER_STUDENT: "TRANSFER_STUDENT", // happens 1 time, date required
   TRANSFER_RANDOM: "TRANSFER_RANDOM", // happens 1 time, date required
+  // TOUR — one-time, place-to-place trip authored via the Tour Builder. Stored as a
+  // PersonelService (school = destination/venue, users = ordered POI stops, routeType =
+  // PICK_UP). Distinct serviceType keeps tours out of the other personel/transfer tabs.
+  TOUR: "TOUR", // happens 1 time, date required
 };
 
 const ROUTE_TYPES = {

package/constants/tour.constants.js

@@ -0,0 +1,66 @@
+// Tour Builder — shared constants + pure helpers used across backend, frontend and
+// (implicitly) mobile. Keeping the tour stop-ordering logic here is the SINGLE source of
+// truth so the operator's arrangement (web), the persisted order (backend) and the driver's
+// view (mobile) never diverge.
+//
+// Data model recap (see backend/modules/tour-builder/):
+//   A Tour is a standard PersonelService with:
+//     - serviceType = SERVICE_TYPES.TOUR
+//     - routeType   = TOUR_ROUTE_TYPE (PICK_UP): collect guests at each stop, arrive at anchor
+//     - school      = the anchor / final destination (a venue School record)
+//     - users       = ordered POI stops (usertype: USER_TYPES.POI)
+//     - usersdetails = [{ user, transfertime }] carrying the optional per-stop pickup time
+//
+// Mobile (backend/modules/mobile/driver/driver.mobile.controller.js) sorts a personel
+// service's passengers by `transfertime` ascending (timed first, untimed keep order).
+// `orderTourStops` below replicates that EXACT rule so the web preview matches mobile.
+
+// Tours are modeled as PICK_UP so that:
+//   1) the anchor (venue) is the final navigation destination, and
+//   2) per-stop pickup times are shown to the driver (mobile shows transfertime on PICK_UP only).
+const TOUR_ROUTE_TYPE = "PICK_UP";
+
+/**
+ * Validates an "HH:mm" (24h) time string. Empty/invalid → false.
+ * @param {string} value
+ * @returns {boolean}
+ */
+function isValidTourStopTime(value) {
+  if (typeof value !== "string") return false;
+  return /^([01]\d|2[0-3]):([0-5]\d)$/.test(value.trim());
+}
+
+/**
+ * Orders tour stops the same way mobile does: stops WITH a valid transfertime come first
+ * (ascending by time), stops WITHOUT a time keep their original relative order and go last.
+ * The sort is STABLE (insertion index tie-breaker). Pure + side-effect free.
+ *
+ * @template T
+ * @param {T[]} stops - objects exposing a `transfertime` string
+ * @returns {T[]} a new, ordered array (input is not mutated)
+ */
+function orderTourStops(stops) {
+  if (!Array.isArray(stops)) return [];
+
+  return stops
+    .map((stop, index) => ({ stop, index }))
+    .sort((a, b) => {
+      const validA = isValidTourStopTime(a.stop && a.stop.transfertime);
+      const validB = isValidTourStopTime(b.stop && b.stop.transfertime);
+
+      if (validA && validB) {
+        const compared = a.stop.transfertime.localeCompare(b.stop.transfertime);
+        return compared !== 0 ? compared : a.index - b.index;
+      }
+      if (validA && !validB) return -1;
+      if (!validA && validB) return 1;
+      return a.index - b.index;
+    })
+    .map((entry) => entry.stop);
+}
+
+module.exports = {
+  TOUR_ROUTE_TYPE,
+  isValidTourStopTime,
+  orderTourStops,
+};

package/index.js

@@ -5,6 +5,7 @@ module.exports = {
   ...require("./constants/company.constants.js"),
   ...require("./constants/process.constants.js"),
   ...require("./constants/service.constants.js"),
+  ...require("./constants/tour.constants.js"),
   ...require("./constants/sms.constants.js"),
   ...require("./constants/stock.constants.js"),
   ...require("./constants/maps.constants.js"),
@@ -13,4 +14,5 @@ module.exports = {
   ...require("./constants/access-control.constants.js"),
   ...require("./constants/plan.constants.js"),
   ...require("./constants/telemetry.constants.js"),
+  ...require("./constants/login-code.constants.js"),
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@routebot/constants",
-  "version": "0.3.66",
+  "version": "0.3.68",
   "description": "Shared constants for RouteBot FE/BE",
   "main": "index.js",
   "files": [