@vulog/aima-booking 1.1.88 → 1.1.91

package/README.md

@@ -1,26 +1,308 @@
 # @vulog/aima-booking
 
+Booking management module for the AIMA platform. This module provides functionality to manage booking requests, stations, and subscription bookings.
+
+## Installation
+
 ```bash
-npm i @vulog/aima-client @vulog/aima-core @vulog/aima-booking
+npm install @vulog/aima-client @vulog/aima-core @vulog/aima-booking
+```
+
+## Usage
+
+### Initialize Client
+
+```javascript
+import { getClient } from '@vulog/aima-client';
+import { 
+    getBookingRequests, 
+    getScheduleBookingRequests, 
+    getSubscriptionBookingRequests,
+    getSATBookingRequests,
+    getBookingRequestById,
+    getBookingRequestByTrip,
+    getSubscriptionBookingRequestById,
+    getStations,
+    getStationById
+} from '@vulog/aima-booking';
+
+const client = getClient({
+    apiKey: 'your-api-key',
+    baseUrl: 'https://your-api-base-url',
+    clientId: 'your-client-id',
+    clientSecret: 'your-client-secret',
+    fleetId: 'your-fleet-id',
+});
+```
+
+## API Reference
+
+### Booking Requests
+
+#### getBookingRequests
+
+Retrieve booking requests with optional filtering.
+
+```javascript
+const bookingRequests = await getBookingRequests(client, 'ONGOING', {
+    limit: 50,
+    offset: 0,
+    userId: 'user-uuid-here'
+});
+```
+
+**Parameters:**
+- `client`: AIMA client instance
+- `status`: Booking request status ('ONGOING', 'COMPLETED', 'CANCELLED', 'EXPIRED')
+- `filters`: Optional filter object
+  - `limit`: Maximum number of results
+  - `offset`: Number of results to skip
+  - `userId`: Filter by user ID
+  - `vehicleId`: Filter by vehicle ID
+  - `stationId`: Filter by station ID
+
+#### getScheduleBookingRequests
+
+Get scheduled booking requests.
+
+```javascript
+const scheduledRequests = await getScheduleBookingRequests(client, {
+    startDate: '2024-01-01T00:00:00Z',
+    endDate: '2024-01-31T23:59:59Z'
+});
+```
+
+#### getSubscriptionBookingRequests
+
+Get subscription-based booking requests.
+
+```javascript
+const subscriptionRequests = await getSubscriptionBookingRequests(client, {
+    status: 'ACTIVE',
+    userId: 'user-uuid-here'
+});
+```
+
+#### getSATBookingRequests
+
+Get SAT (Scheduled Access Time) booking requests.
+
+```javascript
+const satRequests = await getSATBookingRequests(client, 'PENDING');
+```
+
+### Individual Booking Requests
+
+#### getBookingRequestById
+
+Retrieve a specific booking request by ID.
+
+```javascript
+const bookingRequest = await getBookingRequestById(client, 'bb493049-5b4f-43ea-8a65-964a13aec549');
+```
+
+#### getBookingRequestByTrip
+
+Get booking request associated with a trip.
+
+```javascript
+const bookingRequest = await getBookingRequestByTrip(client, '33E8E42710144E15A5CC447E4D3524F4');
+```
+
+#### getSubscriptionBookingRequestById
+
+Get subscription booking request by ID.
+
+```javascript
+const subscriptionRequest = await getSubscriptionBookingRequestById(client, 'b7faa2a2-e8fc-4a29-8de7-09ce783b9797');
+```
+
+### Stations
+
+#### getStations
+
+Retrieve stations with optional includes.
+
+```javascript
+const stations = await getStations(client, ['OPEN_HOUR', 'INFO']);
+```
+
+**Parameters:**
+- `client`: AIMA client instance
+- `includes`: Array of data to include ('OPEN_HOUR', 'INFO', 'VEHICLES', 'ZONES')
+
+#### getStationById
+
+Get a specific station by ID.
+
+```javascript
+const station = await getStationById(client, 'station-id-here', ['OPEN_HOUR', 'INFO']);
+```
+
+## Types
+
+### BookingRequest
+
+```typescript
+interface BookingRequest {
+    id: string;
+    userId: string;
+    vehicleId: string;
+    stationId: string;
+    status: 'PENDING' | 'ONGOING' | 'COMPLETED' | 'CANCELLED' | 'EXPIRED';
+    startTime: string;
+    endTime: string;
+    createdAt: string;
+    updatedAt: string;
+}
+```
+
+### Station
+
+```typescript
+interface Station {
+    id: string;
+    name: string;
+    address: string;
+    coordinates: {
+        latitude: number;
+        longitude: number;
+    };
+    isActive: boolean;
+    openHours: OpenHours[];
+    info: StationInfo;
+    vehicles: Vehicle[];
+    zones: Zone[];
+}
+```
+
+### BookingRequestStatus
+
+```typescript
+type BookingRequestStatus = 'PENDING' | 'ONGOING' | 'COMPLETED' | 'CANCELLED' | 'EXPIRED';
+```
+
+### ServiceType
+
+```typescript
+type ServiceType = 'CAR_SHARING' | 'BIKE_SHARING' | 'SCOOTER_SHARING' | 'MULTIMODAL';
 ```
 
+## Error Handling
+
+All functions include validation and will throw appropriate errors if:
+- Required parameters are missing
+- Invalid booking request or station IDs are provided
+- Invalid status values are used
+- Network errors occur
+
+## Examples
+
+### Complete Booking Management Workflow
+
 ```javascript
 import { getClient } from '@vulog/aima-client';
-import { getBookingRequests } from '@vulog/aima-booking';
+import { 
+    getBookingRequests, 
+    getStations, 
+    getBookingRequestById 
+} from '@vulog/aima-booking';
 
 const client = getClient({
-    apiKey: '...',
-    baseUrl: '...',
-    clientId: '...',
-    clientSecret: '...',
-    fleetId: '...',
+    apiKey: 'your-api-key',
+    baseUrl: 'https://your-api-base-url',
+    clientId: 'your-client-id',
+    clientSecret: 'your-client-secret',
+    fleetId: 'your-fleet-id',
 });
 
-const response = await getBookingRequests(client, 'ONGOING');
+async function bookingWorkflow() {
+    try {
+        // Get all ongoing booking requests
+        const ongoingRequests = await getBookingRequests(client, 'ONGOING');
+        console.log(`Found ${ongoingRequests.length} ongoing booking requests`);
+        
+        // Get stations with full information
+        const stations = await getStations(client, ['OPEN_HOUR', 'INFO', 'VEHICLES']);
+        console.log(`Found ${stations.length} stations`);
+        
+        // Get specific booking request
+        const bookingRequest = await getBookingRequestById(client, 'bb493049-5b4f-43ea-8a65-964a13aec549');
+        console.log('Booking request details:', bookingRequest);
+        
+        return { ongoingRequests, stations, bookingRequest };
+    } catch (error) {
+        console.error('Booking workflow error:', error);
+        throw error;
+    }
+}
+```
 
-const station = await getStations(client, ['OPEN_HOUR', 'INFO']);
+### Station Analysis
 
-const br1 = await getBookingRequestById(client, 'bb493049-5b4f-43ea-8a65-964a13aec549');
-const br2 = await getBookingRequestByTrip(client, '33E8E42710144E15A5CC447E4D3524F4');
-const sub = await getSubscriptionBookingRequestById(client, 'b7faa2a2-e8fc-4a29-8de7-09ce783b9797');
+```javascript
+async function analyzeStations(client) {
+    try {
+        const stations = await getStations(client, ['OPEN_HOUR', 'INFO', 'VEHICLES']);
+        
+        const analysis = {
+            totalStations: stations.length,
+            activeStations: stations.filter(s => s.isActive).length,
+            stationsWithVehicles: stations.filter(s => s.vehicles && s.vehicles.length > 0).length,
+            averageVehiclesPerStation: stations.reduce((sum, s) => sum + (s.vehicles?.length || 0), 0) / stations.length,
+            stationsByZone: stations.reduce((acc, station) => {
+                station.zones?.forEach(zone => {
+                    acc[zone.name] = (acc[zone.name] || 0) + 1;
+                });
+                return acc;
+            }, {})
+        };
+        
+        console.log('Station Analysis:');
+        console.log(`Total Stations: ${analysis.totalStations}`);
+        console.log(`Active Stations: ${analysis.activeStations}`);
+        console.log(`Stations with Vehicles: ${analysis.stationsWithVehicles}`);
+        console.log(`Average Vehicles per Station: ${analysis.averageVehiclesPerStation.toFixed(2)}`);
+        console.log('Stations by Zone:', analysis.stationsByZone);
+        
+        return analysis;
+    } catch (error) {
+        console.error('Station analysis error:', error);
+        throw error;
+    }
+}
+```
+
+### Booking Request Monitoring
+
+```javascript
+async function monitorBookingRequests(client) {
+    try {
+        const [ongoing, completed, cancelled] = await Promise.all([
+            getBookingRequests(client, 'ONGOING'),
+            getBookingRequests(client, 'COMPLETED'),
+            getBookingRequests(client, 'CANCELLED')
+        ]);
+        
+        const monitoring = {
+            ongoing: ongoing.length,
+            completed: completed.length,
+            cancelled: cancelled.length,
+            total: ongoing.length + completed.length + cancelled.length,
+            completionRate: completed.length / (completed.length + cancelled.length) * 100
+        };
+        
+        console.log('Booking Request Monitoring:');
+        console.log(`Ongoing: ${monitoring.ongoing}`);
+        console.log(`Completed: ${monitoring.completed}`);
+        console.log(`Cancelled: ${monitoring.cancelled}`);
+        console.log(`Total: ${monitoring.total}`);
+        console.log(`Completion Rate: ${monitoring.completionRate.toFixed(2)}%`);
+        
+        return monitoring;
+    } catch (error) {
+        console.error('Booking monitoring error:', error);
+        throw error;
+    }
+}
 ```

package/dist/index.d.mts

@@ -104,6 +104,47 @@ type SATBookingRequest = BaseBookingRequest & {
     trip: any | null;
     warning: string | null;
 };
+type GeoInfo = {
+    name: string;
+    coordinates: {
+        latitude: number;
+        longitude: number;
+    };
+    geoProperties: {
+        [key: string]: any;
+    };
+};
+type Service = {
+    id: string;
+    models: {
+        id: number;
+        vehicles: string[];
+    }[];
+};
+type ServiceInfo = {
+    services: Service[];
+};
+type Days = 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
+type DayOpeningHours = {
+    id: number;
+    closed: boolean;
+    openAt: string;
+    closeAt: string;
+};
+type Timetable = Record<Days, DayOpeningHours[]>;
+type OpeningHours = {
+    alwaysOpen: boolean;
+    timetable: Timetable;
+};
+type Station = Partial<GeoInfo> & Partial<ServiceInfo> & {
+    id: string;
+    zoneId: string;
+    poiId: string;
+    modificationDate: string;
+    fleetId: string;
+    openingHours?: OpeningHours;
+    [key: string]: any;
+};
 
 declare const BookingRequestStatusSchema: z.ZodEnum<["ALERT", "UPCOMING", "ONGOING", "COMPLETED", "CANCELLED", "PENDING_APPROVAL"]>;
 type BookingRequestStatus = z.infer<typeof BookingRequestStatusSchema>;
@@ -146,49 +187,12 @@ declare const getBookingRequestById: (client: Client, id: string) => Promise<Boo
 declare const getBookingRequestByTrip: (client: Client, tripId: string) => Promise<BookingRequest>;
 declare const getSubscriptionBookingRequestById: (client: Client, id: string) => Promise<BookingRequest>;
 
-declare const IncludeSchema: z.ZodEnum<["INFO", "OPEN_HOUR", "SERVICES"]>;
-type Include = z.infer<typeof IncludeSchema>;
-type Days = 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
-type DayOpeningHours = {
-    id: number;
-    closed: boolean;
-    openAt: string;
-    closeAt: string;
-};
-type Timetable = Record<Days, DayOpeningHours[]>;
-type OpeningHours = {
-    alwaysOpen: boolean;
-    timetable: Timetable;
-};
-type GeoInfo = {
-    name: string;
-    coordinates: {
-        latitude: number;
-        longitude: number;
-    };
-    geoProperties: {
-        [key: string]: any;
-    };
-};
-type Service = {
-    id: string;
-    models: {
-        id: number;
-        vehicles: string[];
-    }[];
-};
-type ServiceInfo = {
-    services: Service[];
-};
-type Station = Partial<GeoInfo> & Partial<ServiceInfo> & {
-    id: string;
-    zoneId: string;
-    poiId: string;
-    modificationDate: string;
-    fleetId: string;
-    openingHours?: OpeningHours;
-    [key: string]: any;
-};
+declare const IncludeSchema$1: z.ZodEnum<["INFO", "OPEN_HOUR", "SERVICES"]>;
+type Include = z.infer<typeof IncludeSchema$1>;
 declare const getStations: (client: Client, includes?: Include[]) => Promise<Station[]>;
 
-export { type BookingRequest, type BookingRequestFilters, type BookingRequestStatus, type DayOpeningHours, type Days, type Include, type OpeningHours, type SATBookingRequestStatus, type ServiceType, type Station, type Timetable, getBookingRequestById, getBookingRequestByTrip, getBookingRequests, getSATBookingRequests, getScheduleBookingRequests, getStations, getSubscriptionBookingRequestById, getSubscriptionBookingRequests };
+declare const IncludeSchema: z.ZodEnum<["INFO", "SERVICES"]>;
+type IncludeStation = z.infer<typeof IncludeSchema>;
+declare const getStationById: (client: Client, id: string, includes?: IncludeStation[]) => Promise<Station | null>;
+
+export { type BaseBookingRequest, type BookingRequest, type BookingRequestFilters, type BookingRequestStatus, type CustomPrice, type DayOpeningHours, type Days, type GeoInfo, type Include, type IncludeStation, type OpeningHours, type PaymentReceipts, type SATBookingRequest, type SATBookingRequestStatus, type Service, type ServiceInfo, type ServiceType, type Station, type Timetable, getBookingRequestById, getBookingRequestByTrip, getBookingRequests, getSATBookingRequests, getScheduleBookingRequests, getStationById, getStations, getSubscriptionBookingRequestById, getSubscriptionBookingRequests };

package/dist/index.d.ts

@@ -104,6 +104,47 @@ type SATBookingRequest = BaseBookingRequest & {
     trip: any | null;
     warning: string | null;
 };
+type GeoInfo = {
+    name: string;
+    coordinates: {
+        latitude: number;
+        longitude: number;
+    };
+    geoProperties: {
+        [key: string]: any;
+    };
+};
+type Service = {
+    id: string;
+    models: {
+        id: number;
+        vehicles: string[];
+    }[];
+};
+type ServiceInfo = {
+    services: Service[];
+};
+type Days = 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
+type DayOpeningHours = {
+    id: number;
+    closed: boolean;
+    openAt: string;
+    closeAt: string;
+};
+type Timetable = Record<Days, DayOpeningHours[]>;
+type OpeningHours = {
+    alwaysOpen: boolean;
+    timetable: Timetable;
+};
+type Station = Partial<GeoInfo> & Partial<ServiceInfo> & {
+    id: string;
+    zoneId: string;
+    poiId: string;
+    modificationDate: string;
+    fleetId: string;
+    openingHours?: OpeningHours;
+    [key: string]: any;
+};
 
 declare const BookingRequestStatusSchema: z.ZodEnum<["ALERT", "UPCOMING", "ONGOING", "COMPLETED", "CANCELLED", "PENDING_APPROVAL"]>;
 type BookingRequestStatus = z.infer<typeof BookingRequestStatusSchema>;
@@ -146,49 +187,12 @@ declare const getBookingRequestById: (client: Client, id: string) => Promise<Boo
 declare const getBookingRequestByTrip: (client: Client, tripId: string) => Promise<BookingRequest>;
 declare const getSubscriptionBookingRequestById: (client: Client, id: string) => Promise<BookingRequest>;
 
-declare const IncludeSchema: z.ZodEnum<["INFO", "OPEN_HOUR", "SERVICES"]>;
-type Include = z.infer<typeof IncludeSchema>;
-type Days = 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
-type DayOpeningHours = {
-    id: number;
-    closed: boolean;
-    openAt: string;
-    closeAt: string;
-};
-type Timetable = Record<Days, DayOpeningHours[]>;
-type OpeningHours = {
-    alwaysOpen: boolean;
-    timetable: Timetable;
-};
-type GeoInfo = {
-    name: string;
-    coordinates: {
-        latitude: number;
-        longitude: number;
-    };
-    geoProperties: {
-        [key: string]: any;
-    };
-};
-type Service = {
-    id: string;
-    models: {
-        id: number;
-        vehicles: string[];
-    }[];
-};
-type ServiceInfo = {
-    services: Service[];
-};
-type Station = Partial<GeoInfo> & Partial<ServiceInfo> & {
-    id: string;
-    zoneId: string;
-    poiId: string;
-    modificationDate: string;
-    fleetId: string;
-    openingHours?: OpeningHours;
-    [key: string]: any;
-};
+declare const IncludeSchema$1: z.ZodEnum<["INFO", "OPEN_HOUR", "SERVICES"]>;
+type Include = z.infer<typeof IncludeSchema$1>;
 declare const getStations: (client: Client, includes?: Include[]) => Promise<Station[]>;
 
-export { type BookingRequest, type BookingRequestFilters, type BookingRequestStatus, type DayOpeningHours, type Days, type Include, type OpeningHours, type SATBookingRequestStatus, type ServiceType, type Station, type Timetable, getBookingRequestById, getBookingRequestByTrip, getBookingRequests, getSATBookingRequests, getScheduleBookingRequests, getStations, getSubscriptionBookingRequestById, getSubscriptionBookingRequests };
+declare const IncludeSchema: z.ZodEnum<["INFO", "SERVICES"]>;
+type IncludeStation = z.infer<typeof IncludeSchema>;
+declare const getStationById: (client: Client, id: string, includes?: IncludeStation[]) => Promise<Station | null>;
+
+export { type BaseBookingRequest, type BookingRequest, type BookingRequestFilters, type BookingRequestStatus, type CustomPrice, type DayOpeningHours, type Days, type GeoInfo, type Include, type IncludeStation, type OpeningHours, type PaymentReceipts, type SATBookingRequest, type SATBookingRequestStatus, type Service, type ServiceInfo, type ServiceType, type Station, type Timetable, getBookingRequestById, getBookingRequestByTrip, getBookingRequests, getSATBookingRequests, getScheduleBookingRequests, getStationById, getStations, getSubscriptionBookingRequestById, getSubscriptionBookingRequests };

package/dist/index.js

@@ -25,6 +25,7 @@ __export(index_exports, {
   getBookingRequests: () => getBookingRequests,
   getSATBookingRequests: () => getSATBookingRequests,
   getScheduleBookingRequests: () => getScheduleBookingRequests,
+  getStationById: () => getStationById,
   getStations: () => getStations,
   getSubscriptionBookingRequestById: () => getSubscriptionBookingRequestById,
   getSubscriptionBookingRequests: () => getSubscriptionBookingRequests
@@ -304,6 +305,110 @@ var getStations = async (client, includes = []) => {
   }
   return stations;
 };
+
+// src/getStation.ts
+var import_zod5 = require("zod");
+var IncludeSchema2 = import_zod5.z.enum(["INFO", "SERVICES"]);
+var IncludesSchema2 = import_zod5.z.array(IncludeSchema2);
+var getStationById = async (client, id, includes = []) => {
+  const resultIncludes = IncludesSchema2.safeParse(includes);
+  if (!resultIncludes.success) {
+    throw new TypeError("Invalid includes", {
+      cause: resultIncludes.error.issues
+    });
+  }
+  const station = await client.get(`/boapi/proxy/user/scheduledBooking/fleets/${client.clientOptions.fleetId}/stations/${id}`).then(({ data, status }) => {
+    if (status === 200) {
+      return Object.keys(data).reduce((acc, key) => {
+        if (key === "stationTimetableDTO") {
+          if (data.stationTimetableDTO?.stationId) {
+            acc.openingHours = {
+              alwaysOpen: data.stationTimetableDTO.alwaysOpen,
+              timetable: Object.keys(data.stationTimetableDTO.timetable).reduce(
+                (timetable, val) => {
+                  timetable[val] = data.stationTimetableDTO.timetable[val].map(
+                    (day) => ({
+                      id: day.id,
+                      closed: day.closed,
+                      openAt: day.openAt,
+                      closeAt: day.closeAt
+                    })
+                  );
+                  return timetable;
+                },
+                {}
+              )
+            };
+          }
+          return acc;
+        }
+        acc[key] = data[key];
+        return acc;
+      }, {});
+    }
+    if (status === 400) {
+      return null;
+    }
+    return null;
+  }).catch((error) => {
+    if (error.formattedError?.status === 400) {
+      return null;
+    }
+    throw error;
+  });
+  if (station && includes.includes("INFO")) {
+    const poi = await client.get(
+      `/boapi/proxy/geoloc/fleets/${client.clientOptions.fleetId}/pois/${station.poiId}`,
+      {
+        headers: { accept: "application/vnd.geo+json" }
+      }
+    ).then(
+      ({ data }) => data.features.reduce(
+        (max, current) => {
+          if (current.properties.Version > max.version) {
+            const {
+              geometry: {
+                coordinates: [longitude, latitude]
+              },
+              properties
+            } = current;
+            return {
+              version: current.properties.Version,
+              name: properties.name,
+              coordinates: { latitude, longitude },
+              geoProperties: properties
+            };
+          }
+          return max;
+        },
+        { version: -1 }
+      )
+    );
+    if (station.poiId && poi) {
+      poi.version = void 0;
+      Object.assign(station, poi);
+      station.name = station.geoProperties?.name;
+    }
+  }
+  if (station && includes.includes("SERVICES")) {
+    const services = await client.get(`/boapi/proxy/user/fleets/${client.clientOptions.fleetId}/stations/details?showTimetable=false`).then(
+      ({ data }) => data.stations.reduce((acc, service) => {
+        if (!acc[service.station.id]) {
+          acc[service.station.id] = { services: [] };
+        }
+        acc[service.station.id].services.push({
+          id: service.serviceId,
+          models: service.station.models
+        });
+        return acc;
+      }, {})
+    );
+    if (services[station.id]) {
+      Object.assign(station, services[station.id]);
+    }
+  }
+  return station;
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   getBookingRequestById,
@@ -311,6 +416,7 @@ var getStations = async (client, includes = []) => {
   getBookingRequests,
   getSATBookingRequests,
   getScheduleBookingRequests,
+  getStationById,
   getStations,
   getSubscriptionBookingRequestById,
   getSubscriptionBookingRequests