@vulog/aima-vehicle 1.2.32 → 1.2.34

package/README.md

@@ -98,6 +98,95 @@ const updatedVehiclesPage = await getVehiclesRealTimePage(client, 0, 100, lastSy
 
 Note: `getVehiclesRealTimePage` is an internal function and is not exported from the package. It's used internally by `getVehiclesRealTime` to handle the pagination logic.
 
+### Create a Vehicle
+
+Creates a new vehicle in the fleet.
+
+```javascript
+import { createVehicle } from '@vulog/aima-vehicle';
+
+const vehicle = await createVehicle(client, {
+    vin: '1HGBH41JXMN109186',
+    plate: 'AB-123-CD',
+    name: 'My Vehicle',
+    model: { id: 372 },
+    // optional fields
+    vuboxId: 'vubox-123',
+    externalId: 'ext-123',
+    noBox: false,
+    published: true,
+});
+```
+
+### Get Options
+
+Fetches all vehicle options available in the fleet.
+
+```javascript
+import { getOptions } from '@vulog/aima-vehicle';
+
+const options = await getOptions(client);
+```
+
+### Add / Remove Option for Vehicle
+
+Add or remove an option to/from a vehicle.
+
+```javascript
+import { addOptionForVehicle, removeOptionForVehicle } from '@vulog/aima-vehicle';
+
+const vehicle = await addOptionForVehicle(client, 'vehicle-uuid', 25);
+const vehicle = await removeOptionForVehicle(client, 'vehicle-uuid', 25);
+```
+
+### Add / Remove Service for Vehicle
+
+Add or remove a service to/from a vehicle.
+
+```javascript
+import { addServiceForVehicle, removeServiceForVehicle } from '@vulog/aima-vehicle';
+
+await addServiceForVehicle(client, 'service-uuid', 'vehicle-uuid');
+await removeServiceForVehicle(client, 'service-uuid', 'vehicle-uuid');
+```
+
+### Enable / Disable Vehicle
+
+Enable or disable a vehicle with a sub-status.
+
+```javascript
+import { enableVehicle, disableVehicle } from '@vulog/aima-vehicle';
+
+await enableVehicle(client, 'vehicle-uuid', { subStatus: 'AVAILABLE' });
+await disableVehicle(client, 'vehicle-uuid', { subStatus: 'MAINTENANCE' });
+```
+
+### Ping Vehicle
+
+Check if a vehicle box is connected.
+
+```javascript
+import { pingVehicleById } from '@vulog/aima-vehicle';
+
+const isConnected = await pingVehicleById(client, 'vehicle-uuid');
+// true = connected, false = connection problem
+```
+
+### Get Model Vehicles
+
+Fetches paginated model vehicle listings.
+
+```javascript
+import { getModelVehicles } from '@vulog/aima-vehicle';
+
+const result = await getModelVehicles(client, {
+    page: 0,
+    pageSize: 50,
+    sort: 'modelId',
+    sortDirection: 'DESC',
+});
+```
+
 ## Types
 
 ### Vehicle

package/dist/index.cjs

@@ -238,20 +238,42 @@ const createVehicle = async (client, body) => {
 };
 //#endregion
 //#region src/vehicleService.ts
-const uuidSchema = zod.z.string().trim().min(1).uuid();
+const uuidSchema$1 = zod.z.string().trim().min(1).uuid();
 const addServiceForVehicle = async (client, serviceId, vehicleId) => {
-	const parsedServiceId = uuidSchema.safeParse(serviceId);
-	const parsedVehicleId = uuidSchema.safeParse(vehicleId);
+	const parsedServiceId = uuidSchema$1.safeParse(serviceId);
+	const parsedVehicleId = uuidSchema$1.safeParse(vehicleId);
 	if (!parsedServiceId.success || !parsedVehicleId.success) throw new TypeError("Invalid args", { cause: [...parsedServiceId.error?.issues ?? [], ...parsedVehicleId.error?.issues ?? []] });
 	await client.put(`/boapi/proxy/user/fleets/${client.clientOptions.fleetId}/services/${parsedServiceId.data}/vehicles/${parsedVehicleId.data}`, {});
 };
 const removeServiceForVehicle = async (client, serviceId, vehicleId) => {
-	const parsedServiceId = uuidSchema.safeParse(serviceId);
-	const parsedVehicleId = uuidSchema.safeParse(vehicleId);
+	const parsedServiceId = uuidSchema$1.safeParse(serviceId);
+	const parsedVehicleId = uuidSchema$1.safeParse(vehicleId);
 	if (!parsedServiceId.success || !parsedVehicleId.success) throw new TypeError("Invalid args", { cause: [...parsedServiceId.error?.issues ?? [], ...parsedVehicleId.error?.issues ?? []] });
 	await client.delete(`/boapi/proxy/user/fleets/${client.clientOptions.fleetId}/services/${parsedServiceId.data}/vehicles/${parsedVehicleId.data}`);
 };
 //#endregion
+//#region src/getOptions.ts
+const getOptions = async (client) => {
+	return client.get(`/boapi/proxy/vehicle/fleets/${client.clientOptions.fleetId}/vehicles/options`).then(({ data }) => data);
+};
+//#endregion
+//#region src/vehicleOption.ts
+const uuidSchema = zod.z.string().trim().min(1).uuid();
+const optionIdSchema = zod.z.number().int().positive();
+const addOptionForVehicle = async (client, vehicleId, optionId) => {
+	const parsedVehicleId = uuidSchema.safeParse(vehicleId);
+	const parsedOptionId = optionIdSchema.safeParse(optionId);
+	if (!parsedVehicleId.success || !parsedOptionId.success) throw new TypeError("Invalid args", { cause: [...parsedVehicleId.error?.issues ?? [], ...parsedOptionId.error?.issues ?? []] });
+	return client.put(`/boapi/proxy/vehicle/fleets/${client.clientOptions.fleetId}/vehicles/${parsedVehicleId.data}/options/${parsedOptionId.data}`, {}).then(({ data }) => data);
+};
+const removeOptionForVehicle = async (client, vehicleId, optionId) => {
+	const parsedVehicleId = uuidSchema.safeParse(vehicleId);
+	const parsedOptionId = optionIdSchema.safeParse(optionId);
+	if (!parsedVehicleId.success || !parsedOptionId.success) throw new TypeError("Invalid args", { cause: [...parsedVehicleId.error?.issues ?? [], ...parsedOptionId.error?.issues ?? []] });
+	return client.delete(`/boapi/proxy/vehicle/fleets/${client.clientOptions.fleetId}/vehicles/${parsedVehicleId.data}/options/${parsedOptionId.data}`).then(({ data }) => data);
+};
+//#endregion
+exports.addOptionForVehicle = addOptionForVehicle;
 exports.addServiceForVehicle = addServiceForVehicle;
 exports.createVehicle = createVehicle;
 exports.disableVehicle = disableVehicle;
@@ -260,10 +282,12 @@ exports.getModelByIdAssets = getModelByIdAssets;
 exports.getModelVehicles = getModelVehicles;
 exports.getModels = getModels;
 exports.getModelsById = getModelsById;
+exports.getOptions = getOptions;
 exports.getVehicleById = getVehicleById;
 exports.getVehicleByIdAssets = getVehicleByIdAssets;
 exports.getVehicleRealTimeById = getVehicleRealTimeById;
 exports.getVehicles = getVehicles;
 exports.getVehiclesRealTime = getVehiclesRealTime;
 exports.pingVehicleById = pingVehicleById;
+exports.removeOptionForVehicle = removeOptionForVehicle;
 exports.removeServiceForVehicle = removeServiceForVehicle;

package/dist/index.d.cts

@@ -274,4 +274,11 @@ declare const createVehicle: (client: Client, body: CreateVehicleBody) => Promis
 declare const addServiceForVehicle: (client: Client, serviceId: string, vehicleId: string) => Promise<void>;
 declare const removeServiceForVehicle: (client: Client, serviceId: string, vehicleId: string) => Promise<void>;
 //#endregion
-export { Assets, CreateVehicleBody, DisableVehicleBody, EnableVehicleBody, Model, ModelVehicle, Options, Vehicle, VehicleRealTime, Zone, addServiceForVehicle, createVehicle, disableVehicle, enableVehicle, getModelByIdAssets, getModelVehicles, getModels, getModelsById, getVehicleById, getVehicleByIdAssets, getVehicleRealTimeById, getVehicles, getVehiclesRealTime, pingVehicleById, removeServiceForVehicle };
+//#region src/getOptions.d.ts
+declare const getOptions: (client: Client) => Promise<Options[]>;
+//#endregion
+//#region src/vehicleOption.d.ts
+declare const addOptionForVehicle: (client: Client, vehicleId: string, optionId: number) => Promise<Vehicle>;
+declare const removeOptionForVehicle: (client: Client, vehicleId: string, optionId: number) => Promise<Vehicle>;
+//#endregion
+export { Assets, CreateVehicleBody, DisableVehicleBody, EnableVehicleBody, Model, ModelVehicle, Options, Vehicle, VehicleRealTime, Zone, addOptionForVehicle, addServiceForVehicle, createVehicle, disableVehicle, enableVehicle, getModelByIdAssets, getModelVehicles, getModels, getModelsById, getOptions, getVehicleById, getVehicleByIdAssets, getVehicleRealTimeById, getVehicles, getVehiclesRealTime, pingVehicleById, removeOptionForVehicle, removeServiceForVehicle };

package/dist/index.d.mts

@@ -274,4 +274,11 @@ declare const createVehicle: (client: Client, body: CreateVehicleBody) => Promis
 declare const addServiceForVehicle: (client: Client, serviceId: string, vehicleId: string) => Promise<void>;
 declare const removeServiceForVehicle: (client: Client, serviceId: string, vehicleId: string) => Promise<void>;
 //#endregion
-export { Assets, CreateVehicleBody, DisableVehicleBody, EnableVehicleBody, Model, ModelVehicle, Options, Vehicle, VehicleRealTime, Zone, addServiceForVehicle, createVehicle, disableVehicle, enableVehicle, getModelByIdAssets, getModelVehicles, getModels, getModelsById, getVehicleById, getVehicleByIdAssets, getVehicleRealTimeById, getVehicles, getVehiclesRealTime, pingVehicleById, removeServiceForVehicle };
+//#region src/getOptions.d.ts
+declare const getOptions: (client: Client) => Promise<Options[]>;
+//#endregion
+//#region src/vehicleOption.d.ts
+declare const addOptionForVehicle: (client: Client, vehicleId: string, optionId: number) => Promise<Vehicle>;
+declare const removeOptionForVehicle: (client: Client, vehicleId: string, optionId: number) => Promise<Vehicle>;
+//#endregion
+export { Assets, CreateVehicleBody, DisableVehicleBody, EnableVehicleBody, Model, ModelVehicle, Options, Vehicle, VehicleRealTime, Zone, addOptionForVehicle, addServiceForVehicle, createVehicle, disableVehicle, enableVehicle, getModelByIdAssets, getModelVehicles, getModels, getModelsById, getOptions, getVehicleById, getVehicleByIdAssets, getVehicleRealTimeById, getVehicles, getVehiclesRealTime, pingVehicleById, removeOptionForVehicle, removeServiceForVehicle };

package/dist/index.mjs

@@ -214,18 +214,39 @@ const createVehicle = async (client, body) => {
 };
 //#endregion
 //#region src/vehicleService.ts
-const uuidSchema = z.string().trim().min(1).uuid();
+const uuidSchema$1 = z.string().trim().min(1).uuid();
 const addServiceForVehicle = async (client, serviceId, vehicleId) => {
-	const parsedServiceId = uuidSchema.safeParse(serviceId);
-	const parsedVehicleId = uuidSchema.safeParse(vehicleId);
+	const parsedServiceId = uuidSchema$1.safeParse(serviceId);
+	const parsedVehicleId = uuidSchema$1.safeParse(vehicleId);
 	if (!parsedServiceId.success || !parsedVehicleId.success) throw new TypeError("Invalid args", { cause: [...parsedServiceId.error?.issues ?? [], ...parsedVehicleId.error?.issues ?? []] });
 	await client.put(`/boapi/proxy/user/fleets/${client.clientOptions.fleetId}/services/${parsedServiceId.data}/vehicles/${parsedVehicleId.data}`, {});
 };
 const removeServiceForVehicle = async (client, serviceId, vehicleId) => {
-	const parsedServiceId = uuidSchema.safeParse(serviceId);
-	const parsedVehicleId = uuidSchema.safeParse(vehicleId);
+	const parsedServiceId = uuidSchema$1.safeParse(serviceId);
+	const parsedVehicleId = uuidSchema$1.safeParse(vehicleId);
 	if (!parsedServiceId.success || !parsedVehicleId.success) throw new TypeError("Invalid args", { cause: [...parsedServiceId.error?.issues ?? [], ...parsedVehicleId.error?.issues ?? []] });
 	await client.delete(`/boapi/proxy/user/fleets/${client.clientOptions.fleetId}/services/${parsedServiceId.data}/vehicles/${parsedVehicleId.data}`);
 };
 //#endregion
-export { addServiceForVehicle, createVehicle, disableVehicle, enableVehicle, getModelByIdAssets, getModelVehicles, getModels, getModelsById, getVehicleById, getVehicleByIdAssets, getVehicleRealTimeById, getVehicles, getVehiclesRealTime, pingVehicleById, removeServiceForVehicle };
+//#region src/getOptions.ts
+const getOptions = async (client) => {
+	return client.get(`/boapi/proxy/vehicle/fleets/${client.clientOptions.fleetId}/vehicles/options`).then(({ data }) => data);
+};
+//#endregion
+//#region src/vehicleOption.ts
+const uuidSchema = z.string().trim().min(1).uuid();
+const optionIdSchema = z.number().int().positive();
+const addOptionForVehicle = async (client, vehicleId, optionId) => {
+	const parsedVehicleId = uuidSchema.safeParse(vehicleId);
+	const parsedOptionId = optionIdSchema.safeParse(optionId);
+	if (!parsedVehicleId.success || !parsedOptionId.success) throw new TypeError("Invalid args", { cause: [...parsedVehicleId.error?.issues ?? [], ...parsedOptionId.error?.issues ?? []] });
+	return client.put(`/boapi/proxy/vehicle/fleets/${client.clientOptions.fleetId}/vehicles/${parsedVehicleId.data}/options/${parsedOptionId.data}`, {}).then(({ data }) => data);
+};
+const removeOptionForVehicle = async (client, vehicleId, optionId) => {
+	const parsedVehicleId = uuidSchema.safeParse(vehicleId);
+	const parsedOptionId = optionIdSchema.safeParse(optionId);
+	if (!parsedVehicleId.success || !parsedOptionId.success) throw new TypeError("Invalid args", { cause: [...parsedVehicleId.error?.issues ?? [], ...parsedOptionId.error?.issues ?? []] });
+	return client.delete(`/boapi/proxy/vehicle/fleets/${client.clientOptions.fleetId}/vehicles/${parsedVehicleId.data}/options/${parsedOptionId.data}`).then(({ data }) => data);
+};
+//#endregion
+export { addOptionForVehicle, addServiceForVehicle, createVehicle, disableVehicle, enableVehicle, getModelByIdAssets, getModelVehicles, getModels, getModelsById, getOptions, getVehicleById, getVehicleByIdAssets, getVehicleRealTimeById, getVehicles, getVehiclesRealTime, pingVehicleById, removeOptionForVehicle, removeServiceForVehicle };

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@vulog/aima-vehicle",
     "type": "module",
-    "version": "1.2.32",
+    "version": "1.2.34",
     "main": "dist/index.cjs",
     "module": "dist/index.mjs",
     "types": "dist/index.d.cts",
@@ -32,8 +32,8 @@
     "author": "Vulog",
     "license": "MIT",
     "dependencies": {
-        "@vulog/aima-client": "1.2.32",
-        "@vulog/aima-core": "1.2.32"
+        "@vulog/aima-client": "1.2.34",
+        "@vulog/aima-core": "1.2.34"
     },
     "peerDependencies": {
         "zod": "^3.25.76"

package/src/getOptions.ts

@@ -0,0 +1,9 @@
+import { Client } from '@vulog/aima-client';
+
+import { Options } from './types';
+
+export const getOptions = async (client: Client): Promise<Options[]> => {
+    return client
+        .get<Options[]>(`/boapi/proxy/vehicle/fleets/${client.clientOptions.fleetId}/vehicles/options`)
+        .then(({ data }) => data);
+};

package/src/index.ts

@@ -11,3 +11,5 @@ export * from './disableVehicle';
 export * from './getModelVehicles';
 export * from './createVehicle';
 export * from './vehicleService';
+export * from './getOptions';
+export * from './vehicleOption';

package/src/vehicleOption.ts

@@ -0,0 +1,40 @@
+import { Client } from '@vulog/aima-client';
+import { z } from 'zod';
+
+import { Vehicle } from './types';
+
+const uuidSchema = z.string().trim().min(1).uuid();
+const optionIdSchema = z.number().int().positive();
+
+export const addOptionForVehicle = async (client: Client, vehicleId: string, optionId: number): Promise<Vehicle> => {
+    const parsedVehicleId = uuidSchema.safeParse(vehicleId);
+    const parsedOptionId = optionIdSchema.safeParse(optionId);
+    if (!parsedVehicleId.success || !parsedOptionId.success) {
+        throw new TypeError('Invalid args', {
+            cause: [...(parsedVehicleId.error?.issues ?? []), ...(parsedOptionId.error?.issues ?? [])],
+        });
+    }
+
+    return client
+        .put<Vehicle>(
+            `/boapi/proxy/vehicle/fleets/${client.clientOptions.fleetId}/vehicles/${parsedVehicleId.data}/options/${parsedOptionId.data}`,
+            {}
+        )
+        .then(({ data }) => data);
+};
+
+export const removeOptionForVehicle = async (client: Client, vehicleId: string, optionId: number): Promise<Vehicle> => {
+    const parsedVehicleId = uuidSchema.safeParse(vehicleId);
+    const parsedOptionId = optionIdSchema.safeParse(optionId);
+    if (!parsedVehicleId.success || !parsedOptionId.success) {
+        throw new TypeError('Invalid args', {
+            cause: [...(parsedVehicleId.error?.issues ?? []), ...(parsedOptionId.error?.issues ?? [])],
+        });
+    }
+
+    return client
+        .delete<Vehicle>(
+            `/boapi/proxy/vehicle/fleets/${client.clientOptions.fleetId}/vehicles/${parsedVehicleId.data}/options/${parsedOptionId.data}`
+        )
+        .then(({ data }) => data);
+};