@tmlmobilidade/go-types-apex 20260611.1527.25

package/dist/simplified/simplified-apex-validation.d.ts

@@ -0,0 +1,200 @@
+import { z } from 'zod';
+export declare const SimplifiedApexValidationSchema: z.ZodObject<{
+    _id: z.ZodString;
+    agency_id: z.ZodString;
+    apex_version: z.ZodString;
+    card_serial_number: z.ZodString;
+    category: z.ZodNullable<z.ZodEnum<["prepaid", "subscription", "on_board_sale"]>>;
+    created_at: z.ZodEffects<z.ZodNumber, import("@tmlmobilidade/go-types-shared").UnixTimestamp, number>;
+    device_id: z.ZodString;
+    event_type: z.ZodNumber;
+    is_ok: z.ZodBoolean;
+    is_ok_pcgi: z.ZodBoolean;
+    is_passenger: z.ZodBoolean;
+    line_id: z.ZodString;
+    mac_ase_counter_value: z.ZodNumber;
+    mac_sam_serial_number: z.ZodNumber;
+    on_board_refund_id: z.ZodNullable<z.ZodString>;
+    on_board_sale_id: z.ZodNullable<z.ZodString>;
+    pattern_id: z.ZodString;
+    product_id: z.ZodString;
+    received_at: z.ZodEffects<z.ZodNumber, import("@tmlmobilidade/go-types-shared").UnixTimestamp, number>;
+    stop_id: z.ZodString;
+    trip_id: z.ZodString;
+    units_qty: z.ZodNullable<z.ZodNumber>;
+    validation_status: z.ZodNativeEnum<{
+        readonly _0_ContractValid: 0;
+        readonly _1_Antipassback: 1;
+        readonly _2_CardInBlackList: 2;
+        readonly _3_SamInBlackList: 3;
+        readonly _4_CardInWhiteList: 4;
+        readonly _5_ProfileInWhiteList: 5;
+        readonly _6_Interchange: 6;
+        readonly _7_Interrupted: 7;
+        readonly _8_NoValidContract: 8;
+        readonly _9_CardInvalidated: 9;
+        readonly _10_EventsFull: 10;
+        readonly _11_NotEnoughUnits: 11;
+        readonly _12_ContractExpired: 12;
+        readonly _13_MaxValue: 13;
+    }>;
+    vehicle_id: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    _id: string;
+    agency_id: string;
+    created_at: number & {
+        __brand: "UnixTimestamp";
+    };
+    is_ok: boolean;
+    received_at: number & {
+        __brand: "UnixTimestamp";
+    };
+    apex_version: string;
+    device_id: string;
+    event_type: number;
+    is_ok_pcgi: boolean;
+    line_id: string;
+    mac_ase_counter_value: number;
+    mac_sam_serial_number: number;
+    pattern_id: string;
+    product_id: string;
+    stop_id: string;
+    trip_id: string;
+    units_qty: number | null;
+    vehicle_id: number;
+    card_serial_number: string;
+    on_board_sale_id: string | null;
+    is_passenger: boolean;
+    on_board_refund_id: string | null;
+    category: "prepaid" | "subscription" | "on_board_sale" | null;
+    validation_status: 0 | 1 | 2 | 6 | 3 | 8 | 4 | 5 | 7 | 9 | 10 | 11 | 12 | 13;
+}, {
+    _id: string;
+    agency_id: string;
+    created_at: number;
+    is_ok: boolean;
+    received_at: number;
+    apex_version: string;
+    device_id: string;
+    event_type: number;
+    is_ok_pcgi: boolean;
+    line_id: string;
+    mac_ase_counter_value: number;
+    mac_sam_serial_number: number;
+    pattern_id: string;
+    product_id: string;
+    stop_id: string;
+    trip_id: string;
+    units_qty: number | null;
+    vehicle_id: number;
+    card_serial_number: string;
+    on_board_sale_id: string | null;
+    is_passenger: boolean;
+    on_board_refund_id: string | null;
+    category: "prepaid" | "subscription" | "on_board_sale" | null;
+    validation_status: 0 | 1 | 2 | 6 | 3 | 8 | 4 | 5 | 7 | 9 | 10 | 11 | 12 | 13;
+}>;
+export declare const UpdateSimplifiedApexValidationSchema: z.ZodObject<{
+    _id: z.ZodOptional<z.ZodString>;
+    agency_id: z.ZodOptional<z.ZodString>;
+    apex_version: z.ZodOptional<z.ZodString>;
+    card_serial_number: z.ZodOptional<z.ZodString>;
+    category: z.ZodOptional<z.ZodNullable<z.ZodEnum<["prepaid", "subscription", "on_board_sale"]>>>;
+    created_at: z.ZodOptional<z.ZodEffects<z.ZodNumber, import("@tmlmobilidade/go-types-shared").UnixTimestamp, number>>;
+    device_id: z.ZodOptional<z.ZodString>;
+    event_type: z.ZodOptional<z.ZodNumber>;
+    is_ok: z.ZodOptional<z.ZodBoolean>;
+    is_ok_pcgi: z.ZodOptional<z.ZodBoolean>;
+    is_passenger: z.ZodOptional<z.ZodBoolean>;
+    line_id: z.ZodOptional<z.ZodString>;
+    mac_ase_counter_value: z.ZodOptional<z.ZodNumber>;
+    mac_sam_serial_number: z.ZodOptional<z.ZodNumber>;
+    on_board_refund_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    on_board_sale_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    pattern_id: z.ZodOptional<z.ZodString>;
+    product_id: z.ZodOptional<z.ZodString>;
+    received_at: z.ZodOptional<z.ZodEffects<z.ZodNumber, import("@tmlmobilidade/go-types-shared").UnixTimestamp, number>>;
+    stop_id: z.ZodOptional<z.ZodString>;
+    trip_id: z.ZodOptional<z.ZodString>;
+    units_qty: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    validation_status: z.ZodOptional<z.ZodNativeEnum<{
+        readonly _0_ContractValid: 0;
+        readonly _1_Antipassback: 1;
+        readonly _2_CardInBlackList: 2;
+        readonly _3_SamInBlackList: 3;
+        readonly _4_CardInWhiteList: 4;
+        readonly _5_ProfileInWhiteList: 5;
+        readonly _6_Interchange: 6;
+        readonly _7_Interrupted: 7;
+        readonly _8_NoValidContract: 8;
+        readonly _9_CardInvalidated: 9;
+        readonly _10_EventsFull: 10;
+        readonly _11_NotEnoughUnits: 11;
+        readonly _12_ContractExpired: 12;
+        readonly _13_MaxValue: 13;
+    }>>;
+    vehicle_id: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    _id?: string | undefined;
+    agency_id?: string | undefined;
+    created_at?: import("@tmlmobilidade/go-types-shared").UnixTimestamp | undefined;
+    is_ok?: boolean | undefined;
+    received_at?: import("@tmlmobilidade/go-types-shared").UnixTimestamp | undefined;
+    apex_version?: string | undefined;
+    device_id?: string | undefined;
+    event_type?: number | undefined;
+    is_ok_pcgi?: boolean | undefined;
+    line_id?: string | undefined;
+    mac_ase_counter_value?: number | undefined;
+    mac_sam_serial_number?: number | undefined;
+    pattern_id?: string | undefined;
+    product_id?: string | undefined;
+    stop_id?: string | undefined;
+    trip_id?: string | undefined;
+    units_qty?: number | null | undefined;
+    vehicle_id?: number | undefined;
+    card_serial_number?: string | undefined;
+    on_board_sale_id?: string | null | undefined;
+    is_passenger?: boolean | undefined;
+    on_board_refund_id?: string | null | undefined;
+    category?: "prepaid" | "subscription" | "on_board_sale" | null | undefined;
+    validation_status?: 0 | 1 | 2 | 6 | 3 | 8 | 4 | 5 | 7 | 9 | 10 | 11 | 12 | 13 | undefined;
+}, {
+    _id?: string | undefined;
+    agency_id?: string | undefined;
+    created_at?: number | undefined;
+    is_ok?: boolean | undefined;
+    received_at?: number | undefined;
+    apex_version?: string | undefined;
+    device_id?: string | undefined;
+    event_type?: number | undefined;
+    is_ok_pcgi?: boolean | undefined;
+    line_id?: string | undefined;
+    mac_ase_counter_value?: number | undefined;
+    mac_sam_serial_number?: number | undefined;
+    pattern_id?: string | undefined;
+    product_id?: string | undefined;
+    stop_id?: string | undefined;
+    trip_id?: string | undefined;
+    units_qty?: number | null | undefined;
+    vehicle_id?: number | undefined;
+    card_serial_number?: string | undefined;
+    on_board_sale_id?: string | null | undefined;
+    is_passenger?: boolean | undefined;
+    on_board_refund_id?: string | null | undefined;
+    category?: "prepaid" | "subscription" | "on_board_sale" | null | undefined;
+    validation_status?: 0 | 1 | 2 | 6 | 3 | 8 | 4 | 5 | 7 | 9 | 10 | 11 | 12 | 13 | undefined;
+}>;
+/**
+ * APEX Validations are APEX transactions of type 11 that are generated when a card holder touches a validator
+ * reader (ex: bus validator, subway gate). These validation transactions represent the card holder's right to travel
+ * on a given route, line, or vehicle. T11s have statuses that indicate if the card holder was allowed to travel
+ * or not, and with which conditions. A validation also contains information about the card holder's card, the vehicle,
+ * the validator machine, the route, and the time and location of the validation.
+ */
+export type SimplifiedApexValidation = z.infer<typeof SimplifiedApexValidationSchema>;
+export type UpdateSimplifiedApexValidationDto = z.infer<typeof UpdateSimplifiedApexValidationSchema>;
+/**
+ * Validation statuses that are considered valid for the card holder to travel.
+ */
+export declare const ALLOWED_VALIDATION_STATUSES: (0 | 6 | 4 | 5)[];

package/dist/simplified/simplified-apex-validation.js

@@ -0,0 +1,41 @@
+/* * */
+import { ApexValidationStatus, ApexValidationStatusSchema } from './apex-validation-status.js';
+import { UnixTimestampSchema } from '@tmlmobilidade/go-types-shared';
+import { z } from 'zod';
+/* * */
+export const SimplifiedApexValidationSchema = z.object({
+    _id: z.string(),
+    agency_id: z.string(),
+    apex_version: z.string(),
+    card_serial_number: z.string(),
+    category: z.enum(['prepaid', 'subscription', 'on_board_sale']).nullable(),
+    created_at: UnixTimestampSchema,
+    device_id: z.string(),
+    event_type: z.number(),
+    is_ok: z.boolean(),
+    is_ok_pcgi: z.boolean(),
+    is_passenger: z.boolean(),
+    line_id: z.string(),
+    mac_ase_counter_value: z.number(),
+    mac_sam_serial_number: z.number(),
+    on_board_refund_id: z.string().nullable(),
+    on_board_sale_id: z.string().nullable(),
+    pattern_id: z.string(),
+    product_id: z.string(),
+    received_at: UnixTimestampSchema,
+    stop_id: z.string(),
+    trip_id: z.string(),
+    units_qty: z.number().nullable(),
+    validation_status: ApexValidationStatusSchema,
+    vehicle_id: z.number(),
+});
+export const UpdateSimplifiedApexValidationSchema = SimplifiedApexValidationSchema.partial();
+/**
+ * Validation statuses that are considered valid for the card holder to travel.
+ */
+export const ALLOWED_VALIDATION_STATUSES = [
+    ApexValidationStatus._0_ContractValid,
+    ApexValidationStatus._4_CardInWhiteList,
+    ApexValidationStatus._5_ProfileInWhiteList,
+    ApexValidationStatus._6_Interchange,
+];

package/package.json

@@ -0,0 +1,49 @@
+{
+	"name": "@tmlmobilidade/go-types-apex",
+	"version": "20260611.1527.25",
+	"author": {
+		"email": "iso@tmlmobilidade.pt",
+		"name": "TML-ISO"
+	},
+	"license": "AGPL-3.0-or-later",
+	"homepage": "https://go.tmlmobilidade.pt",
+	"bugs": {
+		"url": "https://github.com/tmlmobilidade/go/issues"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/tmlmobilidade/go.git"
+	},
+	"keywords": [
+		"public transit",
+		"tml",
+		"transportes metropolitanos de lisboa",
+		"go"
+	],
+	"publishConfig": {
+		"access": "public"
+	},
+	"type": "module",
+	"files": [
+		"dist"
+	],
+	"main": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"scripts": {
+		"build": "tsc && resolve-tspaths",
+		"lint": "eslint ./src/ && tsc --noEmit",
+		"lint:fix": "eslint ./src/ --fix",
+		"watch": "tsc-watch --onSuccess 'resolve-tspaths'"
+	},
+	"dependencies": {
+		"@tmlmobilidade/go-types-shared": "*",
+		"zod": "3.25.76"
+	},
+	"devDependencies": {
+		"@tmlmobilidade/tsconfig": "*",
+		"@types/node": "25.9.3",
+		"resolve-tspaths": "0.8.23",
+		"tsc-watch": "7.2.0",
+		"typescript": "6.0.3"
+	}
+}