@vulog/aima-vehicle 1.1.56 → 1.1.58

package/dist/index.d.mts

@@ -249,4 +249,11 @@ declare const getVehicles: (client: Client, pageSize?: number) => Promise<Vehicl
  */
 declare const getVehiclesRealTime: (client: Client, pageSize?: number, lastUpdatedMillis?: number) => Promise<VehicleRealTime[]>;
 
-export { type Assets, type Model, type Options, type Vehicle, type VehicleRealTime, type Zone, getModelByIdAssets, getModels, getModelsById, getVehicleById, getVehicleByIdAssets, getVehicleRealTimeById, getVehicles, getVehiclesRealTime };
+/**
+ * Pings a vehicle to check if it is alive (box connected).
+ * Returns true if alive (HTTP 200), false if box not connected (code 410, codeStr 'carConnectionProblem'),
+ * throws for other errors or invalid id.
+ */
+declare const pingVehicleById: (client: Client, id: string) => Promise<boolean>;
+
+export { type Assets, type Model, type Options, type Vehicle, type VehicleRealTime, type Zone, getModelByIdAssets, getModels, getModelsById, getVehicleById, getVehicleByIdAssets, getVehicleRealTimeById, getVehicles, getVehiclesRealTime, pingVehicleById };

package/dist/index.d.ts

@@ -249,4 +249,11 @@ declare const getVehicles: (client: Client, pageSize?: number) => Promise<Vehicl
  */
 declare const getVehiclesRealTime: (client: Client, pageSize?: number, lastUpdatedMillis?: number) => Promise<VehicleRealTime[]>;
 
-export { type Assets, type Model, type Options, type Vehicle, type VehicleRealTime, type Zone, getModelByIdAssets, getModels, getModelsById, getVehicleById, getVehicleByIdAssets, getVehicleRealTimeById, getVehicles, getVehiclesRealTime };
+/**
+ * Pings a vehicle to check if it is alive (box connected).
+ * Returns true if alive (HTTP 200), false if box not connected (code 410, codeStr 'carConnectionProblem'),
+ * throws for other errors or invalid id.
+ */
+declare const pingVehicleById: (client: Client, id: string) => Promise<boolean>;
+
+export { type Assets, type Model, type Options, type Vehicle, type VehicleRealTime, type Zone, getModelByIdAssets, getModels, getModelsById, getVehicleById, getVehicleByIdAssets, getVehicleRealTimeById, getVehicles, getVehiclesRealTime, pingVehicleById };

package/dist/index.js

@@ -27,7 +27,8 @@ __export(index_exports, {
   getVehicleByIdAssets: () => getVehicleByIdAssets,
   getVehicleRealTimeById: () => getVehicleRealTimeById,
   getVehicles: () => getVehicles,
-  getVehiclesRealTime: () => getVehiclesRealTime
+  getVehiclesRealTime: () => getVehiclesRealTime,
+  pingVehicleById: () => pingVehicleById
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -116,10 +117,10 @@ var getVehiclesPage = async (client, page, pageSize) => {
   return response.data;
 };
 var getVehicles = async (client, pageSize = 500) => {
-  const schema4 = import_zod4.z.object({
+  const schema5 = import_zod4.z.object({
     pageSize: import_zod4.z.number().min(1).default(500)
   });
-  const result = schema4.safeParse({ pageSize });
+  const result = schema5.safeParse({ pageSize });
   if (!result.success) {
     throw new TypeError("Invalid args", {
       cause: result.error.issues
@@ -156,11 +157,11 @@ var getVehiclesRealTimePage = async (client, page, pageSize, lastUpdatedMillis)
   return response.data;
 };
 var getVehiclesRealTime = async (client, pageSize = 500, lastUpdatedMillis) => {
-  const schema4 = import_zod4.z.object({
+  const schema5 = import_zod4.z.object({
     pageSize: import_zod4.z.number().min(1).default(500),
     lastUpdatedMillis: import_zod4.z.number().positive().optional()
   });
-  const result = schema4.safeParse({ pageSize, lastUpdatedMillis });
+  const result = schema5.safeParse({ pageSize, lastUpdatedMillis });
   if (!result.success) {
     throw new TypeError("Invalid args", {
       cause: result.error.issues
@@ -194,6 +195,31 @@ var getVehiclesRealTime = async (client, pageSize = 500, lastUpdatedMillis) => {
   }
   return allVehicles;
 };
+
+// src/pingVehicle.ts
+var import_zod5 = require("zod");
+var schema4 = import_zod5.z.object({
+  id: import_zod5.z.string().trim().min(1).uuid()
+});
+var pingVehicleById = async (client, id) => {
+  const result = schema4.safeParse({ id });
+  if (!result.success) {
+    throw new TypeError("Invalid args", {
+      cause: result.error.issues
+    });
+  }
+  try {
+    await client.post(
+      `boapi/proxy/fleetmanager/public/v2/fleets/${client.clientOptions.fleetId}/vehicles/${result.data.id}/ping`
+    );
+    return true;
+  } catch (error) {
+    if (error?.response?.data?.codeStr === "carConnectionProblem" && error?.response?.data?.code === 410) {
+      return false;
+    }
+    throw error;
+  }
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   getModelByIdAssets,
@@ -203,5 +229,6 @@ var getVehiclesRealTime = async (client, pageSize = 500, lastUpdatedMillis) => {
   getVehicleByIdAssets,
   getVehicleRealTimeById,
   getVehicles,
-  getVehiclesRealTime
+  getVehiclesRealTime,
+  pingVehicleById
 });

package/dist/index.mjs

@@ -83,10 +83,10 @@ var getVehiclesPage = async (client, page, pageSize) => {
   return response.data;
 };
 var getVehicles = async (client, pageSize = 500) => {
-  const schema4 = z4.object({
+  const schema5 = z4.object({
     pageSize: z4.number().min(1).default(500)
   });
-  const result = schema4.safeParse({ pageSize });
+  const result = schema5.safeParse({ pageSize });
   if (!result.success) {
     throw new TypeError("Invalid args", {
       cause: result.error.issues
@@ -123,11 +123,11 @@ var getVehiclesRealTimePage = async (client, page, pageSize, lastUpdatedMillis)
   return response.data;
 };
 var getVehiclesRealTime = async (client, pageSize = 500, lastUpdatedMillis) => {
-  const schema4 = z4.object({
+  const schema5 = z4.object({
     pageSize: z4.number().min(1).default(500),
     lastUpdatedMillis: z4.number().positive().optional()
   });
-  const result = schema4.safeParse({ pageSize, lastUpdatedMillis });
+  const result = schema5.safeParse({ pageSize, lastUpdatedMillis });
   if (!result.success) {
     throw new TypeError("Invalid args", {
       cause: result.error.issues
@@ -161,6 +161,31 @@ var getVehiclesRealTime = async (client, pageSize = 500, lastUpdatedMillis) => {
   }
   return allVehicles;
 };
+
+// src/pingVehicle.ts
+import { z as z5 } from "zod";
+var schema4 = z5.object({
+  id: z5.string().trim().min(1).uuid()
+});
+var pingVehicleById = async (client, id) => {
+  const result = schema4.safeParse({ id });
+  if (!result.success) {
+    throw new TypeError("Invalid args", {
+      cause: result.error.issues
+    });
+  }
+  try {
+    await client.post(
+      `boapi/proxy/fleetmanager/public/v2/fleets/${client.clientOptions.fleetId}/vehicles/${result.data.id}/ping`
+    );
+    return true;
+  } catch (error) {
+    if (error?.response?.data?.codeStr === "carConnectionProblem" && error?.response?.data?.code === 410) {
+      return false;
+    }
+    throw error;
+  }
+};
 export {
   getModelByIdAssets,
   getModels,
@@ -169,5 +194,6 @@ export {
   getVehicleByIdAssets,
   getVehicleRealTimeById,
   getVehicles,
-  getVehiclesRealTime
+  getVehiclesRealTime,
+  pingVehicleById
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@vulog/aima-vehicle",
-    "version": "1.1.56",
+    "version": "1.1.58",
     "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.56",
-        "@vulog/aima-core": "1.1.56"
+        "@vulog/aima-client": "1.1.58",
+        "@vulog/aima-core": "1.1.58"
     },
     "peerDependencies": {
         "zod": "^3.24.2"

package/src/index.ts

@@ -5,3 +5,4 @@ export * from './getVehicle';
 export * from './getVehicleAssets';
 export * from './getVehicles';
 export * from './types';
+export * from './pingVehicle';

package/src/pingVehicle.ts

@@ -0,0 +1,31 @@
+import { Client } from '@vulog/aima-client';
+import { z } from 'zod';
+
+const schema = z.object({
+    id: z.string().trim().min(1).uuid(),
+});
+
+/**
+ * Pings a vehicle to check if it is alive (box connected).
+ * Returns true if alive (HTTP 200), false if box not connected (code 410, codeStr 'carConnectionProblem'),
+ * throws for other errors or invalid id.
+ */
+export const pingVehicleById = async (client: Client, id: string): Promise<boolean> => {
+    const result = schema.safeParse({ id });
+    if (!result.success) {
+        throw new TypeError('Invalid args', {
+            cause: result.error.issues,
+        });
+    }
+    try {
+        await client.post(
+            `boapi/proxy/fleetmanager/public/v2/fleets/${client.clientOptions.fleetId}/vehicles/${result.data.id}/ping`
+        );
+        return true;
+    } catch (error: any) {
+        if (error?.response?.data?.codeStr === 'carConnectionProblem' && error?.response?.data?.code === 410) {
+            return false;
+        }
+        throw error;
+    }
+};

package/src/wakeUpVehicle.ts

@@ -0,0 +1,29 @@
+import { Client } from '@vulog/aima-client';
+import { z } from 'zod';
+
+const schema = z.object({
+    id: z.string().trim().min(1).uuid(),
+});
+
+/**
+ * Wakes up a vehicle by sending a wakeup command.
+ * Returns 'sent' if the wakeup was sent (HTTP 200),
+ * 'discarded' if a wakeup was already in progress (HTTP 202),
+ * throws for other errors or invalid id.
+ */
+export const wakeUpVehicleById = async (client: Client, id: string): Promise<'sent' | 'discarded'> => {
+    const result = schema.safeParse({ id });
+    if (!result.success) {
+        throw new TypeError('Invalid args', {
+            cause: result.error.issues,
+        });
+    }
+    const response = await client.post(
+        `boapi/proxy/fleetmanager/public/v2/fleets/${client.clientOptions.fleetId}/vehicles/${result.data.id}/wakeup`,
+        undefined,
+        { validateStatus: () => true }
+    );
+    if (response.status === 200) return 'sent';
+    if (response.status === 202) return 'discarded';
+    throw new Error(`Unexpected status code: ${response.status}`);
+};