@vulog/aima-unavailability 1.2.7 → 1.2.8

package/dist/index.d.mts

@@ -0,0 +1,46 @@
+import { Client } from '@vulog/aima-client';
+
+type Unavailability = {
+    id: string;
+    cronExpression: string;
+    duration: number;
+    maintenanceTitle: string;
+    vehicleId: string;
+};
+type CreateUnavailabilityBody = {
+    cronExpression: string;
+    duration: number;
+    maintenanceTitle: string;
+    vehicleId: string;
+};
+type UpdateUnavailabilityBody = CreateUnavailabilityBody;
+type UnavailabilityOptions = {
+    from: string;
+    to: string;
+    page?: number;
+};
+
+declare const getUnavailabilitiesByVehicle: (client: Client, vehicleId: string) => Promise<Unavailability[]>;
+
+declare const getUnavailabilities: (client: Client, options: UnavailabilityOptions) => Promise<Unavailability[]>;
+
+declare const createUnavailability: (client: Client, body: CreateUnavailabilityBody) => Promise<Unavailability>;
+
+declare const updateUnavailability: (client: Client, id: string, body: UpdateUnavailabilityBody) => Promise<Unavailability>;
+
+declare const deleteUnavailability: (client: Client, id: string) => Promise<void>;
+
+/**
+ * Generates a Quartz cron expression from a date.
+ * Format: second minute hour day month dayOfWeek year
+ * Example: "0 0 23 14 8 ? 2018"
+ *
+ * @param date - The date to convert to cron expression (Date object or ISO string)
+ * @param timezone - Optional timezone string (e.g., "Europe/Paris", "America/New_York")
+ *                   If provided, the date will be converted to the specified timezone.
+ *                   If not provided, the date will be used as-is.
+ * @returns A cron expression string in Quartz format
+ */
+declare const generateCronExpression: (date: Date | string, timezone?: string) => string;
+
+export { type CreateUnavailabilityBody, type Unavailability, type UnavailabilityOptions, type UpdateUnavailabilityBody, createUnavailability, deleteUnavailability, generateCronExpression, getUnavailabilities, getUnavailabilitiesByVehicle, updateUnavailability };

package/dist/index.d.ts

@@ -0,0 +1,46 @@
+import { Client } from '@vulog/aima-client';
+
+type Unavailability = {
+    id: string;
+    cronExpression: string;
+    duration: number;
+    maintenanceTitle: string;
+    vehicleId: string;
+};
+type CreateUnavailabilityBody = {
+    cronExpression: string;
+    duration: number;
+    maintenanceTitle: string;
+    vehicleId: string;
+};
+type UpdateUnavailabilityBody = CreateUnavailabilityBody;
+type UnavailabilityOptions = {
+    from: string;
+    to: string;
+    page?: number;
+};
+
+declare const getUnavailabilitiesByVehicle: (client: Client, vehicleId: string) => Promise<Unavailability[]>;
+
+declare const getUnavailabilities: (client: Client, options: UnavailabilityOptions) => Promise<Unavailability[]>;
+
+declare const createUnavailability: (client: Client, body: CreateUnavailabilityBody) => Promise<Unavailability>;
+
+declare const updateUnavailability: (client: Client, id: string, body: UpdateUnavailabilityBody) => Promise<Unavailability>;
+
+declare const deleteUnavailability: (client: Client, id: string) => Promise<void>;
+
+/**
+ * Generates a Quartz cron expression from a date.
+ * Format: second minute hour day month dayOfWeek year
+ * Example: "0 0 23 14 8 ? 2018"
+ *
+ * @param date - The date to convert to cron expression (Date object or ISO string)
+ * @param timezone - Optional timezone string (e.g., "Europe/Paris", "America/New_York")
+ *                   If provided, the date will be converted to the specified timezone.
+ *                   If not provided, the date will be used as-is.
+ * @returns A cron expression string in Quartz format
+ */
+declare const generateCronExpression: (date: Date | string, timezone?: string) => string;
+
+export { type CreateUnavailabilityBody, type Unavailability, type UnavailabilityOptions, type UpdateUnavailabilityBody, createUnavailability, deleteUnavailability, generateCronExpression, getUnavailabilities, getUnavailabilitiesByVehicle, updateUnavailability };

package/dist/index.js

@@ -0,0 +1,227 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  createUnavailability: () => createUnavailability,
+  deleteUnavailability: () => deleteUnavailability,
+  generateCronExpression: () => generateCronExpression,
+  getUnavailabilities: () => getUnavailabilities,
+  getUnavailabilitiesByVehicle: () => getUnavailabilitiesByVehicle,
+  updateUnavailability: () => updateUnavailability
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/getUnavailabilitiesByVehicle.ts
+var import_zod = require("zod");
+var schema = import_zod.z.object({
+  vehicleId: import_zod.z.string().trim().min(1).uuid()
+});
+var getUnavailabilitiesByVehicle = async (client, vehicleId) => {
+  const result = schema.safeParse({ vehicleId });
+  if (!result.success) {
+    throw new TypeError("Invalid args", {
+      cause: result.error.issues
+    });
+  }
+  return client.get(
+    `/boapi/proxy/user/fleets/${client.clientOptions.fleetId}/scheduledRules/unavailability/vehicles/${result.data.vehicleId}`
+  ).then(({ data }) => data).catch((error) => {
+    if (error.formattedError?.status === 404) {
+      return [];
+    }
+    throw error;
+  });
+};
+
+// src/getUnavailabilities.ts
+var import_zod2 = require("zod");
+var schema2 = import_zod2.z.object({
+  from: import_zod2.z.string().datetime({ offset: false, precision: 0 }),
+  to: import_zod2.z.string().datetime({ offset: false, precision: 0 }),
+  page: import_zod2.z.number().int().nonnegative().default(0)
+});
+var getUnavailabilities = async (client, options) => {
+  const result = schema2.safeParse({
+    from: options.from,
+    to: options.to,
+    page: options.page ?? 0
+  });
+  if (!result.success) {
+    throw new TypeError("Invalid args", {
+      cause: result.error.issues
+    });
+  }
+  const allUnavailabilities = [];
+  let currentPage = result.data.page;
+  let hasMorePages = true;
+  const MAX_PAGES = 50;
+  while (hasMorePages) {
+    if (currentPage >= MAX_PAGES) {
+      throw new Error(
+        `Maximum page limit (${MAX_PAGES}) reached. This might indicate an issue with the pagination or a very large dataset.`
+      );
+    }
+    const queryParams = new URLSearchParams({
+      from: result.data.from,
+      to: result.data.to,
+      page: currentPage.toString()
+    });
+    const unavailabilities = await client.get(
+      `/boapi/proxy/user/fleets/${client.clientOptions.fleetId}/scheduledRules/unavailability/vehicles?${queryParams.toString()}`
+    ).then(({ data }) => data).catch((error) => {
+      if (error.formattedError?.status === 404) {
+        return [];
+      }
+      throw error;
+    });
+    allUnavailabilities.push(...unavailabilities);
+    hasMorePages = unavailabilities.length > 0;
+    currentPage += 1;
+  }
+  return allUnavailabilities;
+};
+
+// src/createUnavailability.ts
+var import_zod3 = require("zod");
+var schema3 = import_zod3.z.object({
+  cronExpression: import_zod3.z.string().min(1),
+  duration: import_zod3.z.number().int().positive(),
+  maintenanceTitle: import_zod3.z.string().min(1),
+  vehicleId: import_zod3.z.string().uuid()
+});
+var createUnavailability = async (client, body) => {
+  const result = schema3.safeParse(body);
+  if (!result.success) {
+    throw new TypeError("Invalid args", {
+      cause: result.error.issues
+    });
+  }
+  return client.post(
+    `/boapi/proxy/user/fleets/${client.clientOptions.fleetId}/scheduledRules/unavailability`,
+    {
+      cronExpression: result.data.cronExpression,
+      duration: result.data.duration,
+      maintenanceTitle: result.data.maintenanceTitle,
+      vehicleId: result.data.vehicleId
+    }
+  ).then(({ data }) => data);
+};
+
+// src/updateUnavailability.ts
+var import_zod4 = require("zod");
+var schema4 = import_zod4.z.object({
+  id: import_zod4.z.string().trim().min(1).uuid(),
+  cronExpression: import_zod4.z.string().min(1),
+  duration: import_zod4.z.number().int().positive(),
+  maintenanceTitle: import_zod4.z.string().min(1),
+  vehicleId: import_zod4.z.string().uuid()
+});
+var updateUnavailability = async (client, id, body) => {
+  const result = schema4.safeParse({
+    id,
+    ...body
+  });
+  if (!result.success) {
+    throw new TypeError("Invalid args", {
+      cause: result.error.issues
+    });
+  }
+  return client.put(
+    `/boapi/proxy/user/fleets/${client.clientOptions.fleetId}/scheduledRules/unavailability/${result.data.id}`,
+    {
+      cronExpression: result.data.cronExpression,
+      duration: result.data.duration,
+      maintenanceTitle: result.data.maintenanceTitle,
+      vehicleId: result.data.vehicleId
+    }
+  ).then(({ data }) => data);
+};
+
+// src/deleteUnavailability.ts
+var import_zod5 = require("zod");
+var schema5 = import_zod5.z.object({
+  id: import_zod5.z.string().trim().min(1).uuid()
+});
+var deleteUnavailability = async (client, id) => {
+  const result = schema5.safeParse({ id });
+  if (!result.success) {
+    throw new TypeError("Invalid args", {
+      cause: result.error.issues
+    });
+  }
+  return client.delete(
+    `/boapi/proxy/user/fleets/${client.clientOptions.fleetId}/scheduledRules/unavailability/${result.data.id}`
+  ).then(() => void 0).catch((error) => {
+    if (error.formattedError?.status === 404) {
+      return void 0;
+    }
+    throw error;
+  });
+};
+
+// src/generateCronExpression.ts
+var generateCronExpression = (date, timezone) => {
+  let dateObj;
+  if (typeof date === "string") {
+    dateObj = new Date(date);
+  } else {
+    dateObj = new Date(date);
+  }
+  if (Number.isNaN(dateObj.getTime())) {
+    throw new TypeError("Invalid date provided");
+  }
+  if (timezone) {
+    const formatter = new Intl.DateTimeFormat("en-US", {
+      timeZone: timezone,
+      year: "numeric",
+      month: "2-digit",
+      day: "2-digit",
+      hour: "2-digit",
+      minute: "2-digit",
+      second: "2-digit",
+      hour12: false
+    });
+    const parts = formatter.formatToParts(dateObj);
+    const year2 = parseInt(parts.find((p) => p.type === "year")?.value || "0", 10);
+    const month2 = parseInt(parts.find((p) => p.type === "month")?.value || "0", 10);
+    const day2 = parseInt(parts.find((p) => p.type === "day")?.value || "0", 10);
+    const hour2 = parseInt(parts.find((p) => p.type === "hour")?.value || "0", 10);
+    const minute2 = parseInt(parts.find((p) => p.type === "minute")?.value || "0", 10);
+    const second2 = parseInt(parts.find((p) => p.type === "second")?.value || "0", 10);
+    return `${second2} ${minute2} ${hour2} ${day2} ${month2} ? ${year2}`;
+  }
+  const year = dateObj.getFullYear();
+  const month = dateObj.getMonth() + 1;
+  const day = dateObj.getDate();
+  const hour = dateObj.getHours();
+  const minute = dateObj.getMinutes();
+  const second = dateObj.getSeconds();
+  return `${second} ${minute} ${hour} ${day} ${month} ? ${year}`;
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createUnavailability,
+  deleteUnavailability,
+  generateCronExpression,
+  getUnavailabilities,
+  getUnavailabilitiesByVehicle,
+  updateUnavailability
+});

package/dist/index.mjs

@@ -0,0 +1,195 @@
+// src/getUnavailabilitiesByVehicle.ts
+import { z } from "zod";
+var schema = z.object({
+  vehicleId: z.string().trim().min(1).uuid()
+});
+var getUnavailabilitiesByVehicle = async (client, vehicleId) => {
+  const result = schema.safeParse({ vehicleId });
+  if (!result.success) {
+    throw new TypeError("Invalid args", {
+      cause: result.error.issues
+    });
+  }
+  return client.get(
+    `/boapi/proxy/user/fleets/${client.clientOptions.fleetId}/scheduledRules/unavailability/vehicles/${result.data.vehicleId}`
+  ).then(({ data }) => data).catch((error) => {
+    if (error.formattedError?.status === 404) {
+      return [];
+    }
+    throw error;
+  });
+};
+
+// src/getUnavailabilities.ts
+import { z as z2 } from "zod";
+var schema2 = z2.object({
+  from: z2.string().datetime({ offset: false, precision: 0 }),
+  to: z2.string().datetime({ offset: false, precision: 0 }),
+  page: z2.number().int().nonnegative().default(0)
+});
+var getUnavailabilities = async (client, options) => {
+  const result = schema2.safeParse({
+    from: options.from,
+    to: options.to,
+    page: options.page ?? 0
+  });
+  if (!result.success) {
+    throw new TypeError("Invalid args", {
+      cause: result.error.issues
+    });
+  }
+  const allUnavailabilities = [];
+  let currentPage = result.data.page;
+  let hasMorePages = true;
+  const MAX_PAGES = 50;
+  while (hasMorePages) {
+    if (currentPage >= MAX_PAGES) {
+      throw new Error(
+        `Maximum page limit (${MAX_PAGES}) reached. This might indicate an issue with the pagination or a very large dataset.`
+      );
+    }
+    const queryParams = new URLSearchParams({
+      from: result.data.from,
+      to: result.data.to,
+      page: currentPage.toString()
+    });
+    const unavailabilities = await client.get(
+      `/boapi/proxy/user/fleets/${client.clientOptions.fleetId}/scheduledRules/unavailability/vehicles?${queryParams.toString()}`
+    ).then(({ data }) => data).catch((error) => {
+      if (error.formattedError?.status === 404) {
+        return [];
+      }
+      throw error;
+    });
+    allUnavailabilities.push(...unavailabilities);
+    hasMorePages = unavailabilities.length > 0;
+    currentPage += 1;
+  }
+  return allUnavailabilities;
+};
+
+// src/createUnavailability.ts
+import { z as z3 } from "zod";
+var schema3 = z3.object({
+  cronExpression: z3.string().min(1),
+  duration: z3.number().int().positive(),
+  maintenanceTitle: z3.string().min(1),
+  vehicleId: z3.string().uuid()
+});
+var createUnavailability = async (client, body) => {
+  const result = schema3.safeParse(body);
+  if (!result.success) {
+    throw new TypeError("Invalid args", {
+      cause: result.error.issues
+    });
+  }
+  return client.post(
+    `/boapi/proxy/user/fleets/${client.clientOptions.fleetId}/scheduledRules/unavailability`,
+    {
+      cronExpression: result.data.cronExpression,
+      duration: result.data.duration,
+      maintenanceTitle: result.data.maintenanceTitle,
+      vehicleId: result.data.vehicleId
+    }
+  ).then(({ data }) => data);
+};
+
+// src/updateUnavailability.ts
+import { z as z4 } from "zod";
+var schema4 = z4.object({
+  id: z4.string().trim().min(1).uuid(),
+  cronExpression: z4.string().min(1),
+  duration: z4.number().int().positive(),
+  maintenanceTitle: z4.string().min(1),
+  vehicleId: z4.string().uuid()
+});
+var updateUnavailability = async (client, id, body) => {
+  const result = schema4.safeParse({
+    id,
+    ...body
+  });
+  if (!result.success) {
+    throw new TypeError("Invalid args", {
+      cause: result.error.issues
+    });
+  }
+  return client.put(
+    `/boapi/proxy/user/fleets/${client.clientOptions.fleetId}/scheduledRules/unavailability/${result.data.id}`,
+    {
+      cronExpression: result.data.cronExpression,
+      duration: result.data.duration,
+      maintenanceTitle: result.data.maintenanceTitle,
+      vehicleId: result.data.vehicleId
+    }
+  ).then(({ data }) => data);
+};
+
+// src/deleteUnavailability.ts
+import { z as z5 } from "zod";
+var schema5 = z5.object({
+  id: z5.string().trim().min(1).uuid()
+});
+var deleteUnavailability = async (client, id) => {
+  const result = schema5.safeParse({ id });
+  if (!result.success) {
+    throw new TypeError("Invalid args", {
+      cause: result.error.issues
+    });
+  }
+  return client.delete(
+    `/boapi/proxy/user/fleets/${client.clientOptions.fleetId}/scheduledRules/unavailability/${result.data.id}`
+  ).then(() => void 0).catch((error) => {
+    if (error.formattedError?.status === 404) {
+      return void 0;
+    }
+    throw error;
+  });
+};
+
+// src/generateCronExpression.ts
+var generateCronExpression = (date, timezone) => {
+  let dateObj;
+  if (typeof date === "string") {
+    dateObj = new Date(date);
+  } else {
+    dateObj = new Date(date);
+  }
+  if (Number.isNaN(dateObj.getTime())) {
+    throw new TypeError("Invalid date provided");
+  }
+  if (timezone) {
+    const formatter = new Intl.DateTimeFormat("en-US", {
+      timeZone: timezone,
+      year: "numeric",
+      month: "2-digit",
+      day: "2-digit",
+      hour: "2-digit",
+      minute: "2-digit",
+      second: "2-digit",
+      hour12: false
+    });
+    const parts = formatter.formatToParts(dateObj);
+    const year2 = parseInt(parts.find((p) => p.type === "year")?.value || "0", 10);
+    const month2 = parseInt(parts.find((p) => p.type === "month")?.value || "0", 10);
+    const day2 = parseInt(parts.find((p) => p.type === "day")?.value || "0", 10);
+    const hour2 = parseInt(parts.find((p) => p.type === "hour")?.value || "0", 10);
+    const minute2 = parseInt(parts.find((p) => p.type === "minute")?.value || "0", 10);
+    const second2 = parseInt(parts.find((p) => p.type === "second")?.value || "0", 10);
+    return `${second2} ${minute2} ${hour2} ${day2} ${month2} ? ${year2}`;
+  }
+  const year = dateObj.getFullYear();
+  const month = dateObj.getMonth() + 1;
+  const day = dateObj.getDate();
+  const hour = dateObj.getHours();
+  const minute = dateObj.getMinutes();
+  const second = dateObj.getSeconds();
+  return `${second} ${minute} ${hour} ${day} ${month} ? ${year}`;
+};
+export {
+  createUnavailability,
+  deleteUnavailability,
+  generateCronExpression,
+  getUnavailabilities,
+  getUnavailabilitiesByVehicle,
+  updateUnavailability
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@vulog/aima-unavailability",
-    "version": "1.2.7",
+    "version": "1.2.8",
     "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.2.7",
-        "@vulog/aima-core": "1.2.7"
+        "@vulog/aima-client": "1.2.8",
+        "@vulog/aima-core": "1.2.8"
     },
     "peerDependencies": {
         "zod": "^3.25.76"

package/API_SUMMARY.md

@@ -1,36 +0,0 @@
-# Vulog Unavailability API Calls - Summary
-
-## Implemented API Endpoints
-
-### 1. GET `/boapi/proxy/user/fleets/{fleetId}/scheduledRules/unavailability/vehicles/{vehicleId}`
-Lists all unavailability rules for a specific vehicle. Returns array of `Unavailability` objects. Returns empty array on 404.
-
-### 2. GET `/boapi/proxy/user/fleets/{fleetId}/scheduledRules/unavailability/vehicles`
-Lists unavailability rules with date range filtering and pagination. Query parameters: `from` (ISO date), `to` (ISO date), `page` (number). Automatically iterates through pages until no more results.
-
-### 3. POST `/boapi/proxy/user/fleets/{fleetId}/scheduledRules/unavailability`
-Creates a new unavailability rule. Request body: `{ cronExpression, duration, maintenanceTitle, vehicleId }`. Returns created `Unavailability` object.
-
-### 4. PUT `/boapi/proxy/user/fleets/{fleetId}/scheduledRules/unavailability/{id}`
-Updates an existing unavailability rule. Request body same as POST. Returns updated `Unavailability` object.
-
-### 5. DELETE `/boapi/proxy/user/fleets/{fleetId}/scheduledRules/unavailability/{id}`
-Deletes an unavailability rule by ID. Idempotent - returns successfully if already deleted (404).
-
-## Utility Function
-
-### `generateCronExpression(date: Date | string, timezone?: string): string`
-Generates Quartz cron expression from a date. Supports timezone conversion. Format: `second minute hour day month ? year`.
-
-## Type Definitions
-
-```typescript
-type Unavailability = {
-    id: string;
-    cronExpression: string;
-    duration: number;
-    maintenanceTitle: string;
-    vehicleId: string;
-};
-```
-