@tmlmobilidade/types 20250807.22.45 → 20250811.1237.51

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

@@ -1,77 +1,149 @@
 import { type UnixTimestamp } from '../_common/unix-timestamp.js';
 import { z } from 'zod';
-export declare enum ApexValidationStatus {
+export declare const ApexValidationStatus: {
     /**
      * VALID:
      * The card holder had a valid contract for the given context.
      */
-    _0_ContractValid = 0,
+    readonly _0_ContractValid: 0;
     /**
      * INVALID:
      * The card holder already has a valid validation for the given context.
      */
-    _1_Antipassback = 1,
+    readonly _1_Antipassback: 1;
     /**
      * INVALID:
      * The card holder's card is in the black list.
      */
-    _2_CardInBlackList = 2,
+    readonly _2_CardInBlackList: 2;
     /**
      * INVALID:
      * The validator SAM is in the black list.
      */
-    _3_SamInBlackList = 3,
+    readonly _3_SamInBlackList: 3;
     /**
      * VALID:
      * The card holder's card is in the white list.
      */
-    _4_CardInWhiteList = 4,
+    readonly _4_CardInWhiteList: 4;
     /**
      * VALID:
      * The card holder's profile is in the white list.
      */
-    _5_ProfileInWhiteList = 5,
+    readonly _5_ProfileInWhiteList: 5;
     /**
      * VALID:
      * The context allows for validation re-use.
      */
-    _6_Interchange = 6,
+    readonly _6_Interchange: 6;
     /**
      * INVALID:
      * The validation could not be written to the card.
      */
-    _7_Interrupted = 7,
+    readonly _7_Interrupted: 7;
     /**
      * INVALID:
      * The card holder does not have a valid contract for the given context.
      */
-    _8_NoValidContract = 8,
+    readonly _8_NoValidContract: 8;
     /**
      * INVALID:
      * The card holder's card is invalidated.
      */
-    _9_CardInvalidated = 9,
+    readonly _9_CardInvalidated: 9;
     /**
      * INVALID:
      * The card holder's card or the validator's SAM has no more space for events.
      */
-    _10_EventsFull = 10,
+    readonly _10_EventsFull: 10;
     /**
      * INVALID:
      * The card holder's card does not have enough units for the given context.
      */
-    _11_NotEnoughUnits = 11,
+    readonly _11_NotEnoughUnits: 11;
     /**
      * INVALID:
      * The card holder's contract has expired.
      */
-    _12_ContractExpired = 12,
+    readonly _12_ContractExpired: 12;
     /**
      * INVALID:
      * The maximum value for the validation status. This is used to validate the status.
      */
-    _13_MaxValue = 13
-}
+    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;
+}>;
 export declare const SimplifiedApexValidationSchema: z.ZodObject<{
     _id: z.ZodString;
     created_at: z.ZodOptional<z.ZodNullable<z.ZodBranded<z.ZodEffects<z.ZodNumber, UnixTimestamp, number>, "UnixTimestamp">>>;
@@ -94,7 +166,78 @@ export declare const SimplifiedApexValidationSchema: z.ZodObject<{
     stop_id: z.ZodString;
     trip_id: z.ZodString;
     units_qty: z.ZodNullable<z.ZodNumber>;
-    validation_status: z.ZodNativeEnum<typeof ApexValidationStatus>;
+    validation_status: 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;
+    }>;
     vehicle_id: z.ZodNumber;
 }, "strict", z.ZodTypeAny, {
     _id: string;
@@ -118,7 +261,7 @@ export declare const SimplifiedApexValidationSchema: z.ZodObject<{
     event_type: number;
     product_id: string;
     units_qty: number | null;
-    validation_status: ApexValidationStatus;
+    validation_status: 0 | 1 | 2 | 3 | 12 | 11 | 4 | 8 | 10 | 5 | 6 | 7 | 9 | 13;
     created_at?: (number & {
         __brand: "UnixTimestamp";
     } & z.BRAND<"UnixTimestamp">) | null | undefined;
@@ -145,7 +288,7 @@ export declare const SimplifiedApexValidationSchema: z.ZodObject<{
     event_type: number;
     product_id: string;
     units_qty: number | null;
-    validation_status: ApexValidationStatus;
+    validation_status: 0 | 1 | 2 | 3 | 12 | 11 | 4 | 8 | 10 | 5 | 6 | 7 | 9 | 13;
     created_at?: number | null | undefined;
     updated_at?: number | null | undefined;
 }>;
@@ -170,7 +313,78 @@ export declare const UpdateSimplifiedApexValidationSchema: z.ZodObject<{
     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<typeof ApexValidationStatus>>;
+    validation_status: z.ZodOptional<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;
+    }>>;
     vehicle_id: z.ZodOptional<z.ZodNumber>;
 }, "strict", z.ZodTypeAny, {
     _id?: string | undefined;
@@ -200,7 +414,7 @@ export declare const UpdateSimplifiedApexValidationSchema: z.ZodObject<{
     event_type?: number | undefined;
     product_id?: string | undefined;
     units_qty?: number | null | undefined;
-    validation_status?: ApexValidationStatus | undefined;
+    validation_status?: 0 | 1 | 2 | 3 | 12 | 11 | 4 | 8 | 10 | 5 | 6 | 7 | 9 | 13 | undefined;
 }, {
     _id?: string | undefined;
     created_at?: number | null | undefined;
@@ -223,7 +437,7 @@ export declare const UpdateSimplifiedApexValidationSchema: z.ZodObject<{
     event_type?: number | undefined;
     product_id?: string | undefined;
     units_qty?: number | null | undefined;
-    validation_status?: ApexValidationStatus | undefined;
+    validation_status?: 0 | 1 | 2 | 3 | 12 | 11 | 4 | 8 | 10 | 5 | 6 | 7 | 9 | 13 | undefined;
 }>;
 /**
  * APEX Validations are APEX transactions of type 11 that are generated when a card holder touches a validator
@@ -241,4 +455,4 @@ export type UpdateSimplifiedApexValidationDto = Partial<SimplifiedApexValidation
 /**
  * Validation statuses that are considered valid for the card holder to travel.
  */
-export declare const ALLOWED_VALIDATION_STATUSES: ApexValidationStatus[];
+export declare const ALLOWED_VALIDATION_STATUSES: (0 | 4 | 5 | 6)[];

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

@@ -3,79 +3,79 @@ import { DocumentSchema } from '../_common/document.js';
 import { validateUnixTimestamp } from '../_common/unix-timestamp.js';
 import { z } from 'zod';
 /* * */
-export var ApexValidationStatus;
-(function (ApexValidationStatus) {
+export const ApexValidationStatus = {
     /**
      * VALID:
      * The card holder had a valid contract for the given context.
      */
-    ApexValidationStatus[ApexValidationStatus["_0_ContractValid"] = 0] = "_0_ContractValid";
+    _0_ContractValid: 0,
     /**
      * INVALID:
      * The card holder already has a valid validation for the given context.
      */
-    ApexValidationStatus[ApexValidationStatus["_1_Antipassback"] = 1] = "_1_Antipassback";
+    _1_Antipassback: 1,
     /**
      * INVALID:
      * The card holder's card is in the black list.
      */
-    ApexValidationStatus[ApexValidationStatus["_2_CardInBlackList"] = 2] = "_2_CardInBlackList";
+    _2_CardInBlackList: 2,
     /**
      * INVALID:
      * The validator SAM is in the black list.
      */
-    ApexValidationStatus[ApexValidationStatus["_3_SamInBlackList"] = 3] = "_3_SamInBlackList";
+    _3_SamInBlackList: 3,
     /**
      * VALID:
      * The card holder's card is in the white list.
      */
-    ApexValidationStatus[ApexValidationStatus["_4_CardInWhiteList"] = 4] = "_4_CardInWhiteList";
+    _4_CardInWhiteList: 4,
     /**
      * VALID:
      * The card holder's profile is in the white list.
      */
-    ApexValidationStatus[ApexValidationStatus["_5_ProfileInWhiteList"] = 5] = "_5_ProfileInWhiteList";
+    _5_ProfileInWhiteList: 5,
     /**
      * VALID:
      * The context allows for validation re-use.
      */
-    ApexValidationStatus[ApexValidationStatus["_6_Interchange"] = 6] = "_6_Interchange";
+    _6_Interchange: 6,
     /**
      * INVALID:
      * The validation could not be written to the card.
      */
-    ApexValidationStatus[ApexValidationStatus["_7_Interrupted"] = 7] = "_7_Interrupted";
+    _7_Interrupted: 7,
     /**
      * INVALID:
      * The card holder does not have a valid contract for the given context.
      */
-    ApexValidationStatus[ApexValidationStatus["_8_NoValidContract"] = 8] = "_8_NoValidContract";
+    _8_NoValidContract: 8,
     /**
      * INVALID:
      * The card holder's card is invalidated.
      */
-    ApexValidationStatus[ApexValidationStatus["_9_CardInvalidated"] = 9] = "_9_CardInvalidated";
+    _9_CardInvalidated: 9,
     /**
      * INVALID:
      * The card holder's card or the validator's SAM has no more space for events.
      */
-    ApexValidationStatus[ApexValidationStatus["_10_EventsFull"] = 10] = "_10_EventsFull";
+    _10_EventsFull: 10,
     /**
      * INVALID:
      * The card holder's card does not have enough units for the given context.
      */
-    ApexValidationStatus[ApexValidationStatus["_11_NotEnoughUnits"] = 11] = "_11_NotEnoughUnits";
+    _11_NotEnoughUnits: 11,
     /**
      * INVALID:
      * The card holder's contract has expired.
      */
-    ApexValidationStatus[ApexValidationStatus["_12_ContractExpired"] = 12] = "_12_ContractExpired";
+    _12_ContractExpired: 12,
     /**
      * INVALID:
      * The maximum value for the validation status. This is used to validate the status.
      */
-    ApexValidationStatus[ApexValidationStatus["_13_MaxValue"] = 13] = "_13_MaxValue";
-})(ApexValidationStatus || (ApexValidationStatus = {}));
+    _13_MaxValue: 13,
+};
+export const ApexValidationStatusSchema = z.nativeEnum(ApexValidationStatus);
 /* * */
 export const SimplifiedApexValidationSchema = DocumentSchema.extend({
     agency_id: z.string(),
@@ -95,7 +95,7 @@ export const SimplifiedApexValidationSchema = DocumentSchema.extend({
     stop_id: z.string(),
     trip_id: z.string(),
     units_qty: z.number().nullable(),
-    validation_status: z.nativeEnum(ApexValidationStatus),
+    validation_status: ApexValidationStatusSchema,
     vehicle_id: z.number(),
 }).strict();
 export const UpdateSimplifiedApexValidationSchema = SimplifiedApexValidationSchema.partial();

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@tmlmobilidade/types",
-	"version": "20250807.22.45",
+	"version": "20250811.1237.51",
 	"author": "João de Vasconcelos & Jusi Monteiro",
 	"license": "AGPL-3.0-or-later",
 	"homepage": "https://github.com/tmlmobilidade/services#readme",