@tmlmobilidade/types 20260601.1620.24 → 20260601.1657.26

package/dist/gtfs/stops.d.ts

@@ -71,6 +71,8 @@ export declare function validateGtfsStop(rawData: GTFS_Stop_Raw): GTFS_Stop;
  * should be used for working with the GTFS-TML standard.
  */
 export interface GTFS_Stop_Extended extends GTFS_Stop {
+    district_id?: string;
+    district_name?: string;
     has_bench?: GTFS_HasField;
     has_network_map?: GTFS_HasField;
     has_pip_real_time?: GTFS_HasField;
@@ -78,8 +80,12 @@ export interface GTFS_Stop_Extended extends GTFS_Stop {
     has_shelter?: GTFS_HasField;
     has_stop_sign?: GTFS_HasField;
     has_tariffs_information?: GTFS_HasField;
+    locality_id?: string;
+    locality_name?: string;
     municipality_id?: string;
+    municipality_name?: string;
     parish_id?: string;
+    parish_name?: string;
     public_visible?: GTFS_Binary;
     region_id?: string;
     shelter_code?: string;
@@ -94,6 +100,8 @@ export interface GTFS_Stop_Extended extends GTFS_Stop {
  * and transformation into the `GTFS_Stop_Extended` format.
  */
 export interface GTFS_Stop_Extended_Raw extends GTFS_Stop_Raw {
+    district_id?: string;
+    district_name?: string;
     has_bench?: string;
     has_network_map?: string;
     has_pip_real_time?: string;
@@ -101,8 +109,12 @@ export interface GTFS_Stop_Extended_Raw extends GTFS_Stop_Raw {
     has_shelter?: string;
     has_stop_sign?: string;
     has_tariffs_information?: string;
+    locality_id?: string;
+    locality_name?: string;
     municipality_id?: string;
+    municipality_name?: string;
     parish_id?: string;
+    parish_name?: string;
     public_visible?: string;
     region_id?: string;
     shelter_code?: string;

package/dist/gtfs/stops.js

@@ -77,6 +77,8 @@ export function validateGtfsStopExtended(rawData) {
     // Transform the raw data into the output format
     return {
         ...stop,
+        district_id: rawData.district_id,
+        district_name: rawData.district_name,
         has_bench: validateGtfsHasField(rawData.has_bench),
         has_network_map: validateGtfsHasField(rawData.has_network_map),
         has_pip_real_time: validateGtfsHasField(rawData.has_pip_real_time),
@@ -84,8 +86,12 @@ export function validateGtfsStopExtended(rawData) {
         has_shelter: validateGtfsBinary(rawData.has_shelter),
         has_stop_sign: validateGtfsHasField(rawData.has_stop_sign),
         has_tariffs_information: validateGtfsHasField(rawData.has_tariffs_information),
+        locality_id: rawData.locality_id,
+        locality_name: rawData.locality_name,
         municipality_id: rawData.municipality_id,
+        municipality_name: rawData.municipality_name,
         parish_id: rawData.parish_id,
+        parish_name: rawData.parish_name,
         public_visible: validateGtfsBinary(rawData.public_visible),
         region_id: rawData.region_id,
         shelter_code: rawData.shelter_code,

package/dist/hub/api/stop.d.ts

@@ -1,13 +1,9 @@
 import { z } from 'zod';
-export declare const HubStopSchema: z.ZodObject<Pick<{
-    created_at: z.ZodEffects<z.ZodNumber, import("../../index.js").UnixTimestamp, number>;
-    created_by: z.ZodDefault<z.ZodNullable<z.ZodString>>;
-    is_locked: z.ZodDefault<z.ZodBoolean>;
-    updated_at: z.ZodEffects<z.ZodNumber, import("../../index.js").UnixTimestamp, number>;
-    updated_by: z.ZodOptional<z.ZodString>;
-} & {
+export declare const HubStopSchema: z.ZodObject<{
     _id: z.ZodNumber;
-    flags: z.ZodDefault<z.ZodArray<z.ZodObject<{
+    district_id: z.ZodString;
+    district_name: z.ZodString;
+    flags: z.ZodArray<z.ZodObject<{
         agency_ids: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
         is_harmonized: z.ZodDefault<z.ZodBoolean>;
         short_name: z.ZodString;
@@ -22,287 +18,23 @@ export declare const HubStopSchema: z.ZodObject<Pick<{
         stop_id: string;
         agency_ids?: string[] | undefined;
         is_harmonized?: boolean | undefined;
-    }>, "many">>;
-    is_deleted: z.ZodDefault<z.ZodBoolean>;
-    jurisdiction: z.ZodDefault<z.ZodEnum<["ip", "municipality", "other", "unknown"]>>;
-    legacy_id: z.ZodDefault<z.ZodNullable<z.ZodString>>;
-    legacy_ids: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
-    lifecycle_status: z.ZodDefault<z.ZodEnum<["draft", "active", "inactive", "provisional", "seasonal", "voided"]>>;
-    name: z.ZodString;
-    new_name: z.ZodDefault<z.ZodNullable<z.ZodString>>;
-    previous_go_id: z.ZodDefault<z.ZodNullable<z.ZodString>>;
-    short_name: z.ZodString;
-    tts_name: z.ZodString;
-    district_id: z.ZodString;
+    }>, "many">;
     latitude: z.ZodNumber;
-    locality_id: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    legacy_ids: z.ZodArray<z.ZodString, "many">;
+    lifecycle_status: z.ZodEnum<["draft", "active", "inactive", "provisional", "seasonal", "voided"]>;
+    line_ids: z.ZodArray<z.ZodString, "many">;
+    locality_id: z.ZodNullable<z.ZodString>;
+    locality_name: z.ZodNullable<z.ZodString>;
     longitude: z.ZodNumber;
     municipality_id: z.ZodString;
-    parish_id: z.ZodDefault<z.ZodNullable<z.ZodString>>;
-    bench_status: z.ZodDefault<z.ZodEnum<["not_applicable", "unknown", "missing", "damaged", "ok"]>>;
-    electricity_status: z.ZodDefault<z.ZodEnum<["available", "unavailable", "unknown"]>>;
-    pole_status: z.ZodDefault<z.ZodEnum<["not_applicable", "unknown", "missing", "damaged", "ok"]>>;
-    road_type: z.ZodDefault<z.ZodEnum<["complementary_itinerary", "highway", "main_itinerary", "national_road", "regional_road", "secondary_road", "unknown"]>>;
-    shelter_code: z.ZodDefault<z.ZodNullable<z.ZodString>>;
-    shelter_frame_size: z.ZodDefault<z.ZodNullable<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>>;
-    shelter_installation_date: z.ZodDefault<z.ZodNullable<z.ZodEffects<z.ZodNumber, import("../../index.js").UnixTimestamp, number>>>;
-    shelter_maintainer: z.ZodDefault<z.ZodNullable<z.ZodString>>;
-    shelter_make: z.ZodDefault<z.ZodNullable<z.ZodString>>;
-    shelter_model: z.ZodDefault<z.ZodNullable<z.ZodString>>;
-    shelter_status: z.ZodDefault<z.ZodEnum<["not_applicable", "unknown", "missing", "damaged", "ok"]>>;
-    last_infrastructure_check: z.ZodDefault<z.ZodNullable<z.ZodEffects<z.ZodNumber, import("../../index.js").UnixTimestamp, number>>>;
-    last_infrastructure_maintenance: z.ZodDefault<z.ZodNullable<z.ZodEffects<z.ZodNumber, import("../../index.js").UnixTimestamp, number>>>;
-    last_schedules_check: z.ZodDefault<z.ZodNullable<z.ZodEffects<z.ZodNumber, import("../../index.js").UnixTimestamp, number>>>;
-    last_schedules_maintenance: z.ZodDefault<z.ZodNullable<z.ZodEffects<z.ZodNumber, import("../../index.js").UnixTimestamp, number>>>;
-    connections: z.ZodDefault<z.ZodArray<z.ZodEnum<["ferry", "light_rail", "subway", "train", "boat", "airport", "bike_sharing", "bike_parking", "car_parking"]>, "many">>;
-    facilities: z.ZodDefault<z.ZodArray<z.ZodEnum<["fire_station", "health_clinic", "historic_building", "hospital", "police_station", "school", "shopping", "transit_office", "university", "beach"]>, "many">>;
-    equipment: z.ZodDefault<z.ZodArray<z.ZodEnum<["pip", "mupi", "mini_pip"]>, "many">>;
-    has_bench: z.ZodDefault<z.ZodEnum<["available", "unavailable", "unknown"]>>;
-    has_mupi: z.ZodDefault<z.ZodEnum<["available", "unavailable", "unknown"]>>;
-    has_network_map: z.ZodDefault<z.ZodEnum<["available", "unavailable", "unknown"]>>;
-    has_schedules: z.ZodDefault<z.ZodEnum<["available", "unavailable", "unknown"]>>;
-    has_shelter: z.ZodDefault<z.ZodEnum<["available", "unavailable", "unknown"]>>;
-    has_stop_sign: z.ZodDefault<z.ZodEnum<["available", "unavailable", "unknown"]>>;
-    file_ids: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
-    image_ids: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
-    comments: z.ZodDefault<z.ZodArray<z.ZodEffects<z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
-        _id: z.ZodOptional<z.ZodString>;
-        created_at: z.ZodEffects<z.ZodNumber, import("../../index.js").UnixTimestamp, number>;
-        created_by: z.ZodDefault<z.ZodNullable<z.ZodString>>;
-        updated_at: z.ZodEffects<z.ZodNumber, import("../../index.js").UnixTimestamp, number>;
-        updated_by: z.ZodOptional<z.ZodString>;
-        message: z.ZodString;
-        type: z.ZodLiteral<"note">;
-    }, "strip", z.ZodTypeAny, {
-        created_at: number & {
-            __brand: "UnixTimestamp";
-        };
-        created_by: string | null;
-        updated_at: number & {
-            __brand: "UnixTimestamp";
-        };
-        message: string;
-        type: "note";
-        _id?: string | undefined;
-        updated_by?: string | undefined;
-    }, {
-        created_at: number;
-        updated_at: number;
-        message: string;
-        type: "note";
-        _id?: string | undefined;
-        created_by?: string | null | undefined;
-        updated_by?: string | undefined;
-    }>, z.ZodObject<{
-        _id: z.ZodOptional<z.ZodString>;
-        created_at: z.ZodEffects<z.ZodNumber, import("../../index.js").UnixTimestamp, number>;
-        created_by: z.ZodDefault<z.ZodNullable<z.ZodString>>;
-        updated_at: z.ZodEffects<z.ZodNumber, import("../../index.js").UnixTimestamp, number>;
-        updated_by: z.ZodOptional<z.ZodString>;
-        type: z.ZodLiteral<"field_changed">;
-        metadata: z.ZodOptional<z.ZodNullable<z.ZodObject<{
-            changes: z.ZodOptional<z.ZodArray<z.ZodObject<{
-                curr_value: z.ZodAny;
-                field: z.ZodString;
-                prev_value: z.ZodAny;
-            }, "strip", z.ZodTypeAny, {
-                field: string;
-                curr_value?: any;
-                prev_value?: any;
-            }, {
-                field: string;
-                curr_value?: any;
-                prev_value?: any;
-            }>, "many">>;
-        }, "strip", z.ZodTypeAny, {
-            changes?: {
-                field: string;
-                curr_value?: any;
-                prev_value?: any;
-            }[] | undefined;
-        }, {
-            changes?: {
-                field: string;
-                curr_value?: any;
-                prev_value?: any;
-            }[] | undefined;
-        }>>>;
-        curr_value: z.ZodAny;
-        field: z.ZodString;
-        prev_value: z.ZodAny;
-    }, "strip", z.ZodTypeAny, {
-        created_at: number & {
-            __brand: "UnixTimestamp";
-        };
-        created_by: string | null;
-        updated_at: number & {
-            __brand: "UnixTimestamp";
-        };
-        type: "field_changed";
-        field: string;
-        _id?: string | undefined;
-        updated_by?: string | undefined;
-        metadata?: {
-            changes?: {
-                field: string;
-                curr_value?: any;
-                prev_value?: any;
-            }[] | undefined;
-        } | null | undefined;
-        curr_value?: any;
-        prev_value?: any;
-    }, {
-        created_at: number;
-        updated_at: number;
-        type: "field_changed";
-        field: string;
-        _id?: string | undefined;
-        created_by?: string | null | undefined;
-        updated_by?: string | undefined;
-        metadata?: {
-            changes?: {
-                field: string;
-                curr_value?: any;
-                prev_value?: any;
-            }[] | undefined;
-        } | null | undefined;
-        curr_value?: any;
-        prev_value?: any;
-    }>, z.ZodObject<{
-        _id: z.ZodOptional<z.ZodString>;
-        created_at: z.ZodEffects<z.ZodNumber, import("../../index.js").UnixTimestamp, number>;
-        created_by: z.ZodDefault<z.ZodNullable<z.ZodString>>;
-        updated_at: z.ZodEffects<z.ZodNumber, import("../../index.js").UnixTimestamp, number>;
-        updated_by: z.ZodOptional<z.ZodString>;
-        type: z.ZodLiteral<"crud">;
-        action: z.ZodEnum<["create", "update", "delete", "archive", "restore"]>;
-    }, "strip", z.ZodTypeAny, {
-        created_at: number & {
-            __brand: "UnixTimestamp";
-        };
-        created_by: string | null;
-        updated_at: number & {
-            __brand: "UnixTimestamp";
-        };
-        type: "crud";
-        action: "create" | "update" | "delete" | "archive" | "restore";
-        _id?: string | undefined;
-        updated_by?: string | undefined;
-    }, {
-        created_at: number;
-        updated_at: number;
-        type: "crud";
-        action: "create" | "update" | "delete" | "archive" | "restore";
-        _id?: string | undefined;
-        created_by?: string | null | undefined;
-        updated_by?: string | undefined;
-    }>]>, {
-        created_at: number & {
-            __brand: "UnixTimestamp";
-        };
-        created_by: string | null;
-        updated_at: number & {
-            __brand: "UnixTimestamp";
-        };
-        message: string;
-        type: "note";
-        _id?: string | undefined;
-        updated_by?: string | undefined;
-    } | {
-        created_at: number & {
-            __brand: "UnixTimestamp";
-        };
-        created_by: string | null;
-        updated_at: number & {
-            __brand: "UnixTimestamp";
-        };
-        type: "field_changed";
-        field: string;
-        _id?: string | undefined;
-        updated_by?: string | undefined;
-        metadata?: {
-            changes?: {
-                field: string;
-                curr_value?: any;
-                prev_value?: any;
-            }[] | undefined;
-        } | null | undefined;
-        curr_value?: any;
-        prev_value?: any;
-    } | {
-        created_at: number & {
-            __brand: "UnixTimestamp";
-        };
-        created_by: string | null;
-        updated_at: number & {
-            __brand: "UnixTimestamp";
-        };
-        type: "crud";
-        action: "create" | "update" | "delete" | "archive" | "restore";
-        _id?: string | undefined;
-        updated_by?: string | undefined;
-    }, {
-        created_at: number;
-        updated_at: number;
-        message: string;
-        type: "note";
-        _id?: string | undefined;
-        created_by?: string | null | undefined;
-        updated_by?: string | undefined;
-    } | {
-        created_at: number;
-        updated_at: number;
-        type: "field_changed";
-        field: string;
-        _id?: string | undefined;
-        created_by?: string | null | undefined;
-        updated_by?: string | undefined;
-        metadata?: {
-            changes?: {
-                field: string;
-                curr_value?: any;
-                prev_value?: any;
-            }[] | undefined;
-        } | null | undefined;
-        curr_value?: any;
-        prev_value?: any;
-    } | {
-        created_at: number;
-        updated_at: number;
-        type: "crud";
-        action: "create" | "update" | "delete" | "archive" | "restore";
-        _id?: string | undefined;
-        created_by?: string | null | undefined;
-        updated_by?: string | undefined;
-    }>, "many">>;
-    observations: z.ZodDefault<z.ZodNullable<z.ZodString>>;
-    associated_patterns: z.ZodDefault<z.ZodArray<z.ZodObject<{
-        _id: z.ZodString;
-        code: z.ZodString;
-        headsign: z.ZodString;
-        line_id: z.ZodString;
-        route_id: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        _id: string;
-        code: string;
-        line_id: string;
-        headsign: string;
-        route_id: string;
-    }, {
-        _id: string;
-        code: string;
-        line_id: string;
-        headsign: string;
-        route_id: string;
-    }>, "many">>;
-}, "_id" | "name" | "latitude" | "longitude" | "short_name" | "flags" | "legacy_ids" | "lifecycle_status" | "tts_name" | "district_id" | "locality_id" | "municipality_id" | "parish_id"> & {
-    district_name: z.ZodString;
-    line_ids: z.ZodArray<z.ZodString, "many">;
-    locality_name: z.ZodString;
     municipality_name: z.ZodString;
+    name: z.ZodString;
+    parish_id: z.ZodString;
     parish_name: z.ZodString;
     pattern_ids: z.ZodArray<z.ZodString, "many">;
     route_ids: z.ZodArray<z.ZodString, "many">;
+    short_name: z.ZodString;
+    tts_name: z.ZodString;
 }, "strip", z.ZodTypeAny, {
     _id: number;
     name: string;
@@ -322,9 +54,9 @@ export declare const HubStopSchema: z.ZodObject<Pick<{
     district_id: string;
     locality_id: string | null;
     municipality_id: string;
-    parish_id: string | null;
+    parish_id: string;
     district_name: string;
-    locality_name: string;
+    locality_name: string | null;
     municipality_name: string;
     parish_name: string;
     pattern_ids: string[];
@@ -336,25 +68,25 @@ export declare const HubStopSchema: z.ZodObject<Pick<{
     longitude: number;
     short_name: string;
     line_ids: string[];
+    flags: {
+        short_name: string;
+        stop_id: string;
+        agency_ids?: string[] | undefined;
+        is_harmonized?: boolean | undefined;
+    }[];
+    legacy_ids: string[];
+    lifecycle_status: "draft" | "active" | "inactive" | "provisional" | "seasonal" | "voided";
     tts_name: string;
     district_id: string;
+    locality_id: string | null;
     municipality_id: string;
+    parish_id: string;
     district_name: string;
-    locality_name: string;
+    locality_name: string | null;
     municipality_name: string;
     parish_name: string;
     pattern_ids: string[];
     route_ids: string[];
-    flags?: {
-        short_name: string;
-        stop_id: string;
-        agency_ids?: string[] | undefined;
-        is_harmonized?: boolean | undefined;
-    }[] | undefined;
-    legacy_ids?: string[] | undefined;
-    lifecycle_status?: "draft" | "active" | "inactive" | "provisional" | "seasonal" | "voided" | undefined;
-    locality_id?: string | null | undefined;
-    parish_id?: string | null | undefined;
 }>;
 /**
  * Publishable stop data for the Hub Stops API.

package/dist/hub/api/stop.js

@@ -1,27 +1,28 @@
 /* * */
-import { StopSchema } from '../../stops/stop.js';
+import { LifecycleStatusSchema } from '../../_common/status.js';
+import { StopFlagSchema } from '../../stops/flag.js';
+import { StopIdSchema } from '../../stops/stop-id.js';
 import { z } from 'zod';
 /* * */
-export const HubStopSchema = StopSchema.pick({
-    _id: true,
-    district_id: true,
-    flags: true,
-    latitude: true,
-    legacy_ids: true,
-    lifecycle_status: true,
-    locality_id: true,
-    longitude: true,
-    municipality_id: true,
-    name: true,
-    parish_id: true,
-    short_name: true,
-    tts_name: true,
-}).extend({
+export const HubStopSchema = z.object({
+    _id: StopIdSchema,
+    district_id: z.string(),
     district_name: z.string(),
+    flags: z.array(StopFlagSchema),
+    latitude: z.number(),
+    legacy_ids: z.array(z.string()),
+    lifecycle_status: LifecycleStatusSchema,
     line_ids: z.array(z.string()),
-    locality_name: z.string(),
+    locality_id: z.string().nullable(),
+    locality_name: z.string().nullable(),
+    longitude: z.number(),
+    municipality_id: z.string(),
     municipality_name: z.string(),
+    name: z.string(),
+    parish_id: z.string(),
     parish_name: z.string(),
     pattern_ids: z.array(z.string()),
     route_ids: z.array(z.string()),
+    short_name: z.string(),
+    tts_name: z.string(),
 });

package/dist/hub/gtfs/stops.d.ts

@@ -3,8 +3,8 @@ export declare const HubGtfsExportStopsSchema: z.ZodObject<{
     district_id: z.ZodString;
     district_name: z.ZodString;
     legacy_ids: z.ZodString;
-    locality_id: z.ZodString;
-    locality_name: z.ZodString;
+    locality_id: z.ZodOptional<z.ZodString>;
+    locality_name: z.ZodOptional<z.ZodString>;
     location_type: z.ZodEnum<["0", "1", "2", "3", "4"]>;
     municipality_id: z.ZodString;
     municipality_name: z.ZodString;
@@ -23,7 +23,6 @@ export declare const HubGtfsExportStopsSchema: z.ZodObject<{
     stop_id: number;
     legacy_ids: string;
     district_id: string;
-    locality_id: string;
     municipality_id: string;
     parish_id: string;
     location_type: "0" | "1" | "2" | "3" | "4";
@@ -36,14 +35,14 @@ export declare const HubGtfsExportStopsSchema: z.ZodObject<{
     tts_stop_name: string;
     wheelchair_boarding: "0" | "1" | "2";
     district_name: string;
-    locality_name: string;
     municipality_name: string;
     parish_name: string;
+    locality_id?: string | undefined;
+    locality_name?: string | undefined;
 }, {
     stop_id: number;
     legacy_ids: string;
     district_id: string;
-    locality_id: string;
     municipality_id: string;
     parish_id: string;
     location_type: "0" | "1" | "2" | "3" | "4";
@@ -56,9 +55,10 @@ export declare const HubGtfsExportStopsSchema: z.ZodObject<{
     tts_stop_name: string;
     wheelchair_boarding: "0" | "1" | "2";
     district_name: string;
-    locality_name: string;
     municipality_name: string;
     parish_name: string;
+    locality_id?: string | undefined;
+    locality_name?: string | undefined;
 }>;
 /**
  * Structure for the Hub GTFS export of the `stops.txt` file.

package/dist/hub/gtfs/stops.js

@@ -5,8 +5,8 @@ export const HubGtfsExportStopsSchema = z.object({
     district_id: z.string(),
     district_name: z.string(),
     legacy_ids: z.string(),
-    locality_id: z.string(),
-    locality_name: z.string(),
+    locality_id: z.string().optional(),
+    locality_name: z.string().optional(),
     location_type: z.enum(['0', '1', '2', '3', '4']),
     municipality_id: z.string(),
     municipality_name: z.string(),

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@tmlmobilidade/types",
-	"version": "20260601.1620.24",
+	"version": "20260601.1657.26",
 	"author": {
 		"email": "iso@tmlmobilidade.pt",
 		"name": "TML-ISO"