@venulog/phasing-engine-schemas 0.13.3-alpha.1 → 0.13.3-alpha.2

package/dist/enums/index.d.ts

@@ -7,3 +7,4 @@ export * from './accessEventType.js';
 export * from './positionSource.js';
 export * from './cameraTrigger.js';
 export * from './simulationMode.js';
+export * from './vehicleAccessAction.js';

package/dist/enums/index.js

@@ -8,3 +8,4 @@ export * from './accessEventType.js';
 export * from './positionSource.js';
 export * from './cameraTrigger.js';
 export * from './simulationMode.js';
+export * from './vehicleAccessAction.js';

package/dist/enums/vehicleAccessAction.d.ts

@@ -0,0 +1,7 @@
+export declare enum VehicleAccessAction {
+    ENTERING_BUFFER = "entering_buffer",// PL vehicle enters Buffer Parking
+    EXIT_BUFFER = "exit_buffer",// PL vehicle exits Buffer Parking
+    ENTERING_EVENT_SITE = "entering_event_site",// PL vehicle enters the Event Site
+    EXIT_EVENT_SITE = "exit_event_site"
+}
+export declare const VEHICLE_ACCESS_ACTION_LABELS: Record<VehicleAccessAction, string>;

package/dist/enums/vehicleAccessAction.js

@@ -0,0 +1,15 @@
+// Vehicle access action enumeration for PL vehicle tracking
+// Defines the different checkpoint actions for heavy vehicles (PL) during event logistics
+export var VehicleAccessAction;
+(function (VehicleAccessAction) {
+    VehicleAccessAction["ENTERING_BUFFER"] = "entering_buffer";
+    VehicleAccessAction["EXIT_BUFFER"] = "exit_buffer";
+    VehicleAccessAction["ENTERING_EVENT_SITE"] = "entering_event_site";
+    VehicleAccessAction["EXIT_EVENT_SITE"] = "exit_event_site"; // PL vehicle exits the Event Site
+})(VehicleAccessAction || (VehicleAccessAction = {}));
+export const VEHICLE_ACCESS_ACTION_LABELS = {
+    [VehicleAccessAction.ENTERING_BUFFER]: 'Entering Buffer Parking',
+    [VehicleAccessAction.EXIT_BUFFER]: 'Exit Buffer Parking',
+    [VehicleAccessAction.ENTERING_EVENT_SITE]: 'Entering Event Site',
+    [VehicleAccessAction.EXIT_EVENT_SITE]: 'Exit Event Site'
+};

package/dist/parkingBooking.d.ts

@@ -3,6 +3,7 @@ import { z } from './zod.js';
 import { availableTimeSlotV2Schema } from './parkingArea.js';
 import { UnloadingType } from './enums/unloadingType.js';
 import { ParkingAreaScheduleType } from './enums/parkingAreaScheduleType.js';
+import { VehicleAccessAction } from './enums/vehicleAccessAction.js';
 export declare const geometrySchema: z.ZodNullable<z.ZodObject<{
     type: z.ZodEnum<{
         Point: "Point";
@@ -240,26 +241,38 @@ export declare const closeEventResponseSchema: z.ZodObject<{
         reason: z.ZodNullable<z.ZodString>;
     }, z.core.$strip>;
 }, z.core.$strip>;
-export declare const confirmAccessBodySchema: z.ZodObject<{
-    event_id: z.ZodNumber;
+export declare const confirmActionBodySchema: z.ZodObject<{
+    action: z.ZodEnum<{
+        entering_buffer: VehicleAccessAction.ENTERING_BUFFER;
+        exit_buffer: VehicleAccessAction.EXIT_BUFFER;
+        entering_event_site: VehicleAccessAction.ENTERING_EVENT_SITE;
+        exit_event_site: VehicleAccessAction.EXIT_EVENT_SITE;
+    }>;
     plate_number: z.ZodOptional<z.ZodObject<{
-        url: z.ZodString;
-        name: z.ZodString;
-        path: z.ZodString;
-        size: z.ZodNumber;
-        type: z.ZodString;
-        bucket: z.ZodString;
+        url: z.ZodURL;
+        name: z.ZodOptional<z.ZodString>;
+        size: z.ZodOptional<z.ZodNumber>;
+        bucket: z.ZodOptional<z.ZodString>;
+        type: z.ZodOptional<z.ZodString>;
+        path: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>>;
 }, z.core.$strip>;
-export declare const confirmAccessDataSchema: z.ZodObject<{
+export declare const confirmActionParamsSchema: z.ZodObject<{
     bookingId: z.ZodCoercedNumber<unknown>;
 }, z.core.$strip>;
-export declare const confirmAccessResponseSchema: z.ZodObject<{
+export declare const confirmActionResponseSchema: z.ZodObject<{
     success: z.ZodBoolean;
     message: z.ZodString;
     data: z.ZodObject<{
         booking_id: z.ZodNumber;
+        action: z.ZodString;
         scanned_at: z.ZodString;
+        scan_record_id: z.ZodNumber;
+        available_actions: z.ZodArray<z.ZodString>;
+        completed_actions: z.ZodArray<z.ZodObject<{
+            action: z.ZodString;
+            completed_at: z.ZodString;
+        }, z.core.$strip>>;
     }, z.core.$strip>;
 }, z.core.$strip>;
 export declare const checkSlotAvailabilityBodySchema: z.ZodObject<{
@@ -559,6 +572,8 @@ export declare const parkingBookingWithRelationsSchema: z.ZodObject<{
     is_fast_track_access: z.ZodBoolean;
     license_plate_image_url: z.ZodNullable<z.ZodString>;
     applicant_badge_image_url: z.ZodNullable<z.ZodString>;
+    buffer_entry_scanned_at: z.ZodNullable<z.ZodString>;
+    buffer_exit_scanned_at: z.ZodNullable<z.ZodString>;
 }, z.core.$strip>;
 export declare const getParkingBookingDetailsParamsSchema: z.ZodObject<{
     bookingId: z.ZodCoercedNumber<unknown>;
@@ -622,6 +637,13 @@ export declare const parkingBookingDetailsDataSchema: z.ZodObject<{
     is_fast_track_access: z.ZodBoolean;
     license_plate_image_url: z.ZodNullable<z.ZodString>;
     applicant_badge_image_url: z.ZodNullable<z.ZodString>;
+    available_actions: z.ZodArray<z.ZodString>;
+    completed_actions: z.ZodArray<z.ZodObject<{
+        action: z.ZodString;
+        completed_at: z.ZodString;
+    }, z.core.$strip>>;
+    buffer_entry_scanned_at: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    buffer_exit_scanned_at: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, z.core.$strip>;
 export declare const getParkingBookingDetailsResponseSchema: z.ZodObject<{
     success: z.ZodBoolean;
@@ -684,6 +706,13 @@ export declare const getParkingBookingDetailsResponseSchema: z.ZodObject<{
         is_fast_track_access: z.ZodBoolean;
         license_plate_image_url: z.ZodNullable<z.ZodString>;
         applicant_badge_image_url: z.ZodNullable<z.ZodString>;
+        available_actions: z.ZodArray<z.ZodString>;
+        completed_actions: z.ZodArray<z.ZodObject<{
+            action: z.ZodString;
+            completed_at: z.ZodString;
+        }, z.core.$strip>>;
+        buffer_entry_scanned_at: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        buffer_exit_scanned_at: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     }, z.core.$strip>;
 }, z.core.$strip>;
 export declare const getParkingBookingDetailsByTokenBodySchema: z.ZodObject<{
@@ -728,6 +757,13 @@ export declare const parkingBookingDetailsByTokenDataSchema: z.ZodObject<{
     is_fast_track_access: z.ZodBoolean;
     license_plate_image_url: z.ZodNullable<z.ZodString>;
     applicant_badge_image_url: z.ZodNullable<z.ZodString>;
+    available_actions: z.ZodArray<z.ZodString>;
+    completed_actions: z.ZodArray<z.ZodObject<{
+        action: z.ZodString;
+        completed_at: z.ZodString;
+    }, z.core.$strip>>;
+    buffer_entry_scanned_at: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    buffer_exit_scanned_at: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     company: z.ZodObject<{
         hall: z.ZodNullable<z.ZodOptional<z.ZodString>>;
         stand_number: z.ZodOptional<z.ZodString>;
@@ -790,6 +826,13 @@ export declare const getParkingBookingDetailsByTokenResponseSchema: z.ZodObject<
         is_fast_track_access: z.ZodBoolean;
         license_plate_image_url: z.ZodNullable<z.ZodString>;
         applicant_badge_image_url: z.ZodNullable<z.ZodString>;
+        available_actions: z.ZodArray<z.ZodString>;
+        completed_actions: z.ZodArray<z.ZodObject<{
+            action: z.ZodString;
+            completed_at: z.ZodString;
+        }, z.core.$strip>>;
+        buffer_entry_scanned_at: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        buffer_exit_scanned_at: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         company: z.ZodObject<{
             hall: z.ZodNullable<z.ZodOptional<z.ZodString>>;
             stand_number: z.ZodOptional<z.ZodString>;
@@ -1062,7 +1105,6 @@ export type CloseEventBody = z.infer<typeof closeEventBodySchema>;
 export type CloseEventData = z.infer<typeof closeEventDataSchema>;
 export type CloseEventResponse = z.infer<typeof closeEventResponseSchema>;
 export type EventBookingsResponse = z.infer<typeof eventBookingsResponseSchema>;
-export type ConfirmVehicleAccessData = z.infer<typeof confirmAccessBodySchema>;
 export type ConfirmBookingParams = z.infer<typeof confirmBookingParamsSchema>;
 export type ConfirmBookingResponse = z.infer<typeof confirmBookingResponseSchema>;
 export type CreateBookingBody = z.infer<typeof createParkingBookingBodySchema>;
@@ -1092,6 +1134,6 @@ export type UpdateParkingBookingResponse = z.infer<typeof updateParkingBookingRe
 export type CreateFastTrackBookingBody = z.infer<typeof createFastTrackBookingBodySchema>;
 export type CreateFastTrackBookingData = z.infer<typeof createFastTrackBookingDataSchema>;
 export type CreateFastTrackBookingResponse = z.infer<typeof createFastTrackBookingResponseSchema>;
-export type ConfirmAccessBody = z.infer<typeof confirmAccessBodySchema>;
-export type ConfirmAccessData = z.infer<typeof confirmAccessDataSchema>;
-export type ConfirmAccessResponse = z.infer<typeof confirmAccessResponseSchema>;
+export type ConfirmActionParams = z.infer<typeof confirmActionParamsSchema>;
+export type ConfirmActionResponse = z.infer<typeof confirmActionResponseSchema>;
+export type ConfirmActionBody = z.infer<typeof confirmActionBodySchema>;

package/dist/parkingBooking.js

@@ -6,6 +6,7 @@ import { z } from './zod.js';
 import { availableTimeSlotV2Schema, getAvailableSlotsBodyV2Schema } from './parkingArea.js';
 import { UnloadingType } from './enums/unloadingType.js';
 import { ParkingAreaScheduleType } from './enums/parkingAreaScheduleType.js';
+import { VehicleAccessAction } from './enums/vehicleAccessAction.js';
 // PostGIS geometry schema (GeoJSON-like structure)
 export const geometrySchema = z
     .object({
@@ -232,53 +233,84 @@ export const closeEventDataSchema = z
 })
     .openapi('CloseEventData');
 export const closeEventResponseSchema = createMessageDataResponseSchema(closeEventDataSchema, 'CloseEventResponse', 'Event phase closed successfully', 'Details of the closed event phase');
-export const confirmAccessBodySchema = z.object({
-    event_id: z.number().openapi({
-        description: 'ID of the event',
-        example: 1
+// ------------------------------
+// Confirm Action (PL vehicles only) schemas
+// ------------------------------
+export const confirmActionBodySchema = z
+    .object({
+    action: z
+        .enum([
+        VehicleAccessAction.ENTERING_BUFFER,
+        VehicleAccessAction.EXIT_BUFFER,
+        VehicleAccessAction.ENTERING_EVENT_SITE,
+        VehicleAccessAction.EXIT_EVENT_SITE
+    ])
+        .openapi({
+        description: 'Vehicle access action (only for PL vehicles)',
+        example: VehicleAccessAction.ENTERING_BUFFER
     }),
-    plate_number: z
-        .object({
-        url: z.string().openapi({
-            description: 'Public URL of the plate number',
-            example: 'https://example.net/xxxx.jpeg'
-        }),
-        name: z.string().openapi({
-            description: 'Name of the plate number file',
-            example: ''
-        }),
-        path: z.string().openapi({
-            description: 'Path of the plate number',
-            example: ''
-        }),
-        size: z.number().openapi({
-            description: 'File size of the plate number',
-            example: ''
-        }),
-        type: z.string().openapi({
-            description: 'File type of the plate number',
-            example: ''
-        }),
-        bucket: z.string().openapi({
-            description: 'Storage bucket name',
-            example: 'XXXXX'
-        })
-    })
-        .optional()
-});
-export const confirmAccessDataSchema = z.object({
+    plate_number: documentSchema.optional()
+})
+    .openapi('ConfirmActionBody');
+export const confirmActionParamsSchema = z
+    .object({
     bookingId: z.coerce.number().int().positive({
         message: 'Booking ID must be a positive integer'
     })
-});
-export const confirmAccessResponseSchema = z.object({
+})
+    .openapi('ConfirmActionParams');
+export const confirmActionResponseSchema = z
+    .object({
     success: z.boolean(),
     message: z.string(),
     data: z.object({
-        booking_id: z.number(),
-        scanned_at: z.string()
+        booking_id: z.number().openapi({
+            description: 'ID of the booking',
+            example: 123
+        }),
+        action: z.string().openapi({
+            description: 'The action that was recorded',
+            example: 'entering_buffer'
+        }),
+        scanned_at: z.string().openapi({
+            description: 'Timestamp when the action was recorded',
+            example: '2025-01-30T10:30:00.000Z'
+        }),
+        scan_record_id: z.number().openapi({
+            description: 'ID of the created scan record',
+            example: 456
+        }),
+        available_actions: z.array(z.string()).openapi({
+            description: 'List of actions still available for this booking after the current action',
+            example: ['exit_buffer', 'entering_event_site', 'exit_event_site']
+        }),
+        completed_actions: z
+            .array(z.object({
+            action: z.string().openapi({
+                description: 'The completed action',
+                example: 'entering_buffer'
+            }),
+            completed_at: z.string().openapi({
+                description: 'Timestamp when the action was completed',
+                example: '2025-01-30T10:15:00.000Z'
+            })
+        }))
+            .openapi({
+            description: 'List of all vehicle actions that have been completed with timestamps',
+            example: [
+                {
+                    action: 'entering_buffer',
+                    completed_at: '2025-01-30T10:15:00.000Z'
+                },
+                {
+                    action: 'entering_event_site',
+                    completed_at: '2025-01-30T10:30:00.000Z'
+                }
+            ]
+        })
     })
-});
+})
+    .openapi('ConfirmActionResponse');
 // ------------------------------
 // Check Slot Availability schemas
 // ------------------------------
@@ -535,7 +567,9 @@ export const parkingBookingWithRelationsSchema = z
     is_custom_slot: z.boolean(),
     is_fast_track_access: z.boolean(),
     license_plate_image_url: z.string().nullable(),
-    applicant_badge_image_url: z.string().nullable()
+    applicant_badge_image_url: z.string().nullable(),
+    buffer_entry_scanned_at: z.string().nullable(),
+    buffer_exit_scanned_at: z.string().nullable()
 })
     .openapi('ParkingBookingWithRelations');
 // ------------------------------
@@ -683,10 +717,42 @@ export const parkingBookingDetailsDataSchema = z
     applicant_badge_image_url: z.string().nullable().openapi({
         description: 'URL of the applicant badge image',
         example: 'https://example.com/applicant-badge.jpg'
+    }),
+    available_actions: z.array(z.string()).openapi({
+        description: 'List of vehicle actions available for this booking',
+        example: ['entering_buffer', 'exit_buffer', 'entering_event_site', 'exit_event_site']
+    }),
+    completed_actions: z
+        .array(z.object({
+        action: z.string().openapi({
+            description: 'The completed action',
+            example: 'entering_buffer'
+        }),
+        completed_at: z.string().openapi({
+            description: 'Timestamp when the action was completed',
+            example: '2025-01-30T10:15:00.000Z'
+        })
+    }))
+        .openapi({
+        description: 'List of vehicle actions that have been completed with timestamps',
+        example: [
+            {
+                action: 'entering_buffer',
+                completed_at: '2025-01-30T10:15:00.000Z'
+            }
+        ]
+    }),
+    buffer_entry_scanned_at: z.string().nullable().optional().openapi({
+        description: 'Timestamp when buffer entry was scanned',
+        example: '2025-12-15T08:05:00.000Z'
+    }),
+    buffer_exit_scanned_at: z.string().nullable().optional().openapi({
+        description: 'Timestamp when buffer exit was scanned',
+        example: '2025-12-15T08:25:00.000Z'
     })
 })
     .openapi('ParkingBookingDetailsData');
-export const getParkingBookingDetailsResponseSchema = createSuccessResponseSchema(parkingBookingDetailsDataSchema, 'GetParkingBookingDetailsResponse', 'Booking details with access pass information');
+export const getParkingBookingDetailsResponseSchema = createSuccessResponseSchema(parkingBookingDetailsDataSchema, 'GetParkingBookingDetailsResponse', 'Booking details with access pass information and available vehicle actions');
 // ------------------------------
 // Get booking details by token schemas
 // ------------------------------

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@venulog/phasing-engine-schemas",
-  "version": "0.13.3-alpha.1",
+  "version": "0.13.3-alpha.2",
   "description": "Shared schemas and types for Phasing Engine API",
   "type": "module",
   "main": "./dist/index.js",