@vulog/aima-vehicle 1.1.47 → 1.1.49

package/dist/index.d.mts

@@ -20,9 +20,119 @@ type Model = {
     redistributeVehicleChargedEnoughRange: string;
     [key: string]: any;
 };
+type Zone = {
+    type: string;
+    version: number;
+    zoneId: string;
+    sticky: boolean;
+    labels: {
+        labelId: string;
+        name: string;
+        publicName: string;
+    }[];
+};
+type VehicleRealTime = {
+    id: string;
+    name: string;
+    plate: string;
+    vin: string;
+    fleetid: string;
+    boxid: string;
+    vehicle_status: number;
+    zones: Zone[];
+    releasable: boolean;
+    box_status: number;
+    autonomy: number;
+    autonomy2: number;
+    isCharging: boolean;
+    battery: number;
+    km: number;
+    speed: number;
+    location: {
+        geohash: string;
+        cap: number;
+        latitude: number;
+        longitude: number;
+        gpsDate: string;
+        lastMovingDate: string;
+    };
+    endTripLocation: {
+        latitude: number;
+        longitude: number;
+    };
+    endZoneIds: [];
+    productIds: [];
+    isDoorClosed: boolean;
+    isDoorLocked: boolean;
+    engineOn: boolean;
+    immobilizerOn: boolean;
+    secureOn: boolean;
+    spareLockOn: boolean | null;
+    pileLockOn: boolean | null;
+    helmetPresent: boolean | null;
+    helmet2Present: boolean | null;
+    helmetBoxLockOn: boolean | null;
+    helmet2LockOn: boolean | null;
+    userId: string | null;
+    user_locale: string | null;
+    rfid: string | null;
+    orderId: string | null;
+    gatewayUrl: string | null;
+    booking_status: number;
+    booking_date: string | null;
+    expiresOn: boolean | null;
+    last_active_date: string;
+    last_wakeUp_date: string;
+    version: string;
+    pricingId: string | null;
+    start_date: string | null;
+    theorStartDate: string | null;
+    theorEndDate: string | null;
+    startZones: Zone[];
+    endZones: Zone[];
+    disabled: boolean;
+    outOfServiceReason: string;
+    ignitionOffGeohash: string | null;
+    geohashNeighbours: string[];
+    cleanlinessStatus: boolean;
+    needsRedistribution: boolean;
+    batteryUnderThreshold: boolean;
+    isBeingTowed: boolean;
+    automaticallyEnableVehicleAfterRangeRecovery: boolean;
+    key: {
+        deviceName: string;
+    };
+    doNotTrack: boolean;
+    energyLevel: number;
+    lastOosDate: string;
+    hasAlerts: boolean;
+    firmwareModel: string;
+    comeFromApp: string;
+    doors: {
+        frontLeftClosed: boolean;
+        frontRightClosed: boolean;
+        rearLeftClosed: boolean;
+        rearRightClosed: boolean;
+        trunkClosed: boolean;
+        hoodClosed: boolean;
+    };
+    windows: {
+        frontLeftClosed: boolean;
+        frontRightClosed: boolean;
+        rearLeftClosed: boolean;
+        rearRightClosed: boolean;
+        trunkClosed: boolean;
+    };
+    doorsAndWindowsClosed: boolean;
+    vpChecksum: string;
+    firmwareBuildDate: string;
+    [key: string]: any;
+};
 
 declare const getModelsById: (client: Client, id: number) => Promise<Model>;
 
 declare const getModels: (client: Client) => Promise<Model[]>;
 
-export { type Model, getModels, getModelsById };
+declare const getVehicleRealTimeById: (client: Client, id: string) => Promise<VehicleRealTime | null>;
+
+export { type Model, getModels, getModelsById, getVehicleRealTimeById };

package/dist/index.d.ts

@@ -20,9 +20,119 @@ type Model = {
     redistributeVehicleChargedEnoughRange: string;
     [key: string]: any;
 };
+type Zone = {
+    type: string;
+    version: number;
+    zoneId: string;
+    sticky: boolean;
+    labels: {
+        labelId: string;
+        name: string;
+        publicName: string;
+    }[];
+};
+type VehicleRealTime = {
+    id: string;
+    name: string;
+    plate: string;
+    vin: string;
+    fleetid: string;
+    boxid: string;
+    vehicle_status: number;
+    zones: Zone[];
+    releasable: boolean;
+    box_status: number;
+    autonomy: number;
+    autonomy2: number;
+    isCharging: boolean;
+    battery: number;
+    km: number;
+    speed: number;
+    location: {
+        geohash: string;
+        cap: number;
+        latitude: number;
+        longitude: number;
+        gpsDate: string;
+        lastMovingDate: string;
+    };
+    endTripLocation: {
+        latitude: number;
+        longitude: number;
+    };
+    endZoneIds: [];
+    productIds: [];
+    isDoorClosed: boolean;
+    isDoorLocked: boolean;
+    engineOn: boolean;
+    immobilizerOn: boolean;
+    secureOn: boolean;
+    spareLockOn: boolean | null;
+    pileLockOn: boolean | null;
+    helmetPresent: boolean | null;
+    helmet2Present: boolean | null;
+    helmetBoxLockOn: boolean | null;
+    helmet2LockOn: boolean | null;
+    userId: string | null;
+    user_locale: string | null;
+    rfid: string | null;
+    orderId: string | null;
+    gatewayUrl: string | null;
+    booking_status: number;
+    booking_date: string | null;
+    expiresOn: boolean | null;
+    last_active_date: string;
+    last_wakeUp_date: string;
+    version: string;
+    pricingId: string | null;
+    start_date: string | null;
+    theorStartDate: string | null;
+    theorEndDate: string | null;
+    startZones: Zone[];
+    endZones: Zone[];
+    disabled: boolean;
+    outOfServiceReason: string;
+    ignitionOffGeohash: string | null;
+    geohashNeighbours: string[];
+    cleanlinessStatus: boolean;
+    needsRedistribution: boolean;
+    batteryUnderThreshold: boolean;
+    isBeingTowed: boolean;
+    automaticallyEnableVehicleAfterRangeRecovery: boolean;
+    key: {
+        deviceName: string;
+    };
+    doNotTrack: boolean;
+    energyLevel: number;
+    lastOosDate: string;
+    hasAlerts: boolean;
+    firmwareModel: string;
+    comeFromApp: string;
+    doors: {
+        frontLeftClosed: boolean;
+        frontRightClosed: boolean;
+        rearLeftClosed: boolean;
+        rearRightClosed: boolean;
+        trunkClosed: boolean;
+        hoodClosed: boolean;
+    };
+    windows: {
+        frontLeftClosed: boolean;
+        frontRightClosed: boolean;
+        rearLeftClosed: boolean;
+        rearRightClosed: boolean;
+        trunkClosed: boolean;
+    };
+    doorsAndWindowsClosed: boolean;
+    vpChecksum: string;
+    firmwareBuildDate: string;
+    [key: string]: any;
+};
 
 declare const getModelsById: (client: Client, id: number) => Promise<Model>;
 
 declare const getModels: (client: Client) => Promise<Model[]>;
 
-export { type Model, getModels, getModelsById };
+declare const getVehicleRealTimeById: (client: Client, id: string) => Promise<VehicleRealTime | null>;
+
+export { type Model, getModels, getModelsById, getVehicleRealTimeById };

package/dist/index.js

@@ -21,7 +21,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_exports = {};
 __export(index_exports, {
   getModels: () => getModels,
-  getModelsById: () => getModelsById
+  getModelsById: () => getModelsById,
+  getVehicleRealTimeById: () => getVehicleRealTimeById
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -34,8 +35,31 @@ var getModelsById = async (client, id) => {
 var getModels = async (client) => {
   return client.get(`boapi/proxy/user/vehicle/fleets/${client.clientOptions.fleetId}/vehicles/models`).then(({ data }) => data);
 };
+
+// src/getVehicle.ts
+var import_zod = require("zod");
+var schema = import_zod.z.object({
+  id: import_zod.z.string().trim().min(1).uuid()
+});
+var getVehicleRealTimeById = async (client, id) => {
+  const result = schema.safeParse({ id });
+  if (!result.success) {
+    throw new TypeError("Invalid args", {
+      cause: result.error.issues
+    });
+  }
+  return client.get(
+    `boapi/proxy/fleetmanager/public/fleets/${client.clientOptions.fleetId}/vehicles/${result.data.id}`
+  ).then(({ data }) => data).catch((error) => {
+    if (error.formattedError?.status === 404) {
+      return null;
+    }
+    throw error;
+  });
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   getModels,
-  getModelsById
+  getModelsById,
+  getVehicleRealTimeById
 });

package/dist/index.mjs

@@ -7,7 +7,30 @@ var getModelsById = async (client, id) => {
 var getModels = async (client) => {
   return client.get(`boapi/proxy/user/vehicle/fleets/${client.clientOptions.fleetId}/vehicles/models`).then(({ data }) => data);
 };
+
+// src/getVehicle.ts
+import { z } from "zod";
+var schema = z.object({
+  id: z.string().trim().min(1).uuid()
+});
+var getVehicleRealTimeById = async (client, id) => {
+  const result = schema.safeParse({ id });
+  if (!result.success) {
+    throw new TypeError("Invalid args", {
+      cause: result.error.issues
+    });
+  }
+  return client.get(
+    `boapi/proxy/fleetmanager/public/fleets/${client.clientOptions.fleetId}/vehicles/${result.data.id}`
+  ).then(({ data }) => data).catch((error) => {
+    if (error.formattedError?.status === 404) {
+      return null;
+    }
+    throw error;
+  });
+};
 export {
   getModels,
-  getModelsById
+  getModelsById,
+  getVehicleRealTimeById
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@vulog/aima-vehicle",
-    "version": "1.1.47",
+    "version": "1.1.49",
     "main": "dist/index.js",
     "module": "dist/index.mjs",
     "types": "dist/index.d.ts",
@@ -19,8 +19,8 @@
     "author": "Vulog",
     "license": "ISC",
     "dependencies": {
-        "@vulog/aima-client": "1.1.47",
-        "@vulog/aima-core": "1.1.47"
+        "@vulog/aima-client": "1.1.49",
+        "@vulog/aima-core": "1.1.49"
     },
     "peerDependencies": {
         "zod": "^3.24.2"

package/src/getVehicle.ts

@@ -0,0 +1,28 @@
+import { Client } from '@vulog/aima-client';
+import { z } from 'zod';
+
+import { VehicleRealTime } from './types';
+
+const schema = z.object({
+    id: z.string().trim().min(1).uuid(),
+});
+
+export const getVehicleRealTimeById = async (client: Client, id: string) => {
+    const result = schema.safeParse({ id });
+    if (!result.success) {
+        throw new TypeError('Invalid args', {
+            cause: result.error.issues,
+        });
+    }
+    return client
+        .get<VehicleRealTime>(
+            `boapi/proxy/fleetmanager/public/fleets/${client.clientOptions.fleetId}/vehicles/${result.data.id}`
+        )
+        .then(({ data }) => data)
+        .catch((error) => {
+            if (error.formattedError?.status === 404) {
+                return null;
+            }
+            throw error;
+        });
+};

package/src/index.ts

@@ -1,3 +1,4 @@
-export { getModelsById } from './getModel';
-export { getModels } from './getModels';
+export * from './getModel';
+export * from './getModels';
+export * from './getVehicle';
 export type { Model } from './types';

package/src/types.ts

@@ -18,3 +18,113 @@ export type Model = {
     redistributeVehicleChargedEnoughRange: string;
     [key: string]: any;
 };
+
+export type Zone = {
+    type: string;
+    version: number;
+    zoneId: string;
+    sticky: boolean;
+    labels: {
+        labelId: string;
+        name: string;
+        publicName: string;
+    }[];
+};
+
+export type VehicleRealTime = {
+    id: string;
+    name: string;
+    plate: string;
+    vin: string;
+    fleetid: string;
+    boxid: string;
+    vehicle_status: number;
+    zones: Zone[];
+    releasable: boolean;
+    box_status: number;
+    autonomy: number;
+    autonomy2: number;
+    isCharging: boolean;
+    battery: number;
+    km: number;
+    speed: number;
+    location: {
+        geohash: string;
+        cap: number;
+        latitude: number;
+        longitude: number;
+        gpsDate: string;
+        lastMovingDate: string;
+    };
+    endTripLocation: {
+        latitude: number;
+        longitude: number;
+    };
+    endZoneIds: [];
+    productIds: [];
+    isDoorClosed: boolean;
+    isDoorLocked: boolean;
+    engineOn: boolean;
+    immobilizerOn: boolean;
+    secureOn: boolean;
+    spareLockOn: boolean | null;
+    pileLockOn: boolean | null;
+    helmetPresent: boolean | null;
+    helmet2Present: boolean | null;
+    helmetBoxLockOn: boolean | null;
+    helmet2LockOn: boolean | null;
+    userId: string | null;
+    user_locale: string | null;
+    rfid: string | null;
+    orderId: string | null;
+    gatewayUrl: string | null;
+    booking_status: number;
+    booking_date: string | null;
+    expiresOn: boolean | null;
+    last_active_date: string;
+    last_wakeUp_date: string;
+    version: string;
+    pricingId: string | null;
+    start_date: string | null;
+    theorStartDate: string | null;
+    theorEndDate: string | null;
+    startZones: Zone[];
+    endZones: Zone[];
+    disabled: boolean;
+    outOfServiceReason: string;
+    ignitionOffGeohash: string | null;
+    geohashNeighbours: string[];
+    cleanlinessStatus: boolean;
+    needsRedistribution: boolean;
+    batteryUnderThreshold: boolean;
+    isBeingTowed: boolean;
+    automaticallyEnableVehicleAfterRangeRecovery: boolean;
+    key: {
+        deviceName: string;
+    };
+    doNotTrack: boolean;
+    energyLevel: number;
+    lastOosDate: string;
+    hasAlerts: boolean;
+    firmwareModel: string;
+    comeFromApp: string;
+    doors: {
+        frontLeftClosed: boolean;
+        frontRightClosed: boolean;
+        rearLeftClosed: boolean;
+        rearRightClosed: boolean;
+        trunkClosed: boolean;
+        hoodClosed: boolean;
+    };
+    windows: {
+        frontLeftClosed: boolean;
+        frontRightClosed: boolean;
+        rearLeftClosed: boolean;
+        rearRightClosed: boolean;
+        trunkClosed: boolean;
+    };
+    doorsAndWindowsClosed: boolean;
+    vpChecksum: string;
+    firmwareBuildDate: string;
+    [key: string]: any;
+};