docs: clarify casing behavior for modbus entity validation

Signed-off-by: Pranav-0440 <pranavghorpade61@gmail.com>

Author: Pranav-0440

doc/examples/csv/README.md

@@ -23,13 +23,13 @@ A valid CSV file with correct data types and Modbus entities. This file should i
 
 ### `invalid.csv`
 
-A CSV file with intentional validation errors to demonstrate the warning system. When imported, this file will trigger the following warnings:
+A CSV file with intentional validation issues to demonstrate the warning system. When imported, this file will trigger the following warnings:
 
 1. **Row 2, type**: `number123` is invalid (should be `number`, `string`, or `boolean`)
-2. **Row 2, modbus:entity**: `holdingregister` is invalid (case-sensitive, should be `HoldingRegister`)
+2. **Row 2, modbus:entity**: `holdingregister` has incorrect casing (expected `HoldingRegister`)
 3. **Row 3, modbus:entity**: `InvalidRegister` is not a recognized Modbus entity
 4. **Row 4, type**: `invalid_type` is not a valid type
-5. **Row 5, modbus:entity**: `coil` is invalid (case-sensitive, should be `Coil`)
+5. **Row 5, modbus:entity**: `coil` has incorrect casing (expected `Coil`)
 
 ## Usage
 
@@ -57,4 +57,4 @@ Required columns:
 - `modbus:mostSignificantWord`: Boolean (true/false)
 - `href`: Property endpoint path
 
-Note: The validation is case-insensitive for Modbus entities, so `coil`, `Coil`, and `COIL` are all treated as equivalent.
+Note: Modbus entity validation is case-insensitive for recognition purposes, but incorrect casing will produce a warning. For example, `coil` and `Coil` are treated as the same entity, but `coil` will generate a casing warning.

src/components/App/CreateTd.tsx

@@ -98,8 +98,8 @@ const CreateTd: React.FC<CreateTdProps> = ({
         if (warnings.length > 0) {
           const warningMessage = warnings
             .map((w) => `Row ${w.row}, column "${w.column}": ${w.message}`)
-            .join("\n");
-          setError({ open: true, message: `Warnings:\n${warningMessage}` });
+            .join("; ");
+          setError({ open: true, message: `Warnings: ${warningMessage}` });
         } else {
           setError({ open: false, message: "" });
         }

src/components/Dialogs/ConvertTmDialog.tsx

@@ -18,7 +18,6 @@ import {
   isVersionValid,
 } from "../../services/operations";
 import TextField from "../base/TextField";
-import { CsvWarning } from "../../utils/parser";
 
 export interface ConvertTmDialogRef {
   openModal: () => void;
@@ -29,7 +28,6 @@ const ConvertTmDialog = forwardRef<ConvertTmDialogRef>((props, ref) => {
   const context = useContext(ediTDorContext);
 
   const [display, setDisplay] = useState(false);
-  const [warnings, setWarnings] = useState<CsvWarning[]>([]);
   const [validVersion, setValidVersion] = useState(false);
   const [versionInput, setVersionInput] = useState("");
 
@@ -67,22 +65,9 @@ const ConvertTmDialog = forwardRef<ConvertTmDialogRef>((props, ref) => {
       onHandleEventRightButton={handleGenerateTd}
       rightButton={"Generate TD"}
       title={"Generate TD From TM"}
-      description={"CSV conversion completed"}
+      description={"Please provide values to switch the placeholders with."}
     >
       <>
-        {warnings.length > 0 && (
-          <div className="mb-4 rounded bg-yellow-900 p-3 text-yellow-200">
-            <h3 className="font-bold">CSV Import Warnings</h3>
-            <ul className="list-disc pl-5">
-              {warnings.map((w, i) => (
-                <li key={i}>
-                  Row {w.row}, {w.column}: {w.message}
-                </li>
-              ))}
-            </ul>
-          </div>
-        )}
-
         {!validVersion && (
           <TextField
             label="TD instance version"

src/utils/parser.ts

@@ -21,6 +21,9 @@ const VALID_MODBUS_ENTITIES = [
   "DiscreteInput",
 ];
 
+const VALID_MODBUS_ENTITIES_LOWER = VALID_MODBUS_ENTITIES.map((e) =>
+  e.toLowerCase()
+);
 /** ====================================================== */
 
 export type CsvData = {
@@ -91,10 +94,12 @@ export const parseCsv = (
   const warnings: CsvWarning[] = [];
 
   const res = Papa.parse<CsvData>(csvContent, {
-    header: true,
+    header: hasHeaders,
+    quoteChar: '"',
     skipEmptyLines: true,
+    dynamicTyping: false,
     transformHeader: (h) => h.trim(),
-    transform: (v) => (typeof v === "string" ? v.trim() : v),
+    transform: (value) => (typeof value === "string" ? value.trim() : value),
   });
 
   if (res.errors.length) {
@@ -115,16 +120,27 @@ export const parseCsv = (
     }
 
     if (row["modbus:entity"]) {
-      const entityLower = row["modbus:entity"].toLowerCase();
-      const validEntityLower = VALID_MODBUS_ENTITIES.map((e) =>
-        e.toLowerCase()
-      );
-      if (!validEntityLower.includes(entityLower)) {
+      const entityValue = row["modbus:entity"];
+      const entityLower = entityValue.toLowerCase();
+
+      const matchedIndex = VALID_MODBUS_ENTITIES_LOWER.indexOf(entityLower);
+
+      if (matchedIndex === -1) {
         warnings.push({
           row: rowNum,
           column: "modbus:entity",
-          message: `Invalid modbus entity "${row["modbus:entity"]}"`,
+          message: `Invalid modbus entity "${entityValue}"`,
         });
+      } else {
+        const canonical = VALID_MODBUS_ENTITIES[matchedIndex];
+
+        if (entityValue !== canonical) {
+          warnings.push({
+            row: rowNum,
+            column: "modbus:entity",
+            message: `Modbus entity "${entityValue}" has incorrect casing; expected "${canonical}"`,
+          });
+        }
       }
     }
   });

test/csv-examples.test.ts

@@ -1,69 +1,26 @@
-import { parseCsv, mapCsvToProperties } from "../src/utils/parser";
-import * as fs from "fs";
-import * as path from "path";
-import { fileURLToPath } from "url";
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-console.log("=== Testing CSV Examples ===\n");
-
-// Test valid.csv
-console.log("1. Testing valid.csv:");
-const validCsv = fs.readFileSync(
-  path.join(__dirname, "../doc/examples/csv/valid.csv"),
-  "utf-8"
-);
-const validResult = parseCsv(validCsv, true);
-console.log(`   - Rows parsed: ${validResult.data.length}`);
-console.log(`   - Warnings: ${validResult.warnings.length}`);
-if (validResult.warnings.length > 0) {
-  console.log("   FAIL: Expected no warnings but got:");
-  validResult.warnings.forEach((w) =>
-    console.log(`      Row ${w.row}, ${w.column}: ${w.message}`)
+import { describe, it, expect } from "vitest";
+import { parseCsv } from "../src/utils/parser";
+import fs from "fs";
+import path from "path";
+
+describe("CSV example files", () => {
+  const validCsv = fs.readFileSync(
+    path.join(__dirname, "../doc/examples/csv/valid.csv"),
+    "utf-8"
   );
-} else {
-  console.log("   PASS: No warnings as expected");
-}
-
-// Try to map properties
-try {
-  const properties = mapCsvToProperties(validResult.data);
-  console.log(`   - Properties created: ${Object.keys(properties).length}`);
-  console.log("   PASS: Properties mapped successfully");
-} catch (err) {
-  console.log(`   FAIL: ${(err as Error).message}`);
-}
-
-console.log("\n2. Testing invalid.csv:");
-const invalidCsv = fs.readFileSync(
-  path.join(__dirname, "../doc/examples/csv/invalid.csv"),
-  "utf-8"
-);
-const invalidResult = parseCsv(invalidCsv, true);
-console.log(`   - Rows parsed: ${invalidResult.data.length}`);
-console.log(`   - Warnings: ${invalidResult.warnings.length}`);
 
-if (invalidResult.warnings.length === 0) {
-  console.log("   FAIL: Expected warnings but got none");
-} else {
-  console.log("   PASS: Warnings detected as expected:");
-  invalidResult.warnings.forEach((w) =>
-    console.log(`      Row ${w.row}, ${w.column}: ${w.message}`)
+  const invalidCsv = fs.readFileSync(
+    path.join(__dirname, "../doc/examples/csv/invalid.csv"),
+    "utf-8"
   );
-}
 
-// Try to map properties - should still work despite warnings
-try {
-  const properties = mapCsvToProperties(invalidResult.data);
-  console.log(`   - Properties created: ${Object.keys(properties).length}`);
-  console.log("   PASS: Properties mapped successfully despite warnings");
-} catch (err) {
-  console.log(`   FAIL: ${(err as Error).message}`);
-}
+  it("valid.csv should produce no warnings", () => {
+    const result = parseCsv(validCsv, true);
+    expect(result.warnings.length).toBe(0);
+  });
 
-console.log("\n=== Summary ===");
-console.log("All CSV example files tested successfully!");
-console.log(
-  "The validation system correctly identifies issues while still allowing data import."
-);
+  it("invalid.csv should produce warnings", () => {
+    const result = parseCsv(invalidCsv, true);
+    expect(result.warnings.length).toBeGreaterThan(0);
+  });
+});