vms-nest-api-document 1.0.0

package/dist/services/fleet/inspection_management/fleet_inspection_management_service.js

@@ -0,0 +1,504 @@
+// src/core/sdk-config.ts
+var KEY = "__vms_axios_instance__";
+var getAxiosInstance = () => {
+  const instance = globalThis[KEY];
+  if (!instance) {
+    throw new Error("\u274C Axios instance not configured. Call setAxiosInstance() first.");
+  }
+  return instance;
+};
+
+// src/core/apiCall.ts
+var apiPost = async (url, data) => {
+  const response = await getAxiosInstance().post(url, data);
+  return response.data;
+};
+var apiPatch = async (url, data) => {
+  const response = await getAxiosInstance().patch(url, data);
+  return response.data;
+};
+var apiDelete = async (url) => {
+  const response = await getAxiosInstance().delete(url);
+  return response.data;
+};
+
+// src/services/fleet/inspection_management/fleet_inspection_management_service.ts
+import { z as z3 } from "zod";
+
+// src/zod_utils/zod_utils.ts
+import { z } from "zod";
+
+// src/core/BaseResponse.ts
+var r_log = (data = {}) => {
+  return data;
+};
+
+// src/zod_utils/zod_utils.ts
+var handleNullOrUndefined = (value) => typeof value === "string" ? value : "";
+var stringMandatory = (fieldName, min = 1, max = 100) => {
+  const schema = z.string().trim().min(min, `${fieldName} must be at least ${min} characters.`).max(max, `${fieldName} must be at most ${max} characters.`).nonempty(`${fieldName} is required.`).transform(handleNullOrUndefined);
+  return schema;
+};
+var stringOptional = (fieldName, min = 0, max = 255, defaultValue = "") => {
+  const schema = z.string().trim().min(min, `${fieldName} must be at least ${min} characters.`).max(max, `${fieldName} must be at most ${max} characters.`).transform(handleNullOrUndefined).default(defaultValue);
+  return schema;
+};
+var stringArrayOptional = (fieldName, min = 0, max = 100, defaultValue = [], unique = false) => {
+  const schema = z.array(z.string().trim(), {
+    invalid_type_error: `${fieldName} must be an array of strings.`
+  }).min(min, `${fieldName} must contain at least ${min} items.`).max(max, `${fieldName} must contain at most ${max} items.`);
+  if (unique) {
+    schema.refine(
+      (arr) => new Set(arr).size === arr.length,
+      `${fieldName} must contain unique values.`
+    );
+  }
+  return schema.optional().default(defaultValue);
+};
+var numberOptional = (fieldName, min = 0, max = 1e14, defaultValue = 0) => {
+  return z.preprocess(
+    (val) => typeof val === "string" && val.trim() !== "" ? Number(val) : val,
+    z.number({ invalid_type_error: `${fieldName} must be a number.` }).min(min, `${fieldName} must be at least ${min}.`).max(max, `${fieldName} must be at most ${max}.`).optional().default(defaultValue)
+  );
+};
+var doubleOptionalLatLng = (fieldName, defaultValue = 0) => {
+  return z.preprocess(
+    (val) => {
+      if (typeof val === "string") {
+        val = parseFloat(val);
+      }
+      if (typeof val === "number") {
+        return parseFloat(val.toFixed(6));
+      }
+      return val;
+    },
+    z.number({ invalid_type_error: `${fieldName} must be a number.` }).min(-180, `${fieldName} must be at least -180.`).max(180, `${fieldName} must be at most 180.`).default(defaultValue)
+  ).optional();
+};
+var enumMandatory = (fieldName, enumType, defaultValue) => {
+  return z.union([
+    z.nativeEnum(enumType, {
+      invalid_type_error: `${fieldName} should be one of the following values: ${Object.values(
+        enumType
+      ).join(", ")}.`
+    }),
+    z.string().refine((val) => Object.values(enumType).includes(val), {
+      message: `${fieldName} should be one of the following values: ${Object.values(
+        enumType
+      ).join(", ")}.`
+    })
+  ]).default(defaultValue).refine((val) => val !== "", {
+    message: `Please select ${fieldName}.`
+  });
+};
+var enumOptional = (fieldName, enumType, defaultValue) => {
+  return z.nativeEnum(enumType, {
+    invalid_type_error: `${fieldName} must be an array containing only the following values: ${Object.values(
+      enumType
+    ).join(", ")}.`
+  }).optional().default(() => defaultValue);
+};
+var getAllEnums = (enumType) => {
+  return Object.values(enumType);
+};
+var enumArrayOptional = (fieldName, enumType, defaultValue = getAllEnums(enumType), min = 0, max = 100, unique = false) => {
+  const schema = z.array(z.nativeEnum(enumType), {
+    invalid_type_error: `${fieldName} must be an array containing only the following values: ${Object.values(
+      enumType
+    ).join(", ")}.`
+  }).min(min, `${fieldName} must contain at least ${min} items.`).max(max, `${fieldName} must contain at most ${max} items.`);
+  if (unique) {
+    schema.refine(
+      (arr) => new Set(arr).size === arr.length,
+      `${fieldName} must contain unique values.`
+    );
+  }
+  return schema.optional().default(() => defaultValue);
+};
+var handleNullOrUndefinedDate = (value, defaultValue) => {
+  if (typeof value === "string" && !isNaN(Date.parse(value))) {
+    return value;
+  }
+  return defaultValue;
+};
+var dateMandatory = (fieldName, minDate, maxDate, defaultValue = (/* @__PURE__ */ new Date()).toISOString()) => {
+  const schema = z.string().refine((val) => val !== "" && val !== null && val !== void 0, {
+    message: `Please select ${fieldName}.`
+  }).refine((val) => !isNaN(Date.parse(val)), {
+    message: `${fieldName} must be a valid ISO date.`
+  }).refine((val) => !minDate || new Date(val) >= new Date(minDate), {
+    message: `${fieldName} must be after ${minDate}.`
+  }).refine((val) => !maxDate || new Date(val) <= new Date(maxDate), {
+    message: `${fieldName} must be before ${maxDate}.`
+  }).transform((val) => handleNullOrUndefinedDate(val, defaultValue));
+  return schema;
+};
+var dynamicJsonSchema = (fieldName, defaultValue = {}) => z.record(z.any()).optional().default(() => defaultValue);
+var nestedArrayOfObjectsOptional = (fieldName, schema, defaultValue = [], min = 0, max) => {
+  let arraySchema = z.array(schema, {
+    invalid_type_error: `${fieldName} must be an array of objects.`
+  }).min(min, `${fieldName} must contain at least ${min} items.`);
+  if (max !== void 0) {
+    arraySchema = arraySchema.max(
+      max,
+      `${fieldName} must contain at most ${max} items.`
+    );
+  }
+  return arraySchema.optional().default(() => defaultValue);
+};
+var single_select_mandatory = (fieldName) => {
+  const schema = z.string().trim().nonempty(`Please select ${fieldName}.`).transform(handleNullOrUndefined);
+  return schema;
+};
+var single_select_optional = (fieldName) => {
+  r_log(fieldName);
+  const schema = z.string().trim().transform(handleNullOrUndefined);
+  return schema;
+};
+var multi_select_optional = (fieldName, max = 1e3, defaultValue = []) => {
+  const schema = z.array(
+    z.string({
+      invalid_type_error: `${fieldName} must be an array of strings.`
+    })
+  ).max(
+    max,
+    `Please select at most ${max} ${fieldName}${max > 1 ? "s" : ""}.`
+  );
+  return schema.optional().default(defaultValue);
+};
+
+// src/zod_utils/zod_base_schema.ts
+import { z as z2 } from "zod";
+
+// src/core/Enums.ts
+var PAGING = /* @__PURE__ */ ((PAGING2) => {
+  PAGING2["Yes"] = "Yes";
+  PAGING2["No"] = "No";
+  return PAGING2;
+})(PAGING || {});
+var LoadParents = /* @__PURE__ */ ((LoadParents2) => {
+  LoadParents2["Yes"] = "Yes";
+  LoadParents2["No"] = "No";
+  LoadParents2["Custom"] = "Custom";
+  return LoadParents2;
+})(LoadParents || {});
+var LoadChild = /* @__PURE__ */ ((LoadChild2) => {
+  LoadChild2["No"] = "No";
+  LoadChild2["Yes"] = "Yes";
+  LoadChild2["Count"] = "Count";
+  LoadChild2["Custom"] = "Custom";
+  LoadChild2["Direct"] = "Direct";
+  return LoadChild2;
+})(LoadChild || {});
+var LoadChildCount = /* @__PURE__ */ ((LoadChildCount2) => {
+  LoadChildCount2["No"] = "No";
+  LoadChildCount2["Yes"] = "Yes";
+  LoadChildCount2["Custom"] = "Custom";
+  return LoadChildCount2;
+})(LoadChildCount || {});
+var OrderBy = /* @__PURE__ */ ((OrderBy2) => {
+  OrderBy2["asc"] = "asc";
+  OrderBy2["desc"] = "desc";
+  return OrderBy2;
+})(OrderBy || {});
+var LoginFrom = /* @__PURE__ */ ((LoginFrom2) => {
+  LoginFrom2["Web"] = "Web";
+  LoginFrom2["Android"] = "Android";
+  LoginFrom2["IPhone"] = "IPhone";
+  LoginFrom2["AndroidPWA"] = "AndroidPWA";
+  LoginFrom2["iOSPWA"] = "iOSPWA";
+  return LoginFrom2;
+})(LoginFrom || {});
+var Status = /* @__PURE__ */ ((Status2) => {
+  Status2["Active"] = "Active";
+  Status2["Inactive"] = "Inactive";
+  return Status2;
+})(Status || {});
+var FileType = /* @__PURE__ */ ((FileType2) => {
+  FileType2["NoFile"] = "NoFile";
+  FileType2["Image"] = "Image";
+  FileType2["Video"] = "Video";
+  FileType2["PDF"] = "PDF";
+  FileType2["Excel"] = "Excel";
+  return FileType2;
+})(FileType || {});
+var YesNo = /* @__PURE__ */ ((YesNo2) => {
+  YesNo2["Yes"] = "Yes";
+  YesNo2["No"] = "No";
+  return YesNo2;
+})(YesNo || {});
+var InspectionStatus = /* @__PURE__ */ ((InspectionStatus2) => {
+  InspectionStatus2["Pending"] = "Pending";
+  InspectionStatus2["Completed"] = "Completed";
+  InspectionStatus2["Missed"] = "Missed";
+  InspectionStatus2["Cancelled"] = "Cancelled";
+  InspectionStatus2["Failed"] = "Failed";
+  return InspectionStatus2;
+})(InspectionStatus || {});
+var InspectionPriority = /* @__PURE__ */ ((InspectionPriority2) => {
+  InspectionPriority2["Critical"] = "Critical";
+  InspectionPriority2["High"] = "High";
+  InspectionPriority2["Medium"] = "Medium";
+  InspectionPriority2["Low"] = "Low";
+  InspectionPriority2["NoPriority"] = "NoPriority";
+  return InspectionPriority2;
+})(InspectionPriority || {});
+var InspectionType = /* @__PURE__ */ ((InspectionType2) => {
+  InspectionType2["Regular"] = "Regular";
+  InspectionType2["VehicleHandover"] = "VehicleHandover";
+  InspectionType2["VehicleReturn"] = "VehicleReturn";
+  InspectionType2["TripPreCheckList"] = "TripPreCheckList";
+  InspectionType2["TripPostCheckList"] = "TripPostCheckList";
+  InspectionType2["ServiceBefore"] = "ServiceBefore";
+  InspectionType2["ServiceAfter"] = "ServiceAfter";
+  return InspectionType2;
+})(InspectionType || {});
+
+// src/zod_utils/zod_base_schema.ts
+var OrderBySchema = z2.array(
+  z2.object({
+    name: stringMandatory("Order Field Name", 0, 255),
+    field: stringMandatory("Order Field Name", 0, 255),
+    direction: enumMandatory("Order Direction", OrderBy, "asc" /* asc */)
+  })
+);
+var BaseFileSchema = z2.object({
+  usage_type: stringMandatory("Usage Type", 3, 100),
+  file_type: enumMandatory("File Type", FileType, "Image" /* Image */),
+  file_url: stringOptional("File URL", 0, 300),
+  file_key: stringOptional("File Key", 0, 300),
+  file_name: stringOptional("File Name", 0, 300),
+  file_description: stringOptional("File Description", 0, 2e3),
+  file_size: numberOptional("File Size"),
+  file_metadata: dynamicJsonSchema("File Metadata", {}),
+  status: enumMandatory("Status", Status, "Active" /* Active */)
+});
+var BaseQuerySchema = z2.object({
+  search: stringOptional("Search", 0, 255, ""),
+  status: enumArrayOptional("Status", Status, getAllEnums(Status), 0, 10, true),
+  paging: enumOptional("Paging", PAGING, "Yes" /* Yes */),
+  page_count: numberOptional("Page Count", 0, 1e3, 100),
+  page_index: numberOptional("Page Index", 0, 1e3, 0),
+  load_parents: enumOptional("Load Parents", LoadParents, "No" /* No */),
+  load_parents_list: stringArrayOptional("Load Parents List"),
+  load_child: enumOptional("Load Child", LoadChild, "No" /* No */),
+  load_child_list: stringArrayOptional("Load Child List"),
+  load_child_count: enumOptional(
+    "Load Child",
+    LoadChildCount,
+    "No" /* No */
+  ),
+  load_child_count_list: stringArrayOptional("Load Child List"),
+  include_details: dynamicJsonSchema("Include Details", {}),
+  where_relations: dynamicJsonSchema("Where Relations", {}),
+  order_by: OrderBySchema.optional().default([]),
+  include_master_data: enumOptional("Include Master Data", YesNo, "No" /* No */),
+  date_format_id: single_select_optional("MasterMainDateFormat"),
+  time_zone_id: single_select_optional("MasterMainTimeZone")
+});
+var FilePresignedUrlSchema = z2.object({
+  file_name: stringMandatory("File Name", 1, 255),
+  file_type: enumMandatory("File Type", FileType, "Image" /* Image */)
+});
+var MongoBaseQuerySchema = z2.object({
+  search: stringOptional("Search", 0, 255, ""),
+  paging: enumOptional("Paging", PAGING, "Yes" /* Yes */),
+  page_count: numberOptional("Page Count", 0, 1e3, 100),
+  page_index: numberOptional("Page Index", 0, 1e3, 0),
+  login_from: enumMandatory("Login From", LoginFrom, "Web" /* Web */),
+  date_format_id: single_select_optional("MasterMainDateFormat"),
+  // ✅ Single-selection -> MasterMainDateFormat
+  time_zone_id: single_select_optional("MasterMainTimeZone")
+  // ✅ Single-selection -> MasterMainTimeZone
+});
+
+// src/services/fleet/inspection_management/fleet_inspection_management_service.ts
+var URL = "fleet/inspection_management/fleet_inspection";
+var ENDPOINTS = {
+  // AWS S3 PRESIGNED
+  inspection_file_presigned_url: `${URL}/inspection_file_presigned_url`,
+  // File Uploads
+  create_inspection_file: `${URL}/create_inspection_file`,
+  remove_inspection_file: (id) => `${URL}/remove_inspection_file/${id}`,
+  // FleetInspection APIs
+  find: `${URL}/search`,
+  create: `${URL}`,
+  update: (id) => `${URL}/${id}`,
+  delete: (id) => `${URL}/${id}`,
+  inspection_dashboard: `${URL}/inspection_dashboard`
+};
+var FleetInspectionFileSchema = BaseFileSchema.extend({
+  // Relations - Parent
+  organisation_id: single_select_optional("UserOrganisation"),
+  // Single-Selection -> UserOrganisation
+  user_id: single_select_optional("User"),
+  // Single-Selection -> User
+  inspection_id: single_select_optional("FleetInspection")
+  // Single-Selection -> FleetInspection
+});
+var FleetInspectionSchema = z3.object({
+  // Relations - Parent
+  organisation_id: single_select_mandatory("UserOrganisation"),
+  // Single-Selection -> UserOrganisation
+  user_id: single_select_optional("User"),
+  // Single-Selection -> User
+  vehicle_id: single_select_mandatory("MasterVehicle"),
+  // Single-Selection -> MasterVehicle
+  driver_id: single_select_optional("MasterDriver"),
+  // Single-Selection -> MasterDriver
+  inspection_form_id: single_select_optional("FleetInspectionForm"),
+  // Single-Selection -> FleetInspectionForm
+  service_id: single_select_optional("FleetService"),
+  // Single-Selection -> FleetService
+  // Main Field Details
+  inspection_date: dateMandatory("Inspection Date"),
+  inspection_type: enumMandatory("Inspection Type", InspectionType, "Regular" /* Regular */),
+  inspection_priority: enumMandatory("Inspection Priority", InspectionPriority, "NoPriority" /* NoPriority */),
+  inspection_status: enumMandatory("Inspection Status", InspectionStatus, "Pending" /* Pending */),
+  inspection_notes: stringOptional("Inspection Notes", 0, 500),
+  inspection_data: dynamicJsonSchema("Inspection Data", {}),
+  odometer_reading: numberOptional("Odometer Reading"),
+  // Location Details
+  latitude: doubleOptionalLatLng("Latitude"),
+  longitude: doubleOptionalLatLng("Longitude"),
+  google_location: stringOptional("Google Location", 0, 500),
+  // Metadata
+  status: enumMandatory("Status", Status, "Active" /* Active */),
+  // Files
+  FleetInspectionFileSchema: nestedArrayOfObjectsOptional("FleetInspectionFileSchema", FleetInspectionFileSchema, []),
+  // Other
+  time_zone_id: single_select_mandatory("MasterMainTimeZone")
+});
+var FleetInspectionQuerySchema = BaseQuerySchema.extend({
+  // Self Table
+  inspection_ids: multi_select_optional("FleetInspection"),
+  // Multi-Selection -> FleetInspection
+  // Relations - Parent
+  organisation_ids: multi_select_optional("UserOrganisation"),
+  // Multi-Selection -> UserOrganisation
+  user_ids: multi_select_optional("User"),
+  // Multi-Selection -> User
+  vehicle_ids: multi_select_optional("MasterVehicle"),
+  // Multi-Selection -> MasterVehicle
+  driver_ids: multi_select_optional("MasterDriver"),
+  // Multi-Selection -> MasterDriver
+  inspection_form_ids: multi_select_optional("FleetInspectionForm"),
+  // Multi-Selection -> FleetInspectionForm
+  service_ids: multi_select_optional("FleetService"),
+  // Multi-Selection -> FleetService
+  // Enums
+  inspection_type: enumArrayOptional("Inspection Type", InspectionType, getAllEnums(InspectionType)),
+  inspection_priority: enumArrayOptional("Inspection Priority", InspectionPriority, getAllEnums(InspectionPriority)),
+  inspection_status: enumArrayOptional("Inspection Status", InspectionStatus, getAllEnums(InspectionStatus)),
+  // Dates
+  from_date: dateMandatory("From Date"),
+  to_date: dateMandatory("To Date")
+});
+var FleetInspectionDashBoardQuerySchema = BaseQuerySchema.extend({
+  // Relations - Parent
+  organisation_ids: multi_select_optional("UserOrganisation"),
+  // Multi-Selection -> UserOrganisation
+  vehicle_ids: multi_select_optional("MasterVehicle"),
+  // Multi-Selection -> MasterVehicle
+  from_date: dateMandatory("From Date"),
+  to_date: dateMandatory("To Date")
+});
+var toFleetInspectionPayload = (row) => ({
+  organisation_id: row.organisation_id || "",
+  user_id: row.user_id || "",
+  vehicle_id: row.vehicle_id || "",
+  driver_id: row.driver_id || "",
+  inspection_form_id: row.inspection_form_id || "",
+  service_id: row.service_id || "",
+  inspection_date: row.inspection_date || "",
+  inspection_type: row.inspection_type || "Regular" /* Regular */,
+  inspection_priority: row.inspection_priority || "NoPriority" /* NoPriority */,
+  inspection_status: row.inspection_status || "Pending" /* Pending */,
+  inspection_notes: row.inspection_notes || "",
+  inspection_data: row.inspection_data || {},
+  odometer_reading: row.odometer_reading || 0,
+  latitude: row.latitude || 0,
+  longitude: row.longitude || 0,
+  google_location: row.google_location || "",
+  status: row.status || "Active" /* Active */,
+  FleetInspectionFileSchema: row.FleetInspectionFile?.map((file) => ({
+    inspection_file_id: file.inspection_file_id || "",
+    // Usage Type -> Inspection Images, Inspection Videos, Inspection Documents
+    usage_type: file.usage_type || "",
+    file_type: file.file_type || "Image" /* Image */,
+    file_url: file.file_url || "",
+    file_key: file.file_key || "",
+    file_name: file.file_name || "",
+    file_description: file.file_description || "",
+    file_size: file.file_size || 0,
+    file_metadata: file.file_metadata || {},
+    status: file.status || "Active" /* Active */,
+    added_date_time: file.added_date_time,
+    modified_date_time: file.modified_date_time,
+    organisation_id: file.organisation_id || "",
+    user_id: file.user_id || "",
+    inspection_id: file.inspection_id || ""
+  })) || [],
+  time_zone_id: ""
+});
+var newFleetInspectionPayload = () => ({
+  organisation_id: "",
+  user_id: "",
+  vehicle_id: "",
+  driver_id: "",
+  inspection_form_id: "",
+  service_id: "",
+  inspection_date: "",
+  inspection_type: "Regular" /* Regular */,
+  inspection_priority: "NoPriority" /* NoPriority */,
+  inspection_status: "Pending" /* Pending */,
+  inspection_notes: "",
+  inspection_data: {},
+  odometer_reading: 0,
+  latitude: 0,
+  longitude: 0,
+  google_location: "",
+  status: "Active" /* Active */,
+  FleetInspectionFileSchema: [],
+  time_zone_id: ""
+});
+var get_inspection_file_presigned_url = async (data) => {
+  return apiPost(ENDPOINTS.inspection_file_presigned_url, data);
+};
+var create_inspection_file = async (data) => {
+  return apiPost(ENDPOINTS.create_inspection_file, data);
+};
+var remove_inspection_file = async (id) => {
+  return apiDelete(ENDPOINTS.remove_inspection_file(id));
+};
+var findFleetInspection = async (data) => {
+  return apiPost(ENDPOINTS.find, data);
+};
+var createFleetInspection = async (data) => {
+  return apiPost(ENDPOINTS.create, data);
+};
+var updateFleetInspection = async (id, data) => {
+  return apiPatch(ENDPOINTS.update(id), data);
+};
+var deleteFleetInspection = async (id) => {
+  return apiDelete(ENDPOINTS.delete(id));
+};
+var inspection_dashboard = async (data) => {
+  return apiPost(ENDPOINTS.inspection_dashboard, data);
+};
+export {
+  FleetInspectionDashBoardQuerySchema,
+  FleetInspectionFileSchema,
+  FleetInspectionQuerySchema,
+  FleetInspectionSchema,
+  createFleetInspection,
+  create_inspection_file,
+  deleteFleetInspection,
+  findFleetInspection,
+  get_inspection_file_presigned_url,
+  inspection_dashboard,
+  newFleetInspectionPayload,
+  remove_inspection_file,
+  toFleetInspectionPayload,
+  updateFleetInspection
+};

package/dist/services/fleet/inspection_management/fleet_inspection_schedule_service.d.ts

@@ -0,0 +1,6 @@
+import '../../../core/Enums.js';
+import '../../../core/BaseResponse.js';
+import 'zod';
+export { qk as FleetInspectionSchedule, ql as FleetInspectionScheduleDTO, qm as FleetInspectionScheduleQueryDTO, qn as FleetInspectionScheduleQuerySchema, qo as FleetInspectionScheduleSchema, qp as FleetInspectionScheduleVehicleLink, qq as createFleetInspectionSchedule, qr as deleteFleetInspectionSchedule, qs as findFleetInspectionSchedule, qt as newFleetInspectionSchedulePayload, qu as toFleetInspectionSchedulePayload, qv as updateFleetInspectionSchedule } from '../../../user_organisation_service-BHZhNPDL.js';
+import '../../../zod_utils/zod_base_schema.js';
+import '../../gps/reports/gps_models/FuelConsumptionMonthly.js';