@tmlmobilidade/go-types-infrastructure 20260828.1636.54

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './stops/index.js';

package/dist/index.js

@@ -0,0 +1 @@
+export * from './stops/index.js';

package/dist/stops/connections.d.ts

@@ -0,0 +1,4 @@
+import { z } from 'zod';
+export declare const StopConnectionValues: readonly ["ferry", "light_rail", "subway", "train", "boat", "airport", "bike_sharing", "bike_parking", "car_parking"];
+export declare const StopConnectionSchema: z.ZodEnum<["ferry", "light_rail", "subway", "train", "boat", "airport", "bike_sharing", "bike_parking", "car_parking"]>;
+export type StopConnection = z.infer<typeof StopConnectionSchema>;

package/dist/stops/connections.js

@@ -0,0 +1,15 @@
+/* * */
+import { z } from 'zod';
+/* * */
+export const StopConnectionValues = [
+    'ferry',
+    'light_rail',
+    'subway',
+    'train',
+    'boat',
+    'airport',
+    'bike_sharing',
+    'bike_parking',
+    'car_parking',
+];
+export const StopConnectionSchema = z.enum(StopConnectionValues);

package/dist/stops/equipment.d.ts

@@ -0,0 +1,4 @@
+import { z } from 'zod';
+export declare const StopEquipmentValues: readonly ["pip", "mupi", "mini_pip"];
+export declare const StopEquipmentSchema: z.ZodEnum<["pip", "mupi", "mini_pip"]>;
+export type StopEquipment = z.infer<typeof StopEquipmentSchema>;

package/dist/stops/equipment.js

@@ -0,0 +1,9 @@
+/* * */
+import { z } from 'zod';
+/* * */
+export const StopEquipmentValues = [
+    'pip',
+    'mupi',
+    'mini_pip',
+];
+export const StopEquipmentSchema = z.enum(StopEquipmentValues);

package/dist/stops/facilities.d.ts

@@ -0,0 +1,4 @@
+import { z } from 'zod';
+export declare const StopFacilityValues: readonly ["fire_station", "health_clinic", "historic_building", "hospital", "police_station", "school", "shopping", "transit_office", "university", "beach"];
+export declare const StopFacilitySchema: z.ZodEnum<["fire_station", "health_clinic", "historic_building", "hospital", "police_station", "school", "shopping", "transit_office", "university", "beach"]>;
+export type StopFacility = z.infer<typeof StopFacilitySchema>;

package/dist/stops/facilities.js

@@ -0,0 +1,16 @@
+/* * */
+import { z } from 'zod';
+/* * */
+export const StopFacilityValues = [
+    'fire_station',
+    'health_clinic',
+    'historic_building',
+    'hospital',
+    'police_station',
+    'school',
+    'shopping',
+    'transit_office',
+    'university',
+    'beach',
+];
+export const StopFacilitySchema = z.enum(StopFacilityValues);

package/dist/stops/flag.d.ts

@@ -0,0 +1,18 @@
+import { z } from 'zod';
+export declare const StopFlagSchema: z.ZodObject<{
+    agency_ids: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+    is_harmonized: z.ZodDefault<z.ZodBoolean>;
+    short_name: z.ZodString;
+    stop_id: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    agency_ids: string[];
+    is_harmonized: boolean;
+    short_name: string;
+    stop_id: string;
+}, {
+    short_name: string;
+    stop_id: string;
+    agency_ids?: string[] | undefined;
+    is_harmonized?: boolean | undefined;
+}>;
+export type StopFlag = z.infer<typeof StopFlagSchema>;

package/dist/stops/flag.js

@@ -0,0 +1,9 @@
+/* * */
+import { z } from 'zod';
+/* * */
+export const StopFlagSchema = z.object({
+    agency_ids: z.array(z.string()).default([]),
+    is_harmonized: z.boolean().default(false),
+    short_name: z.string(),
+    stop_id: z.string(),
+});

package/dist/stops/index.d.ts

@@ -0,0 +1,11 @@
+export * from './connections.js';
+export * from './equipment.js';
+export * from './facilities.js';
+export * from './flag.js';
+export * from './jurisdiction.js';
+export * from './name-abbreviations.js';
+export * from './parent-station.js';
+export * from './road-type.js';
+export * from './stop-area.js';
+export * from './stop-id.js';
+export * from './stop.js';

package/dist/stops/index.js

@@ -0,0 +1,11 @@
+export * from './connections.js';
+export * from './equipment.js';
+export * from './facilities.js';
+export * from './flag.js';
+export * from './jurisdiction.js';
+export * from './name-abbreviations.js';
+export * from './parent-station.js';
+export * from './road-type.js';
+export * from './stop-area.js';
+export * from './stop-id.js';
+export * from './stop.js';

package/dist/stops/jurisdiction.d.ts

@@ -0,0 +1,4 @@
+import { z } from 'zod';
+export declare const StopJurisdictionValues: readonly ["ip", "municipality", "other", "unknown"];
+export declare const StopJurisdictionSchema: z.ZodEnum<["ip", "municipality", "other", "unknown"]>;
+export type StopJurisdiction = z.infer<typeof StopJurisdictionSchema>;

package/dist/stops/jurisdiction.js

@@ -0,0 +1,10 @@
+/* * */
+import { z } from 'zod';
+/* * */
+export const StopJurisdictionValues = [
+    'ip',
+    'municipality',
+    'other',
+    'unknown',
+];
+export const StopJurisdictionSchema = z.enum(StopJurisdictionValues);

package/dist/stops/name-abbreviations.d.ts

@@ -0,0 +1,11 @@
+export interface AbbreviationRule {
+    enabled: boolean;
+    phrase: string;
+    replacement: string;
+}
+/**
+ * These are the rules for abbreviating stop names.
+ * They follow the CTT National Postal Service guidelines,
+ * with some additional customizations for TML.
+ */
+export declare const StopNameAbbreviationRules: AbbreviationRule[];

package/dist/stops/name-abbreviations.js

@@ -0,0 +1,117 @@
+/* * */
+/**
+ * These are the rules for abbreviating stop names.
+ * They follow the CTT National Postal Service guidelines,
+ * with some additional customizations for TML.
+ */
+export const StopNameAbbreviationRules = [
+    //
+    // TML: Street & Place names
+    { enabled: true, phrase: 'Quinta', replacement: 'Qta' },
+    { enabled: true, phrase: 'Largo', replacement: 'Lgo' },
+    { enabled: true, phrase: 'Estrada Municipal', replacement: 'EM' },
+    { enabled: true, phrase: 'Estrada Nacional', replacement: 'EN' },
+    //
+    // TML: People
+    { enabled: true, phrase: 'Santo', replacement: 'Sto' },
+    { enabled: true, phrase: 'Santa', replacement: 'Sta' },
+    //
+    // TML: Facilities
+    { enabled: true, phrase: 'Cooperativa', replacement: 'Coop' },
+    { enabled: true, phrase: 'Câmara Municipal', replacement: 'CM' },
+    { enabled: false, phrase: 'Hospital', replacement: 'Hosp' },
+    { enabled: false, phrase: 'Escola', replacement: 'Esc' },
+    //
+    // CTT: Tipo de artéria
+    { enabled: true, phrase: 'Alameda', replacement: 'Al' },
+    { enabled: true, phrase: 'Avenida', replacement: 'Av' },
+    { enabled: true, phrase: 'Azinhaga', replacement: 'Az' },
+    { enabled: true, phrase: 'Bairro', replacement: 'Br' },
+    { enabled: true, phrase: 'Beco', replacement: 'Bc' },
+    { enabled: true, phrase: 'Calçada', replacement: 'Cc' },
+    { enabled: true, phrase: 'Calçadinha', replacement: 'Ccnh' },
+    { enabled: true, phrase: 'Caminho', replacement: 'Cam' },
+    { enabled: true, phrase: 'Casa', replacement: 'Cs' },
+    { enabled: true, phrase: 'Conjunto', replacement: 'Cj' },
+    { enabled: true, phrase: 'Escadas', replacement: 'Esc' },
+    { enabled: true, phrase: 'Escadinhas', replacement: 'Escnh' },
+    { enabled: true, phrase: 'Estrada', replacement: 'Estr' },
+    { enabled: true, phrase: 'Jardim', replacement: 'Jd' },
+    { enabled: true, phrase: 'Loteamento', replacement: 'Lot' },
+    { enabled: true, phrase: 'Parque', replacement: 'Pq' },
+    { enabled: true, phrase: 'Pátio', replacement: 'Pat' },
+    { enabled: true, phrase: 'Praça', replacement: 'Pc' },
+    { enabled: true, phrase: 'Praceta', replacement: 'Pct' },
+    { enabled: true, phrase: 'Prolongamento', replacement: 'Prl' },
+    { enabled: true, phrase: 'Quadra', replacement: 'Qd' },
+    { enabled: true, phrase: 'Rotunda', replacement: 'Rot' },
+    { enabled: true, phrase: 'Rua', replacement: 'R' },
+    { enabled: true, phrase: 'Transversal', replacement: 'Transv' },
+    { enabled: true, phrase: 'Travessa', replacement: 'Tv' },
+    { enabled: true, phrase: 'Urbanização', replacement: 'Urb' },
+    { enabled: true, phrase: 'Vila', replacement: 'Vl' },
+    { enabled: true, phrase: 'Zona', replacement: 'Zn' },
+    //
+    // CTT: Tipo de alojamento
+    { enabled: true, phrase: 'Cave', replacement: 'Cv' },
+    { enabled: true, phrase: 'Direito', replacement: 'Dto' },
+    { enabled: true, phrase: 'Esquerdo', replacement: 'Esq' },
+    { enabled: true, phrase: 'Frente', replacement: 'Ft' },
+    { enabled: true, phrase: 'Fundos', replacement: 'Fds' },
+    { enabled: true, phrase: 'Habitação', replacement: 'Hab' },
+    { enabled: true, phrase: 'Loja', replacement: 'Lj' },
+    { enabled: true, phrase: 'Rés-do-chão', replacement: 'R/C' },
+    { enabled: true, phrase: 'Sobreloja', replacement: 'Slj' },
+    { enabled: true, phrase: 'Subcave', replacement: 'Scv' },
+    //
+    // CTT: Tipo de porta
+    { enabled: true, phrase: 'Apartamento', replacement: 'Apto' },
+    { enabled: true, phrase: 'Bloco', replacement: 'Bl' },
+    { enabled: true, phrase: 'Edifício', replacement: 'Edf' },
+    { enabled: true, phrase: 'Lote', replacement: 'Lt' },
+    { enabled: true, phrase: 'Torre', replacement: 'Tr' },
+    { enabled: true, phrase: 'Vivenda', replacement: 'Vv' },
+    //
+    // CTT: Abreviatura de título
+    { enabled: true, phrase: 'Alferes', replacement: 'Alf' },
+    { enabled: true, phrase: 'Almirante', replacement: 'Alm' },
+    { enabled: true, phrase: 'Arquiteto', replacement: 'Arq' },
+    { enabled: true, phrase: 'Brigadeiro', replacement: 'Brig' },
+    { enabled: true, phrase: 'Capitão', replacement: 'Cap' },
+    { enabled: true, phrase: 'Comandante', replacement: 'Cmdt' },
+    { enabled: true, phrase: 'Comendador', replacement: 'Comend' },
+    { enabled: true, phrase: 'Conselheiro', replacement: 'Cons' },
+    { enabled: true, phrase: 'Coronel', replacement: 'Cel' },
+    { enabled: true, phrase: 'Dom', replacement: 'D' },
+    { enabled: true, phrase: 'Dona', replacement: 'Da' },
+    { enabled: true, phrase: 'Doutor', replacement: 'Dr' },
+    { enabled: true, phrase: 'Doutora', replacement: 'Dr' },
+    { enabled: true, phrase: 'Duque', replacement: 'Dq' },
+    { enabled: true, phrase: 'Embaixador', replacement: 'Emb' },
+    { enabled: true, phrase: 'Engenheira', replacement: 'Eng' },
+    { enabled: true, phrase: 'Engenheiro', replacement: 'Eng' },
+    { enabled: true, phrase: 'Frei', replacement: 'Fr' },
+    { enabled: true, phrase: 'General', replacement: 'Gen' },
+    { enabled: true, phrase: 'Infante', replacement: 'Inf' },
+    { enabled: true, phrase: 'Marquês', replacement: 'Mq' },
+    { enabled: true, phrase: 'Presidente', replacement: 'Pres' },
+    { enabled: true, phrase: 'Professor', replacement: 'Prof' },
+    { enabled: true, phrase: 'Professora', replacement: 'Prof' },
+    { enabled: true, phrase: 'São', replacement: 'S' },
+    { enabled: true, phrase: 'Sargento', replacement: 'Sarg' },
+    { enabled: true, phrase: 'Tenente', replacement: 'Ten' },
+    { enabled: true, phrase: 'Visconde', replacement: 'Visc' },
+    //
+    // CTT: Diversos
+    { enabled: true, phrase: 'Associação', replacement: 'Ass' },
+    { enabled: true, phrase: 'Instituto', replacement: 'Inst' },
+    { enabled: true, phrase: 'Lugar', replacement: 'Lug' },
+    { enabled: true, phrase: 'Ministério', replacement: 'Min' },
+    { enabled: true, phrase: 'Ministério', replacement: 'Min' },
+    { enabled: true, phrase: 'Projetada', replacement: 'Proj' },
+    { enabled: true, phrase: 'Sala', replacement: 'Sl' },
+    { enabled: true, phrase: 'Sem Número', replacement: 'S/N' },
+    { enabled: true, phrase: 'Sociedade', replacement: 'Soc' },
+    { enabled: false, phrase: 'Universidade', replacement: 'Univ' },
+    //
+];

package/dist/stops/parent-station.d.ts

@@ -0,0 +1,76 @@
+import { z } from 'zod';
+export declare const ParentStationSchema: z.ZodObject<{
+    created_at: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, import("@tmlmobilidade/go-types-shared").UnixTimestamp, string | number>;
+    created_by: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    is_locked: z.ZodDefault<z.ZodBoolean>;
+    updated_at: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, import("@tmlmobilidade/go-types-shared").UnixTimestamp, string | number>;
+    updated_by: z.ZodOptional<z.ZodString>;
+} & {
+    _id: z.ZodString;
+    stop_ids: z.ZodArray<z.ZodString, "many">;
+    title: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    _id: string;
+    stop_ids: string[];
+    title: string;
+    created_at: number & {
+        __brand: "UnixTimestamp";
+    };
+    created_by: string | null;
+    is_locked: boolean;
+    updated_at: number & {
+        __brand: "UnixTimestamp";
+    };
+    updated_by?: string | undefined;
+}, {
+    _id: string;
+    stop_ids: string[];
+    title: string;
+    created_at: string | number;
+    updated_at: string | number;
+    created_by?: string | null | undefined;
+    is_locked?: boolean | undefined;
+    updated_by?: string | undefined;
+}>;
+export declare const CreateParentStationSchema: z.ZodObject<Omit<{
+    created_at: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, import("@tmlmobilidade/go-types-shared").UnixTimestamp, string | number>;
+    created_by: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    is_locked: z.ZodDefault<z.ZodBoolean>;
+    updated_at: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, import("@tmlmobilidade/go-types-shared").UnixTimestamp, string | number>;
+    updated_by: z.ZodOptional<z.ZodString>;
+} & {
+    _id: z.ZodString;
+    stop_ids: z.ZodArray<z.ZodString, "many">;
+    title: z.ZodString;
+}, "_id" | "created_at" | "updated_at">, "strip", z.ZodTypeAny, {
+    stop_ids: string[];
+    title: string;
+    created_by: string | null;
+    is_locked: boolean;
+    updated_by?: string | undefined;
+}, {
+    stop_ids: string[];
+    title: string;
+    created_by?: string | null | undefined;
+    is_locked?: boolean | undefined;
+    updated_by?: string | undefined;
+}>;
+export declare const UpdateParentStationSchema: z.ZodObject<{
+    stop_ids: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    title: z.ZodOptional<z.ZodString>;
+    is_locked: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    updated_by: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    stop_ids?: string[] | undefined;
+    title?: string | undefined;
+    is_locked?: boolean | undefined;
+    updated_by?: string | undefined;
+}, {
+    stop_ids?: string[] | undefined;
+    title?: string | undefined;
+    is_locked?: boolean | undefined;
+    updated_by?: string | undefined;
+}>;
+export type ParentStation = z.infer<typeof ParentStationSchema>;
+export type CreateParentStationDto = z.infer<typeof CreateParentStationSchema>;
+export type UpdateParentStationDto = z.infer<typeof UpdateParentStationSchema>;

package/dist/stops/parent-station.js

@@ -0,0 +1,11 @@
+/* * */
+import { BaseDocumentSchema } from '@tmlmobilidade/go-types-shared';
+import { z } from 'zod';
+/* * */
+export const ParentStationSchema = BaseDocumentSchema.extend({
+    _id: z.string(),
+    stop_ids: z.array(z.string()),
+    title: z.string(),
+});
+export const CreateParentStationSchema = ParentStationSchema.omit({ _id: true, created_at: true, updated_at: true });
+export const UpdateParentStationSchema = CreateParentStationSchema.omit({ created_by: true }).partial();

package/dist/stops/road-type.d.ts

@@ -0,0 +1,3 @@
+import { z } from 'zod';
+export declare const StopRoadTypeSchema: z.ZodEnum<["complementary_itinerary", "highway", "main_itinerary", "national_road", "regional_road", "secondary_road", "unknown"]>;
+export type StopRoadType = z.infer<typeof StopRoadTypeSchema>;

package/dist/stops/road-type.js

@@ -0,0 +1,13 @@
+/* * */
+import { z } from 'zod';
+/* * */
+const StopRoadTypeValues = [
+    'complementary_itinerary',
+    'highway',
+    'main_itinerary',
+    'national_road',
+    'regional_road',
+    'secondary_road',
+    'unknown',
+];
+export const StopRoadTypeSchema = z.enum(StopRoadTypeValues);

package/dist/stops/stop-area.d.ts

@@ -0,0 +1,67 @@
+import { z } from 'zod';
+export declare const StopAreaSchema: z.ZodObject<{
+    created_at: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, import("@tmlmobilidade/go-types-shared").UnixTimestamp, string | number>;
+    created_by: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    is_locked: z.ZodDefault<z.ZodBoolean>;
+    updated_at: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, import("@tmlmobilidade/go-types-shared").UnixTimestamp, string | number>;
+    updated_by: z.ZodOptional<z.ZodString>;
+} & {
+    _id: z.ZodString;
+    parent_station_ids: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    _id: string;
+    created_at: number & {
+        __brand: "UnixTimestamp";
+    };
+    created_by: string | null;
+    is_locked: boolean;
+    updated_at: number & {
+        __brand: "UnixTimestamp";
+    };
+    parent_station_ids: string[];
+    updated_by?: string | undefined;
+}, {
+    _id: string;
+    created_at: string | number;
+    updated_at: string | number;
+    parent_station_ids: string[];
+    created_by?: string | null | undefined;
+    is_locked?: boolean | undefined;
+    updated_by?: string | undefined;
+}>;
+export declare const CreateStopAreaSchema: z.ZodObject<Omit<{
+    created_at: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, import("@tmlmobilidade/go-types-shared").UnixTimestamp, string | number>;
+    created_by: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    is_locked: z.ZodDefault<z.ZodBoolean>;
+    updated_at: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, import("@tmlmobilidade/go-types-shared").UnixTimestamp, string | number>;
+    updated_by: z.ZodOptional<z.ZodString>;
+} & {
+    _id: z.ZodString;
+    parent_station_ids: z.ZodArray<z.ZodString, "many">;
+}, "_id" | "created_at" | "updated_at">, "strip", z.ZodTypeAny, {
+    created_by: string | null;
+    is_locked: boolean;
+    parent_station_ids: string[];
+    updated_by?: string | undefined;
+}, {
+    parent_station_ids: string[];
+    created_by?: string | null | undefined;
+    is_locked?: boolean | undefined;
+    updated_by?: string | undefined;
+}>;
+export declare const UpdateStopAreaSchema: z.ZodObject<{
+    is_locked: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    updated_by: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    parent_station_ids: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+}, "strip", z.ZodTypeAny, {
+    is_locked?: boolean | undefined;
+    updated_by?: string | undefined;
+    parent_station_ids?: string[] | undefined;
+}, {
+    is_locked?: boolean | undefined;
+    updated_by?: string | undefined;
+    parent_station_ids?: string[] | undefined;
+}>;
+export type StopArea = z.infer<typeof StopAreaSchema>;
+export type CreateStopAreaDto = z.infer<typeof CreateStopAreaSchema>;
+export type UpdateStopAreaDto = z.infer<typeof UpdateStopAreaSchema>;

package/dist/stops/stop-area.js

@@ -0,0 +1,10 @@
+/* * */
+import { BaseDocumentSchema } from '@tmlmobilidade/go-types-shared';
+import { z } from 'zod';
+/* * */
+export const StopAreaSchema = BaseDocumentSchema.extend({
+    _id: z.string(),
+    parent_station_ids: z.array(z.string()),
+});
+export const CreateStopAreaSchema = StopAreaSchema.omit({ _id: true, created_at: true, updated_at: true });
+export const UpdateStopAreaSchema = CreateStopAreaSchema.omit({ created_by: true }).partial();

package/dist/stops/stop-id.d.ts

@@ -0,0 +1,13 @@
+import { z } from 'zod';
+export declare const StopIdSchema: z.ZodNumber;
+/**
+ * Represents a Stop ID, which is a unique identifier
+ * for a stop in the transportation system.
+ */
+export type StopId = z.infer<typeof StopIdSchema>;
+/**
+ * Validates the structure of a Stop ID.
+ * @param value The value to validate as a Stop ID.
+ * @returns The validated Stop ID if valid, or false if invalid.
+ */
+export declare function validateStopIdStructure(value?: null | number | StopId | string): false | StopId;

package/dist/stops/stop-id.js

@@ -0,0 +1,29 @@
+/* * */
+import { z } from 'zod';
+/* * */
+export const StopIdSchema = z
+    .number()
+    .min(100_000)
+    .max(999_999);
+/**
+ * Validates the structure of a Stop ID.
+ * @param value The value to validate as a Stop ID.
+ * @returns The validated Stop ID if valid, or false if invalid.
+ */
+export function validateStopIdStructure(value) {
+    // Return false if no value is provided
+    if (!value)
+        return false;
+    // Transform the value into a number if it's a string
+    if (typeof value === 'string')
+        value = parseInt(value, 10);
+    // Return false if the value is not a number or is NaN
+    if (typeof value !== 'number' || isNaN(value))
+        return false;
+    // Return false if the value is outside the valid range for Stop IDs
+    if (value < 100_000 || value > 999_999)
+        return false;
+    // Return the value as a Stop ID
+    // if it passes all checks.
+    return value;
+}