@tmlmobilidade/go-types-apex 20260611.1527.25

package/dist/raw/validations/validation-v3-0.js

@@ -0,0 +1,85 @@
+/* * */
+import { RawApexTransactionBaseSchema } from '../raw-apex-transaction-base.js';
+import { z } from 'zod';
+/* * */
+export const RawApexTransactionValidationV30PayloadSchema = z.object({
+    cardInfo: z.object({
+        cardIssuer: z.number(),
+        cardNetworkID: z.string(),
+        cardNumber: z.number(),
+        cardPhysicalType: z.number(),
+        cardSerialNumber: z.string(),
+        cardTypeID: z.string(),
+    }),
+    mac: z.object({
+        aseCounterValue: z.number(),
+        binaryDataMask: z.number(),
+        fullMacFlag: z.number(),
+        interruptedStatus: z.number(),
+        macVersion: z.number(),
+        raw: z.string(),
+        samModel: z.number(),
+        samSerialNumber: z.number(),
+        samTypeVersion: z.number(),
+        samWorkingMode: z.number(),
+        transactionCounter: z.number(),
+    }),
+    operatorInfo: z.object({
+        channelID: z.string(),
+        deviceID: z.string(),
+        networkID: z.string(),
+        operatorLongID: z.string(),
+    }),
+    serviceInfo: z.object({
+        journeyID: z.string(),
+        lineLongID: z.string(),
+        outOfBoundsType: z.number(),
+        patternLongID: z.string(),
+        stopLongID: z.string(),
+        validatorID: z.number(),
+        vehicleID: z.number(),
+        zoneLongID: z.string(),
+    }),
+    signedData: z.object({
+        contractBinaryRead: z.string(),
+        eventBinaryRead: z.string(),
+        eventBinaryWritten: z.string(),
+        raw: z.string(),
+    }),
+    transactionInfo: z.object({
+        apexTransactionType: z.number(),
+        apexTransactionVersion: z.literal('3.0'),
+        transactionDate: z.string(),
+        transactionGroupId: z.string(),
+        transactionId: z.string(),
+    }),
+    validationInfo: z.object({
+        calendarID: z.string(),
+        contractNumber: z.number(),
+        eventType: z.number(),
+        greylistItemsData: z.array(z.any()),
+        productLongID: z.string(),
+        profilesUsedData: z.array(z.any()),
+        spatialValidityLongID: z.string(),
+        tickLoadDate: z.string(),
+        tickLoadMachCode: z.number(),
+        tickLoadNumbDaily: z.number(),
+        unitsRemaining: z.number(),
+        validationStatus: z.number(),
+        validationType: z.number(),
+        validityPeriodID: z.string(),
+    }),
+    versionInfo: z.object({
+        actionListsVersion: z.string(),
+        apexVersion: z.string(),
+        commercialOfferVersion: z.string(),
+        networkVersion: z.string(),
+        technicalParametersVersion: z.string(),
+        vivaVersion: z.string(),
+    }),
+});
+/* * */
+export const RawApexTransactionValidationV30Schema = RawApexTransactionBaseSchema.extend({
+    payload: RawApexTransactionValidationV30PayloadSchema,
+    version: z.literal('apex-validation-3.0'),
+});

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

@@ -0,0 +1,8 @@
+import { type SimplifiedApexBankingTap } from './simplified-apex-banking-taps.js';
+import { type SimplifiedApexInspectionDecision } from './simplified-apex-inspection-decision.js';
+import { type SimplifiedApexInspection } from './simplified-apex-inspection.js';
+import { type SimplifiedApexLocation } from './simplified-apex-location.js';
+import { type SimplifiedApexOnBoardRefund } from './simplified-apex-on-board-refund.js';
+import { type SimplifiedApexOnBoardSale } from './simplified-apex-on-board-sale.js';
+import { type SimplifiedApexValidation } from './simplified-apex-validation.js';
+export type AnySimplifiedApex = SimplifiedApexBankingTap | SimplifiedApexInspection | SimplifiedApexInspectionDecision | SimplifiedApexLocation | SimplifiedApexOnBoardRefund | SimplifiedApexOnBoardSale | SimplifiedApexValidation;

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

@@ -0,0 +1,2 @@
+/* * */
+export {};

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

@@ -0,0 +1,145 @@
+import { z } from 'zod';
+export declare const ApexValidationStatus: {
+    /**
+     * VALID:
+     * The card holder had a valid contract for the given context.
+     */
+    readonly _0_ContractValid: 0;
+    /**
+     * INVALID:
+     * The card holder already has a valid validation for the given context.
+     */
+    readonly _1_Antipassback: 1;
+    /**
+     * INVALID:
+     * The card holder's card is in the black list.
+     */
+    readonly _2_CardInBlackList: 2;
+    /**
+     * INVALID:
+     * The validator SAM is in the black list.
+     */
+    readonly _3_SamInBlackList: 3;
+    /**
+     * VALID:
+     * The card holder's card is in the white list.
+     */
+    readonly _4_CardInWhiteList: 4;
+    /**
+     * VALID:
+     * The card holder's profile is in the white list.
+     */
+    readonly _5_ProfileInWhiteList: 5;
+    /**
+     * VALID:
+     * The context allows for validation re-use.
+     */
+    readonly _6_Interchange: 6;
+    /**
+     * INVALID:
+     * The validation could not be written to the card.
+     */
+    readonly _7_Interrupted: 7;
+    /**
+     * INVALID:
+     * The card holder does not have a valid contract for the given context.
+     */
+    readonly _8_NoValidContract: 8;
+    /**
+     * INVALID:
+     * The card holder's card is invalidated.
+     */
+    readonly _9_CardInvalidated: 9;
+    /**
+     * INVALID:
+     * The card holder's card or the validator's SAM has no more space for events.
+     */
+    readonly _10_EventsFull: 10;
+    /**
+     * INVALID:
+     * The card holder's card does not have enough units for the given context.
+     */
+    readonly _11_NotEnoughUnits: 11;
+    /**
+     * INVALID:
+     * The card holder's contract has expired.
+     */
+    readonly _12_ContractExpired: 12;
+    /**
+     * INVALID:
+     * The maximum value for the validation status. This is used to validate the status.
+     */
+    readonly _13_MaxValue: 13;
+};
+export declare const ApexValidationStatusSchema: z.ZodNativeEnum<{
+    /**
+     * VALID:
+     * The card holder had a valid contract for the given context.
+     */
+    readonly _0_ContractValid: 0;
+    /**
+     * INVALID:
+     * The card holder already has a valid validation for the given context.
+     */
+    readonly _1_Antipassback: 1;
+    /**
+     * INVALID:
+     * The card holder's card is in the black list.
+     */
+    readonly _2_CardInBlackList: 2;
+    /**
+     * INVALID:
+     * The validator SAM is in the black list.
+     */
+    readonly _3_SamInBlackList: 3;
+    /**
+     * VALID:
+     * The card holder's card is in the white list.
+     */
+    readonly _4_CardInWhiteList: 4;
+    /**
+     * VALID:
+     * The card holder's profile is in the white list.
+     */
+    readonly _5_ProfileInWhiteList: 5;
+    /**
+     * VALID:
+     * The context allows for validation re-use.
+     */
+    readonly _6_Interchange: 6;
+    /**
+     * INVALID:
+     * The validation could not be written to the card.
+     */
+    readonly _7_Interrupted: 7;
+    /**
+     * INVALID:
+     * The card holder does not have a valid contract for the given context.
+     */
+    readonly _8_NoValidContract: 8;
+    /**
+     * INVALID:
+     * The card holder's card is invalidated.
+     */
+    readonly _9_CardInvalidated: 9;
+    /**
+     * INVALID:
+     * The card holder's card or the validator's SAM has no more space for events.
+     */
+    readonly _10_EventsFull: 10;
+    /**
+     * INVALID:
+     * The card holder's card does not have enough units for the given context.
+     */
+    readonly _11_NotEnoughUnits: 11;
+    /**
+     * INVALID:
+     * The card holder's contract has expired.
+     */
+    readonly _12_ContractExpired: 12;
+    /**
+     * INVALID:
+     * The maximum value for the validation status. This is used to validate the status.
+     */
+    readonly _13_MaxValue: 13;
+}>;

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

@@ -0,0 +1,76 @@
+/* * */
+import { z } from 'zod';
+/* * */
+export const ApexValidationStatus = {
+    /**
+     * VALID:
+     * The card holder had a valid contract for the given context.
+     */
+    _0_ContractValid: 0,
+    /**
+     * INVALID:
+     * The card holder already has a valid validation for the given context.
+     */
+    _1_Antipassback: 1,
+    /**
+     * INVALID:
+     * The card holder's card is in the black list.
+     */
+    _2_CardInBlackList: 2,
+    /**
+     * INVALID:
+     * The validator SAM is in the black list.
+     */
+    _3_SamInBlackList: 3,
+    /**
+     * VALID:
+     * The card holder's card is in the white list.
+     */
+    _4_CardInWhiteList: 4,
+    /**
+     * VALID:
+     * The card holder's profile is in the white list.
+     */
+    _5_ProfileInWhiteList: 5,
+    /**
+     * VALID:
+     * The context allows for validation re-use.
+     */
+    _6_Interchange: 6,
+    /**
+     * INVALID:
+     * The validation could not be written to the card.
+     */
+    _7_Interrupted: 7,
+    /**
+     * INVALID:
+     * The card holder does not have a valid contract for the given context.
+     */
+    _8_NoValidContract: 8,
+    /**
+     * INVALID:
+     * The card holder's card is invalidated.
+     */
+    _9_CardInvalidated: 9,
+    /**
+     * INVALID:
+     * The card holder's card or the validator's SAM has no more space for events.
+     */
+    _10_EventsFull: 10,
+    /**
+     * INVALID:
+     * The card holder's card does not have enough units for the given context.
+     */
+    _11_NotEnoughUnits: 11,
+    /**
+     * INVALID:
+     * The card holder's contract has expired.
+     */
+    _12_ContractExpired: 12,
+    /**
+     * INVALID:
+     * The maximum value for the validation status. This is used to validate the status.
+     */
+    _13_MaxValue: 13,
+};
+export const ApexValidationStatusSchema = z.nativeEnum(ApexValidationStatus);

package/dist/simplified/index.d.ts

@@ -0,0 +1,10 @@
+export * from './any-simplified-apex.js';
+export * from './apex-validation-status.js';
+export * from './simplified-apex-banking-taps.js';
+export * from './simplified-apex-inspection-decision.js';
+export * from './simplified-apex-inspection.js';
+export * from './simplified-apex-location.js';
+export * from './simplified-apex-on-board-refund.js';
+export * from './simplified-apex-on-board-sale.js';
+export * from './simplified-apex-type.js';
+export * from './simplified-apex-validation.js';

package/dist/simplified/index.js

@@ -0,0 +1,10 @@
+export * from './any-simplified-apex.js';
+export * from './apex-validation-status.js';
+export * from './simplified-apex-banking-taps.js';
+export * from './simplified-apex-inspection-decision.js';
+export * from './simplified-apex-inspection.js';
+export * from './simplified-apex-location.js';
+export * from './simplified-apex-on-board-refund.js';
+export * from './simplified-apex-on-board-sale.js';
+export * from './simplified-apex-type.js';
+export * from './simplified-apex-validation.js';

package/dist/simplified/simplified-apex-banking-taps.d.ts

@@ -0,0 +1,81 @@
+import { z } from 'zod';
+export declare const SimplifiedApexBankingTapSchema: z.ZodObject<{
+    _id: z.ZodString;
+    agency_id: z.ZodString;
+    apex_version: z.ZodString;
+    banking_token: z.ZodString;
+    card_brand: z.ZodNumber;
+    card_pan: z.ZodString;
+    created_at: z.ZodEffects<z.ZodNumber, import("@tmlmobilidade/go-types-shared").UnixTimestamp, number>;
+    device_id: z.ZodString;
+    event_type: z.ZodNullable<z.ZodNumber>;
+    is_ok: z.ZodBoolean;
+    is_ok_pcgi: z.ZodBoolean;
+    line_id: z.ZodString;
+    mac_ase_counter_value: z.ZodNumber;
+    mac_sam_serial_number: z.ZodNumber;
+    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.ZodNumber;
+    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;
+    banking_token: string;
+    card_brand: number;
+    card_pan: string;
+    device_id: string;
+    event_type: number | null;
+    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;
+    vehicle_id: number;
+}, {
+    _id: string;
+    agency_id: string;
+    created_at: number;
+    is_ok: boolean;
+    received_at: number;
+    apex_version: string;
+    banking_token: string;
+    card_brand: number;
+    card_pan: string;
+    device_id: string;
+    event_type: number | null;
+    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;
+    vehicle_id: number;
+}>;
+/**
+ * APEX Banking Taps are APEX transactions of type 20 that are generated
+ * when a card holder with a banking card touches a validator reader.
+ * These transactions represent the card holder's right to travel on a given route,
+ * line, or vehicle, and are generated in a similar way to APEX Validations (T11s).
+ * However, banking taps have some differences compared to regular validations,
+ * such as the presence of banking-specific fields (ex: banking token, card brand, card pan).
+ */
+export type SimplifiedApexBankingTap = z.infer<typeof SimplifiedApexBankingTapSchema>;

package/dist/simplified/simplified-apex-banking-taps.js

@@ -0,0 +1,27 @@
+/* * */
+import { UnixTimestampSchema } from '@tmlmobilidade/go-types-shared';
+import { z } from 'zod';
+/* * */
+export const SimplifiedApexBankingTapSchema = z.object({
+    _id: z.string(),
+    agency_id: z.string(),
+    apex_version: z.string(),
+    banking_token: z.string(),
+    card_brand: z.number(),
+    card_pan: z.string(),
+    created_at: UnixTimestampSchema,
+    device_id: z.string(),
+    event_type: z.number().nullable(),
+    is_ok: z.boolean(),
+    is_ok_pcgi: z.boolean(),
+    line_id: z.string(),
+    mac_ase_counter_value: z.number(),
+    mac_sam_serial_number: z.number(),
+    pattern_id: z.string(),
+    product_id: z.string(),
+    received_at: UnixTimestampSchema,
+    stop_id: z.string(),
+    trip_id: z.string(),
+    units_qty: z.number(),
+    vehicle_id: z.number(),
+});

package/dist/simplified/simplified-apex-inspection-decision.d.ts

@@ -0,0 +1,55 @@
+import { z } from 'zod';
+export declare const SimplifiedApexInspectionDecisionSchema: z.ZodObject<{
+    _id: z.ZodString;
+    agency_id: z.ZodString;
+    apex_version: z.ZodString;
+    created_at: z.ZodEffects<z.ZodNumber, import("@tmlmobilidade/go-types-shared").UnixTimestamp, number>;
+    device_id: z.ZodString;
+    final_control_status: z.ZodNumber;
+    inspection_decision_id: z.ZodNullable<z.ZodString>;
+    is_ok: z.ZodBoolean;
+    is_ok_pcgi: z.ZodBoolean;
+    mac_ase_counter_value: z.ZodNumber;
+    mac_sam_serial_number: z.ZodNumber;
+    received_at: z.ZodEffects<z.ZodNumber, import("@tmlmobilidade/go-types-shared").UnixTimestamp, number>;
+}, "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;
+    is_ok_pcgi: boolean;
+    mac_ase_counter_value: number;
+    mac_sam_serial_number: number;
+    final_control_status: number;
+    inspection_decision_id: string | null;
+}, {
+    _id: string;
+    agency_id: string;
+    created_at: number;
+    is_ok: boolean;
+    received_at: number;
+    apex_version: string;
+    device_id: string;
+    is_ok_pcgi: boolean;
+    mac_ase_counter_value: number;
+    mac_sam_serial_number: number;
+    final_control_status: number;
+    inspection_decision_id: string | null;
+}>;
+/**
+ * APEX Inspections are APEX transactions of type 15 that are generated
+ * when a card holder is inspected by a controller on board a vehicle.
+ * These transactions represent the card holder's inspection event,
+ * and contain information about the card holder's card, the vehicle,
+ * the controller, the route, and the time and location of the inspection.
+ * Inspections have statuses that indicate if the card holder was found
+ * to be in compliance with the fare rules or not, and with which conditions.
+ */
+export type SimplifiedApexInspectionDecision = z.infer<typeof SimplifiedApexInspectionDecisionSchema>;

package/dist/simplified/simplified-apex-inspection-decision.js

@@ -0,0 +1,18 @@
+/* * */
+import { UnixTimestampSchema } from '@tmlmobilidade/go-types-shared';
+import { z } from 'zod';
+/* * */
+export const SimplifiedApexInspectionDecisionSchema = z.object({
+    _id: z.string(),
+    agency_id: z.string(),
+    apex_version: z.string(),
+    created_at: UnixTimestampSchema,
+    device_id: z.string(),
+    final_control_status: z.number(),
+    inspection_decision_id: z.string().nullable(),
+    is_ok: z.boolean(),
+    is_ok_pcgi: z.boolean(),
+    mac_ase_counter_value: z.number(),
+    mac_sam_serial_number: z.number(),
+    received_at: UnixTimestampSchema,
+});

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

@@ -0,0 +1,82 @@
+import { z } from 'zod';
+export declare const SimplifiedApexInspectionSchema: z.ZodObject<{
+    _id: z.ZodString;
+    agency_id: z.ZodString;
+    apex_version: z.ZodString;
+    card_serial_number: z.ZodString;
+    control_destination_stop_id: z.ZodString;
+    control_origin_stop_id: z.ZodString;
+    control_status: z.ZodNumber;
+    created_at: z.ZodEffects<z.ZodNumber, import("@tmlmobilidade/go-types-shared").UnixTimestamp, number>;
+    device_id: z.ZodString;
+    environment_status: z.ZodNumber;
+    inspection_id: z.ZodNullable<z.ZodString>;
+    is_ok: z.ZodBoolean;
+    is_ok_pcgi: z.ZodBoolean;
+    line_id: z.ZodString;
+    mac_ase_counter_value: z.ZodNumber;
+    mac_sam_serial_number: z.ZodNumber;
+    pattern_id: z.ZodString;
+    product_id: z.ZodString;
+    received_at: z.ZodEffects<z.ZodNumber, import("@tmlmobilidade/go-types-shared").UnixTimestamp, number>;
+    trip_id: z.ZodString;
+    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;
+    is_ok_pcgi: boolean;
+    line_id: string;
+    mac_ase_counter_value: number;
+    mac_sam_serial_number: number;
+    pattern_id: string;
+    product_id: string;
+    trip_id: string;
+    vehicle_id: number;
+    card_serial_number: string;
+    control_destination_stop_id: string;
+    control_origin_stop_id: string;
+    control_status: number;
+    environment_status: number;
+    inspection_id: string | null;
+}, {
+    _id: string;
+    agency_id: string;
+    created_at: number;
+    is_ok: boolean;
+    received_at: number;
+    apex_version: string;
+    device_id: string;
+    is_ok_pcgi: boolean;
+    line_id: string;
+    mac_ase_counter_value: number;
+    mac_sam_serial_number: number;
+    pattern_id: string;
+    product_id: string;
+    trip_id: string;
+    vehicle_id: number;
+    card_serial_number: string;
+    control_destination_stop_id: string;
+    control_origin_stop_id: string;
+    control_status: number;
+    environment_status: number;
+    inspection_id: string | null;
+}>;
+/**
+ * APEX Inspection are APEX transactions of type 16 that are generated
+ * when a card holder's inspection decision is recorded by a controller on board a vehicle.
+ * These transactions represent the decision made regarding the card holder's inspection,
+ * and contain information about the card holder's card, the vehicle,
+ * the controller, the route, and the time and location of the decision.
+ * s have statuses that indicate if the card holder was found
+ * to be in compliance with the fare rules or not, and with which conditions.
+ */
+export type SimplifiedApexInspection = z.infer<typeof SimplifiedApexInspectionSchema>;

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

@@ -0,0 +1,27 @@
+/* * */
+import { UnixTimestampSchema } from '@tmlmobilidade/go-types-shared';
+import { z } from 'zod';
+/* * */
+export const SimplifiedApexInspectionSchema = z.object({
+    _id: z.string(),
+    agency_id: z.string(),
+    apex_version: z.string(),
+    card_serial_number: z.string(),
+    control_destination_stop_id: z.string(),
+    control_origin_stop_id: z.string(),
+    control_status: z.number(),
+    created_at: UnixTimestampSchema,
+    device_id: z.string(),
+    environment_status: z.number(),
+    inspection_id: z.string().nullable(),
+    is_ok: z.boolean(),
+    is_ok_pcgi: z.boolean(),
+    line_id: z.string(),
+    mac_ase_counter_value: z.number(),
+    mac_sam_serial_number: z.number(),
+    pattern_id: z.string(),
+    product_id: z.string(),
+    received_at: UnixTimestampSchema,
+    trip_id: z.string(),
+    vehicle_id: z.number(),
+});