@vulog/aima-booking 1.1.91 → 1.1.92

package/dist/index.d.mts

@@ -1,6 +1,7 @@
 import { Client } from '@vulog/aima-client';
 import { PaginableOptions, PaginableResponse } from '@vulog/aima-core';
 import { z } from 'zod';
+import { UUID } from 'crypto';
 
 type PaymentReceipts = {
     id: string;
@@ -195,4 +196,8 @@ 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 };
+declare const allocateVehicle: (client: Client, bookingRequestId: UUID, vehicleId: UUID, serviceId: UUID) => Promise<SATBookingRequest>;
+
+declare const deallocateVehicle: (client: Client, bookingRequestId: UUID, vehicleId: UUID) => Promise<SATBookingRequest>;
+
+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, allocateVehicle, deallocateVehicle, getBookingRequestById, getBookingRequestByTrip, getBookingRequests, getSATBookingRequests, getScheduleBookingRequests, getStationById, getStations, getSubscriptionBookingRequestById, getSubscriptionBookingRequests };

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import { Client } from '@vulog/aima-client';
 import { PaginableOptions, PaginableResponse } from '@vulog/aima-core';
 import { z } from 'zod';
+import { UUID } from 'crypto';
 
 type PaymentReceipts = {
     id: string;
@@ -195,4 +196,8 @@ 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 };
+declare const allocateVehicle: (client: Client, bookingRequestId: UUID, vehicleId: UUID, serviceId: UUID) => Promise<SATBookingRequest>;
+
+declare const deallocateVehicle: (client: Client, bookingRequestId: UUID, vehicleId: UUID) => Promise<SATBookingRequest>;
+
+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, allocateVehicle, deallocateVehicle, getBookingRequestById, getBookingRequestByTrip, getBookingRequests, getSATBookingRequests, getScheduleBookingRequests, getStationById, getStations, getSubscriptionBookingRequestById, getSubscriptionBookingRequests };

package/dist/index.js

@@ -1,7 +1,9 @@
 "use strict";
+var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __export = (target, all) => {
   for (var name in all)
@@ -15,11 +17,21 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  allocateVehicle: () => allocateVehicle,
+  deallocateVehicle: () => deallocateVehicle,
   getBookingRequestById: () => getBookingRequestById,
   getBookingRequestByTrip: () => getBookingRequestByTrip,
   getBookingRequests: () => getBookingRequests,
@@ -409,8 +421,47 @@ var getStationById = async (client, id, includes = []) => {
   }
   return station;
 };
+
+// src/allocateVehicle.ts
+var import_zod6 = __toESM(require("zod"));
+var allocateVehicleSchema = import_zod6.default.object({
+  bookingRequestId: import_zod6.default.string().uuid(),
+  vehicleId: import_zod6.default.string().uuid(),
+  serviceId: import_zod6.default.string().uuid()
+});
+var allocateVehicle = async (client, bookingRequestId, vehicleId, serviceId) => {
+  const resultPayload = allocateVehicleSchema.safeParse({ bookingRequestId, vehicleId, serviceId });
+  if (!resultPayload.success) {
+    throw new TypeError("Invalid args", {
+      cause: resultPayload.error.issues
+    });
+  }
+  return client.post(
+    `boapi/proxy/user/scheduleATrip/fleets/${client.clientOptions.fleetId}/bookingrequests/${bookingRequestId}/allocate/${vehicleId}?serviceId=${serviceId}`
+  ).then(({ data }) => data);
+};
+
+// src/deallocateVehicle.ts
+var import_zod7 = __toESM(require("zod"));
+var deallocateVehicleSchema = import_zod7.default.object({
+  bookingRequestId: import_zod7.default.string().uuid(),
+  vehicleId: import_zod7.default.string().uuid()
+});
+var deallocateVehicle = async (client, bookingRequestId, vehicleId) => {
+  const resultPayload = deallocateVehicleSchema.safeParse({ bookingRequestId, vehicleId });
+  if (!resultPayload.success) {
+    throw new TypeError("Invalid args", {
+      cause: resultPayload.error.issues
+    });
+  }
+  return client.delete(
+    `boapi/proxy/user/scheduledBooking/fleets/${client.clientOptions.fleetId}/bookingrequests/${bookingRequestId}/vehicles/${vehicleId}`
+  ).then(({ data }) => data);
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  allocateVehicle,
+  deallocateVehicle,
   getBookingRequestById,
   getBookingRequestByTrip,
   getBookingRequests,

package/dist/index.mjs

@@ -375,7 +375,46 @@ var getStationById = async (client, id, includes = []) => {
   }
   return station;
 };
+
+// src/allocateVehicle.ts
+import z6 from "zod";
+var allocateVehicleSchema = z6.object({
+  bookingRequestId: z6.string().uuid(),
+  vehicleId: z6.string().uuid(),
+  serviceId: z6.string().uuid()
+});
+var allocateVehicle = async (client, bookingRequestId, vehicleId, serviceId) => {
+  const resultPayload = allocateVehicleSchema.safeParse({ bookingRequestId, vehicleId, serviceId });
+  if (!resultPayload.success) {
+    throw new TypeError("Invalid args", {
+      cause: resultPayload.error.issues
+    });
+  }
+  return client.post(
+    `boapi/proxy/user/scheduleATrip/fleets/${client.clientOptions.fleetId}/bookingrequests/${bookingRequestId}/allocate/${vehicleId}?serviceId=${serviceId}`
+  ).then(({ data }) => data);
+};
+
+// src/deallocateVehicle.ts
+import z7 from "zod";
+var deallocateVehicleSchema = z7.object({
+  bookingRequestId: z7.string().uuid(),
+  vehicleId: z7.string().uuid()
+});
+var deallocateVehicle = async (client, bookingRequestId, vehicleId) => {
+  const resultPayload = deallocateVehicleSchema.safeParse({ bookingRequestId, vehicleId });
+  if (!resultPayload.success) {
+    throw new TypeError("Invalid args", {
+      cause: resultPayload.error.issues
+    });
+  }
+  return client.delete(
+    `boapi/proxy/user/scheduledBooking/fleets/${client.clientOptions.fleetId}/bookingrequests/${bookingRequestId}/vehicles/${vehicleId}`
+  ).then(({ data }) => data);
+};
 export {
+  allocateVehicle,
+  deallocateVehicle,
   getBookingRequestById,
   getBookingRequestByTrip,
   getBookingRequests,

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@vulog/aima-booking",
-    "version": "1.1.91",
+    "version": "1.1.92",
     "main": "dist/index.js",
     "module": "dist/index.mjs",
     "types": "dist/index.d.ts",
@@ -19,8 +19,8 @@
     "author": "Vulog",
     "license": "MIT",
     "dependencies": {
-        "@vulog/aima-client": "1.1.91",
-        "@vulog/aima-core": "1.1.91"
+        "@vulog/aima-client": "1.1.92",
+        "@vulog/aima-core": "1.1.92"
     },
     "peerDependencies": {
         "es-toolkit": "^1.39.9",

package/src/allocateVehicle.test.ts

@@ -0,0 +1,49 @@
+import { describe, test, vi, expect, beforeEach } from 'vitest';
+
+import { Client } from '@vulog/aima-client';
+import { allocateVehicle } from './allocateVehicle';
+import { UUID } from 'crypto';
+
+describe('allocateVehicle', () => {
+    const postMock = vi.fn();
+    const client = {
+        post: postMock,
+        clientOptions: {
+            fleetId: 'FLEET_ID',
+        },
+    } as unknown as Client;
+
+    beforeEach(() => {
+        vi.clearAllMocks();
+    });
+
+    test('should return invalid args', async () => {
+        const bookingRequestId = 'BOOKING_REQUEST_ID';
+        const vehicleId = 'VEHICLE_ID';
+        const serviceId = 'SERVICE_ID';
+
+        // expect to throw error if invalid UUIDs are provided
+        await expect(
+            allocateVehicle(client, bookingRequestId as UUID, vehicleId as UUID, serviceId as UUID)
+        ).rejects.toThrow('Invalid args');
+    });
+
+    test('should allocate vehicle successfully', async () => {
+        const bookingRequestId = '550e8400-e29b-41d4-a716-446655440000';
+        const vehicleId = '550e8400-e29b-41d4-a716-446655440001';
+        const serviceId = '550e8400-e29b-41d4-a716-446655440002';
+
+        const mockResponse = {
+            id: 'some-id',
+            status: 'ALLOCATED',
+            // other properties of SATBookingRequest
+        };
+
+        postMock.mockResolvedValueOnce({
+            data: mockResponse,
+        });
+
+        const result = await allocateVehicle(client, bookingRequestId, vehicleId, serviceId);
+        expect(result).toEqual(mockResponse);
+    });
+});

package/src/allocateVehicle.ts

@@ -0,0 +1,32 @@
+import { UUID } from 'crypto';
+
+import { Client } from '@vulog/aima-client';
+
+import z from 'zod';
+
+import { SATBookingRequest } from './types';
+
+const allocateVehicleSchema = z.object({
+    bookingRequestId: z.string().uuid(),
+    vehicleId: z.string().uuid(),
+    serviceId: z.string().uuid(),
+});
+
+export const allocateVehicle = async (
+    client: Client,
+    bookingRequestId: UUID,
+    vehicleId: UUID,
+    serviceId: UUID
+): Promise<SATBookingRequest> => {
+    const resultPayload = allocateVehicleSchema.safeParse({ bookingRequestId, vehicleId, serviceId });
+    if (!resultPayload.success) {
+        throw new TypeError('Invalid args', {
+            cause: resultPayload.error.issues,
+        });
+    }
+    return client
+        .post<SATBookingRequest>(
+            `boapi/proxy/user/scheduleATrip/fleets/${client.clientOptions.fleetId}/bookingrequests/${bookingRequestId}/allocate/${vehicleId}?serviceId=${serviceId}`
+        )
+        .then(({ data }) => data);
+};

package/src/deallocateVehicle.test.ts

@@ -0,0 +1,47 @@
+import { describe, test, vi, expect, beforeEach } from 'vitest';
+
+import { Client } from '@vulog/aima-client';
+import { deallocateVehicle } from './deallocateVehicle';
+import { UUID } from 'crypto';
+
+describe('deallocateVehicle', () => {
+    const deleteMock = vi.fn();
+    const client = {
+        delete: deleteMock,
+        clientOptions: {
+            fleetId: 'FLEET_ID',
+        },
+    } as unknown as Client;
+
+    beforeEach(() => {
+        vi.clearAllMocks();
+    });
+
+    test('should return invalid args', async () => {
+        const bookingRequestId = 'BOOKING_REQUEST_ID';
+        const vehicleId = 'VEHICLE_ID';
+
+        // expect to throw error if invalid UUIDs are provided
+        await expect(deallocateVehicle(client, bookingRequestId as UUID, vehicleId as UUID)).rejects.toThrow(
+            'Invalid args'
+        );
+    });
+
+    test('should deallocate vehicle successfully', async () => {
+        const bookingRequestId = '550e8400-e29b-41d4-a716-446655440000';
+        const vehicleId = '550e8400-e29b-41d4-a716-446655440001';
+
+        const mockResponse = {
+            id: 'some-id',
+            vehicleId: null,
+            // other properties of SATBookingRequest
+        };
+
+        deleteMock.mockResolvedValueOnce({
+            data: mockResponse,
+        });
+
+        const result = await deallocateVehicle(client, bookingRequestId, vehicleId);
+        expect(result).toEqual(mockResponse);
+    });
+});

package/src/deallocateVehicle.ts

@@ -0,0 +1,32 @@
+// https://java-sta.vulog.com/boapi/proxy/user/scheduledBooking/fleets/LEO-CAMTR/bookingrequests/2e603670-9684-4df1-9ff5-7f380ce6b8dc/vehicles/2e15c6f2-0b75-47ca-b885-b60f6ac35b12
+
+import { UUID } from 'crypto';
+
+import { Client } from '@vulog/aima-client';
+
+import z from 'zod';
+
+import { SATBookingRequest } from './types';
+
+const deallocateVehicleSchema = z.object({
+    bookingRequestId: z.string().uuid(),
+    vehicleId: z.string().uuid(),
+});
+
+export const deallocateVehicle = async (
+    client: Client,
+    bookingRequestId: UUID,
+    vehicleId: UUID
+): Promise<SATBookingRequest> => {
+    const resultPayload = deallocateVehicleSchema.safeParse({ bookingRequestId, vehicleId });
+    if (!resultPayload.success) {
+        throw new TypeError('Invalid args', {
+            cause: resultPayload.error.issues,
+        });
+    }
+    return client
+        .delete<SATBookingRequest>(
+            `boapi/proxy/user/scheduledBooking/fleets/${client.clientOptions.fleetId}/bookingrequests/${bookingRequestId}/vehicles/${vehicleId}`
+        )
+        .then(({ data }) => data);
+};

package/src/index.ts

@@ -8,3 +8,5 @@ export { getStations } from './getStations';
 export type { Include } from './getStations';
 export { getStationById } from './getStation';
 export type { IncludeStation } from './getStation';
+export { allocateVehicle } from './allocateVehicle';
+export { deallocateVehicle } from './deallocateVehicle';