@tmlmobilidade/types 20260612.214.31 → 20260612.1446.12

package/dist/gtfs/distance.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Converts pattern extension metres to GTFS kilometres (shapes.txt, stop_times.txt).
+ * Rounds to 3 decimal places (1 m precision), matching stop_times export.
+ */
+export declare function metersToGtfsKm(meters: number): number;
+/**
+ * Cumulative shape distance in metres at a shape point.
+ * The last point (index pointCount - 1) equals extensionMeters.
+ */
+export declare function shapeDistTraveledMetersAtPoint(extensionMeters: number, pointIndex: number, pointCount: number): number;

package/dist/gtfs/distance.js

@@ -0,0 +1,21 @@
+/* * */
+/**
+ * Converts pattern extension metres to GTFS kilometres (shapes.txt, stop_times.txt).
+ * Rounds to 3 decimal places (1 m precision), matching stop_times export.
+ */
+export function metersToGtfsKm(meters) {
+    return Math.round((meters / 1000) * 1000) / 1000;
+}
+/**
+ * Cumulative shape distance in metres at a shape point.
+ * The last point (index pointCount - 1) equals extensionMeters.
+ */
+export function shapeDistTraveledMetersAtPoint(extensionMeters, pointIndex, pointCount) {
+    if (pointCount <= 1 || extensionMeters <= 0)
+        return 0;
+    if (pointIndex <= 0)
+        return 0;
+    if (pointIndex >= pointCount - 1)
+        return extensionMeters;
+    return (pointIndex / (pointCount - 1)) * extensionMeters;
+}

package/dist/gtfs/index.d.ts

@@ -2,6 +2,7 @@ export * from './agency.js';
 export * from './calendar-dates.js';
 export * from './calendar.js';
 export * from './common.js';
+export * from './distance.js';
 export * from './feed-info.js';
 export * from './routes.js';
 export * from './service-alert.js';

package/dist/gtfs/index.js

@@ -2,6 +2,7 @@ export * from './agency.js';
 export * from './calendar-dates.js';
 export * from './calendar.js';
 export * from './common.js';
+export * from './distance.js';
 export * from './feed-info.js';
 export * from './routes.js';
 export * from './service-alert.js';

package/dist/offer/index.d.ts

@@ -7,4 +7,5 @@ export * from './route.js';
 export * from './rules.js';
 export * from './transport-type.js';
 export * from './typology.js';
+export * from './vkm.js';
 export * from './zone.js';

package/dist/offer/index.js

@@ -7,4 +7,5 @@ export * from './route.js';
 export * from './rules.js';
 export * from './transport-type.js';
 export * from './typology.js';
+export * from './vkm.js';
 export * from './zone.js';

package/dist/offer/vkm.d.ts

@@ -0,0 +1,207 @@
+import { z } from 'zod';
+export declare const VkmCalculationMethodValues: readonly ["rolling_year", "fixed_range"];
+export declare const VkmCalculationMethodSchema: z.ZodEnum<["rolling_year", "fixed_range"]>;
+export type VkmCalculationMethod = z.infer<typeof VkmCalculationMethodSchema>;
+export declare const VkmExtensionSourceValues: readonly ["go", "stop_times"];
+export declare const VkmExtensionSourceSchema: z.ZodEnum<["go", "stop_times"]>;
+export type VkmExtensionSource = z.infer<typeof VkmExtensionSourceSchema>;
+export declare const LegacyVkmDayTypeSchema: z.ZodEnum<["1", "2", "3"]>;
+export type LegacyVkmDayType = z.infer<typeof LegacyVkmDayTypeSchema>;
+export declare const CalculateVkmSchema: z.ZodObject<{
+    agency_id: z.ZodString;
+    calculation_method: z.ZodEnum<["rolling_year", "fixed_range"]>;
+    end_date: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodString, import("@tmlmobilidade/go-types-shared").OperationalDate, string>>>;
+    extension_source: z.ZodEnum<["go", "stop_times"]>;
+    start_date: z.ZodEffects<z.ZodString, import("@tmlmobilidade/go-types-shared").OperationalDate, string>;
+}, "strip", z.ZodTypeAny, {
+    agency_id: string;
+    start_date: string & {
+        __brand: "OperationalDate";
+    };
+    calculation_method: "rolling_year" | "fixed_range";
+    extension_source: "go" | "stop_times";
+    end_date?: import("@tmlmobilidade/go-types-shared").OperationalDate | null | undefined;
+}, {
+    agency_id: string;
+    start_date: string;
+    calculation_method: "rolling_year" | "fixed_range";
+    extension_source: "go" | "stop_times";
+    end_date?: string | null | undefined;
+}>;
+export declare const VkmCalculationInputsSchema: z.ZodObject<{
+    agency_id: z.ZodString;
+    agency_name: z.ZodString;
+    calculation_method: z.ZodEnum<["rolling_year", "fixed_range"]>;
+    end_date: z.ZodEffects<z.ZodString, import("@tmlmobilidade/go-types-shared").OperationalDate, string>;
+    price_per_km: z.ZodNumber;
+    start_date: z.ZodEffects<z.ZodString, import("@tmlmobilidade/go-types-shared").OperationalDate, string>;
+    total_vkm_per_year: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    price_per_km: number;
+    agency_id: string;
+    start_date: string & {
+        __brand: "OperationalDate";
+    };
+    agency_name: string;
+    calculation_method: "rolling_year" | "fixed_range";
+    end_date: string & {
+        __brand: "OperationalDate";
+    };
+    total_vkm_per_year: number;
+}, {
+    price_per_km: number;
+    agency_id: string;
+    start_date: string;
+    agency_name: string;
+    calculation_method: "rolling_year" | "fixed_range";
+    end_date: string;
+    total_vkm_per_year: number;
+}>;
+export declare const VkmPeriodResultSchema: z.ZodObject<{
+    code: z.ZodNullable<z.ZodString>;
+    day_type_one: z.ZodNumber;
+    day_type_three: z.ZodNumber;
+    day_type_two: z.ZodNumber;
+    id: z.ZodNullable<z.ZodString>;
+    name: z.ZodString;
+    total: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    code: string | null;
+    name: string;
+    id: string | null;
+    total: number;
+    day_type_one: number;
+    day_type_three: number;
+    day_type_two: number;
+}, {
+    code: string | null;
+    name: string;
+    id: string | null;
+    total: number;
+    day_type_one: number;
+    day_type_three: number;
+    day_type_two: number;
+}>;
+export declare const VkmCalculationResultSchema: z.ZodObject<{
+    day_type_one: z.ZodNumber;
+    day_type_three: z.ZodNumber;
+    day_type_two: z.ZodNumber;
+    inputs: z.ZodObject<{
+        agency_id: z.ZodString;
+        agency_name: z.ZodString;
+        calculation_method: z.ZodEnum<["rolling_year", "fixed_range"]>;
+        end_date: z.ZodEffects<z.ZodString, import("@tmlmobilidade/go-types-shared").OperationalDate, string>;
+        price_per_km: z.ZodNumber;
+        start_date: z.ZodEffects<z.ZodString, import("@tmlmobilidade/go-types-shared").OperationalDate, string>;
+        total_vkm_per_year: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        price_per_km: number;
+        agency_id: string;
+        start_date: string & {
+            __brand: "OperationalDate";
+        };
+        agency_name: string;
+        calculation_method: "rolling_year" | "fixed_range";
+        end_date: string & {
+            __brand: "OperationalDate";
+        };
+        total_vkm_per_year: number;
+    }, {
+        price_per_km: number;
+        agency_id: string;
+        start_date: string;
+        agency_name: string;
+        calculation_method: "rolling_year" | "fixed_range";
+        end_date: string;
+        total_vkm_per_year: number;
+    }>;
+    periods: z.ZodArray<z.ZodObject<{
+        code: z.ZodNullable<z.ZodString>;
+        day_type_one: z.ZodNumber;
+        day_type_three: z.ZodNumber;
+        day_type_two: z.ZodNumber;
+        id: z.ZodNullable<z.ZodString>;
+        name: z.ZodString;
+        total: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        code: string | null;
+        name: string;
+        id: string | null;
+        total: number;
+        day_type_one: number;
+        day_type_three: number;
+        day_type_two: number;
+    }, {
+        code: string | null;
+        name: string;
+        id: string | null;
+        total: number;
+        day_type_one: number;
+        day_type_three: number;
+        day_type_two: number;
+    }>, "many">;
+    total_from_distance: z.ZodNumber;
+    total_from_shape: z.ZodNumber;
+    total_in_euros: z.ZodNumber;
+    total_relative_to_contract: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    day_type_one: number;
+    day_type_three: number;
+    day_type_two: number;
+    inputs: {
+        price_per_km: number;
+        agency_id: string;
+        start_date: string & {
+            __brand: "OperationalDate";
+        };
+        agency_name: string;
+        calculation_method: "rolling_year" | "fixed_range";
+        end_date: string & {
+            __brand: "OperationalDate";
+        };
+        total_vkm_per_year: number;
+    };
+    periods: {
+        code: string | null;
+        name: string;
+        id: string | null;
+        total: number;
+        day_type_one: number;
+        day_type_three: number;
+        day_type_two: number;
+    }[];
+    total_from_distance: number;
+    total_from_shape: number;
+    total_in_euros: number;
+    total_relative_to_contract: number;
+}, {
+    day_type_one: number;
+    day_type_three: number;
+    day_type_two: number;
+    inputs: {
+        price_per_km: number;
+        agency_id: string;
+        start_date: string;
+        agency_name: string;
+        calculation_method: "rolling_year" | "fixed_range";
+        end_date: string;
+        total_vkm_per_year: number;
+    };
+    periods: {
+        code: string | null;
+        name: string;
+        id: string | null;
+        total: number;
+        day_type_one: number;
+        day_type_three: number;
+        day_type_two: number;
+    }[];
+    total_from_distance: number;
+    total_from_shape: number;
+    total_in_euros: number;
+    total_relative_to_contract: number;
+}>;
+export type CalculateVkmDto = z.infer<typeof CalculateVkmSchema>;
+export type VkmCalculationInputs = z.infer<typeof VkmCalculationInputsSchema>;
+export type VkmCalculationResult = z.infer<typeof VkmCalculationResultSchema>;
+export type VkmPeriodResult = z.infer<typeof VkmPeriodResultSchema>;

package/dist/offer/vkm.js

@@ -0,0 +1,51 @@
+import { OperationalDateSchema } from '@tmlmobilidade/go-types-shared';
+import { z } from 'zod';
+/* * */
+export const VkmCalculationMethodValues = [
+    'rolling_year',
+    'fixed_range',
+];
+export const VkmCalculationMethodSchema = z.enum(VkmCalculationMethodValues);
+export const VkmExtensionSourceValues = [
+    'go',
+    'stop_times',
+];
+export const VkmExtensionSourceSchema = z.enum(VkmExtensionSourceValues);
+export const LegacyVkmDayTypeSchema = z.enum(['1', '2', '3']);
+/* * */
+export const CalculateVkmSchema = z.object({
+    agency_id: z.string(),
+    calculation_method: VkmCalculationMethodSchema,
+    end_date: OperationalDateSchema.nullable().optional(),
+    extension_source: VkmExtensionSourceSchema,
+    start_date: OperationalDateSchema,
+});
+export const VkmCalculationInputsSchema = z.object({
+    agency_id: z.string(),
+    agency_name: z.string(),
+    calculation_method: VkmCalculationMethodSchema,
+    end_date: OperationalDateSchema,
+    price_per_km: z.number(),
+    start_date: OperationalDateSchema,
+    total_vkm_per_year: z.number(),
+});
+export const VkmPeriodResultSchema = z.object({
+    code: z.string().nullable(),
+    day_type_one: z.number(),
+    day_type_three: z.number(),
+    day_type_two: z.number(),
+    id: z.string().nullable(),
+    name: z.string(),
+    total: z.number(),
+});
+export const VkmCalculationResultSchema = z.object({
+    day_type_one: z.number(),
+    day_type_three: z.number(),
+    day_type_two: z.number(),
+    inputs: VkmCalculationInputsSchema,
+    periods: z.array(VkmPeriodResultSchema),
+    total_from_distance: z.number(),
+    total_from_shape: z.number(),
+    total_in_euros: z.number(),
+    total_relative_to_contract: z.number(),
+});

package/package.json

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