@linzjs/step-ag-grid 14.5.1 → 14.7.0

package/package.json

@@ -2,7 +2,7 @@
   "name": "@linzjs/step-ag-grid",
   "repository": "github:linz/step-ag-grid.git",
   "license": "MIT",
-  "version": "14.5.1",
+  "version": "14.7.0",
   "keywords": [
     "aggrid",
     "ag-grid",

package/src/stories/grid/gridFormInteraction/GridFormEditBearingCorrectionInteraction.stories.tsx

@@ -54,7 +54,7 @@ GridFormEditBearingCorrectionInteractions_.play = async ({ canvasElement }) => {
   // Test formatting a bearing
   expect(inputField).toBeInTheDocument();
   userEvent.type(inputField, "1.2345");
-  expect(await canvas.findByText("+1° 23' 45.0\"")).toBeInTheDocument();
+  expect(await canvas.findByText("+1° 23' 45\"")).toBeInTheDocument();
 
   // Test enter to save
   updateValue.mockClear();

package/src/utils/bearing.test.ts

@@ -7,30 +7,35 @@ import {
 
 describe("bearing", () => {
   test("convertDDToDMS converts decimal-ish degrees to DMS", () => {
-    expect(convertDDToDMS(-0.001, false, false)).toBe("-0° 00' 10\"");
-    expect(convertDDToDMS(-10.001, false, false)).toBe("-10° 00' 10\"");
-    expect(convertDDToDMS(-370.001, false, false)).toBe("-10° 00' 10\"");
-    expect(convertDDToDMS(359.595999, false, false)).toBe("0° 00'");
-    expect(convertDDToDMS(369.696999, false, false)).toBe("10° 10' 10\"");
-    expect(convertDDToDMS(221.555999, false, false)).toBe("221° 56'");
-    expect(convertDDToDMS(221.555999, false, true)).toBe("221° 56' 00.0\"");
-    expect(convertDDToDMS(5)).toBe("+5° 00' 00.0\"");
-    expect(convertDDToDMS(5.0)).toBe("+5° 00' 00.0\"");
-    expect(convertDDToDMS(5.00001)).toBe("+5° 00' 00.1\"");
-    expect(convertDDToDMS(5.1)).toBe("+5° 10' 00.0\"");
+    expect(convertDDToDMS(-0.001, false)).toBe("-0° 00' 10\"");
+    expect(convertDDToDMS(-10.001, false)).toBe("-10° 00' 10\"");
+    expect(convertDDToDMS(-370.001, false)).toBe("-10° 00' 10\"");
+    expect(convertDDToDMS(359.595999, false, 2)).toBe("0° 00'");
+    expect(convertDDToDMS(359.595999, false, 4)).toBe("0° 00' 00\"");
+    expect(convertDDToDMS(359.595999, false, 5)).toBe("0° 00' 00.0\"");
+    expect(convertDDToDMS(369.696999, false)).toBe("10° 10' 10\"");
+    expect(convertDDToDMS(369.696999, false, 4)).toBe("10° 10' 10\"");
+    expect(convertDDToDMS(221.555999, false, 2)).toBe("221° 56'");
+    expect(convertDDToDMS(221.555999, false, 5)).toBe("221° 56' 00.0\"");
+    expect(convertDDToDMS(5, true, 5)).toBe("+5° 00' 00.0\"");
+    expect(convertDDToDMS(5.0, true, 5)).toBe("+5° 00' 00.0\"");
+    expect(convertDDToDMS(5.00001, true, 5)).toBe("+5° 00' 00.1\"");
+    expect(convertDDToDMS(5.1, true, 5)).toBe("+5° 10' 00.0\"");
     expect(convertDDToDMS(5.12345)).toBe("+5° 12' 34.5\"");
     expect(convertDDToDMS(5.12345, false)).toBe("5° 12' 34.5\"");
-
-    expect(convertDDToDMS(300)).toBe("+300° 00' 00.0\"");
-    expect(convertDDToDMS(300.0)).toBe("+300° 00' 00.0\"");
+    expect(convertDDToDMS(5.12345, false, 2)).toBe("5° 12' 34.5\"");
+    expect(convertDDToDMS(300, true, 5)).toBe("+300° 00' 00.0\"");
+    expect(convertDDToDMS(300.0, true, 5)).toBe("+300° 00' 00.0\"");
     expect(convertDDToDMS(300.00001)).toBe("+300° 00' 00.1\"");
-    expect(convertDDToDMS(300.1)).toBe("+300° 10' 00.0\"");
+    expect(convertDDToDMS(300.1, true, 5)).toBe("+300° 10' 00.0\"");
     expect(convertDDToDMS(300.12345)).toBe("+300° 12' 34.5\"");
     expect(convertDDToDMS(300.12345, false)).toBe("300° 12' 34.5\"");
-
-    expect(convertDDToDMS(300, false, false)).toBe("300° 00'");
-    expect(convertDDToDMS(300.1, false, false)).toBe("300° 10'");
-    expect(convertDDToDMS(0, false)).toBe("0° 00'");
+    expect(convertDDToDMS(300, false, 2)).toBe("300° 00'");
+    expect(convertDDToDMS(300.1, false, 2)).toBe("300° 10'");
+    expect(convertDDToDMS(0, false, 2)).toBe("0° 00'");
+    expect(convertDDToDMS(0.0, false)).toBe("0° 00'");
+    expect(convertDDToDMS(0.0, false, 4)).toBe("0° 00' 00\"");
+    expect(convertDDToDMS(0.0, false, 5)).toBe("0° 00' 00.0\"");
   });
 
   test("bearingStringValidator", () => {

package/src/utils/bearing.ts

@@ -3,7 +3,7 @@ export const bearingValueFormatter = (value: any): string => {
   if (safeValue == null) {
     return "–";
   }
-  return convertDDToDMS(safeValue, false, false);
+  return convertDDToDMS(safeValue, false);
 };
 
 export const bearingCorrectionValueFormatter = (value: any): string => {
@@ -12,9 +12,9 @@ export const bearingCorrectionValueFormatter = (value: any): string => {
     return "–";
   }
   if (typeof safeValue === "string") {
-    return convertDDToDMS(bearingNumberParser(safeValue), true, true);
+    return convertDDToDMS(bearingNumberParser(safeValue), true, 4);
   }
-  return convertDDToDMS(safeValue, true, true);
+  return convertDDToDMS(safeValue, true, 4);
 };
 
 export const bearingNumberParser = (value: string): number | null => {
@@ -40,12 +40,21 @@ export const bearingStringValidator = (
   return customInvalid ? customInvalid(bearing) : null;
 };
 
-// Decimal-ish degrees to Degrees Minutes Seconds converter
-export const convertDDToDMS = (dd: number | null, showPositiveSymbol = true, addTrailingZeros = true): string => {
+/**
+ *Decimal-ish degrees to Degrees Minutes Seconds converter
+ *
+ * @param dd Decimal-ish degrees
+ * @param showPositiveSymbol whether the + sign appears before the number
+ * @param trailingZeroDp 2 | 4 | 5
+ * Example:
+ * 2 = 300° 00'
+ * 4 = 300° 00' 00"
+ * 5 = 300° 00' 00.0"
+ * @returns Degrees Minutes Seconds
+ */
+export const convertDDToDMS = (dd: number | null, showPositiveSymbol = true, trailingZeroDp: 2 | 4 | 5 = 2): string => {
   if (dd == null) return "–";
 
-  if (dd === 0) addTrailingZeros = false;
-
   // toFixed rounds parts up greater than 60, which has to be corrected below
   const [bearingWholeString, bearingDecimalString] = dd.toFixed(5).split(".");
 
@@ -71,14 +80,13 @@ export const convertDDToDMS = (dd: number | null, showPositiveSymbol = true, add
   const deciSecString = bearingDecimalString?.substring(4, 5);
 
   let dmsString = `${showPositiveSymbol && dd > 0 ? "+" : ""}${dd < 0 ? "-" : ""}${bearingWhole}°`;
-  if (addTrailingZeros || deciSecString != "0") {
+  if (trailingZeroDp === 5 || deciSecString != "0") {
     dmsString += `\xa0${minString}'\xa0${secString}.${deciSecString}"`; // "\xa0" is here for non-breaking space
-  } else if (secNumeric != 0) {
+  } else if (trailingZeroDp === 4 || secNumeric != 0) {
     dmsString += `\xa0${minString}'\xa0${secString}"`;
   } else {
     dmsString += `\xa0${minString}'`;
   }
-
   return dmsString;
 };
 

package/src/utils/textValidator.test.ts

@@ -68,6 +68,13 @@ describe("TextInputValidator", () => {
           ["1.1", "Must be a whole number"],
         ],
       },
+      {
+        numberFormat: { notZero: true },
+        tests: [
+          ["1", null],
+          ["0", "Must not be 0"],
+        ],
+      },
       {
         required: true,
         tests: [

package/src/utils/textValidator.ts

@@ -13,6 +13,7 @@ export interface TextInputValidatorProps<RowType extends GridBaseRow> {
     geMin?: number;
     ltMax?: number;
     leMax?: number;
+    notZero?: boolean;
   };
 }
 
@@ -44,17 +45,20 @@ export const TextInputValidator = <RowType extends GridBaseRow>(
     }
     if (value != "") {
       const number = parseFloat(value);
+      if (nf.notZero && number === 0) {
+        return `Must not be 0`;
+      }
       if (nf.gtMin != null && number <= nf.gtMin) {
-        return `Must be greater than ${nf.gtMin}`;
+        return `Must be greater than ${nf.gtMin.toLocaleString()}`;
       }
       if (nf.geMin != null && number < nf.geMin) {
-        return `Must not be less than ${nf.geMin}`;
+        return `Must not be less than ${nf.geMin.toLocaleString()}`;
       }
       if (nf.ltMax != null && number >= nf.ltMax) {
-        return `Must be less than ${nf.ltMax}`;
+        return `Must be less than ${nf.ltMax.toLocaleString()}`;
       }
       if (nf.leMax != null && number > nf.leMax) {
-        return `Must not be greater than ${nf.leMax}`;
+        return `Must not be greater than ${nf.leMax.toLocaleString()}`;
       }
 
       if (nf.precision != null && value != "") {

package/src/utils/util.test.ts

@@ -1,6 +1,17 @@
-import { sanitiseFileName } from "./util";
+import { isFloat, sanitiseFileName } from "./util";
 
 describe("sanitiseFileName", () => {
+  test("isFloat", () => {
+    expect(isFloat("")).toBe(false);
+    expect(isFloat("x")).toBe(false);
+    expect(isFloat("1e10")).toBe(false);
+    expect(isFloat("1x")).toBe(false);
+    expect(isFloat("1.x")).toBe(false);
+    expect(isFloat("x.1")).toBe(false);
+    expect(isFloat("1")).toBe(true);
+    expect(isFloat("1.")).toBe(true);
+    expect(isFloat(".1")).toBe(true);
+  });
   test("sanitiseFileName", () => {
     expect(sanitiseFileName(" LT 1235/543 &%//*$ ")).toBe("LT_1235-543_&%-$");
     expect(sanitiseFileName(" @filename here!!! ")).toBe("@filename_here!!!");

package/src/utils/util.ts

@@ -8,9 +8,18 @@ export const wait = (timeoutMs: number) =>
     setTimeout(resolve, timeoutMs);
   });
 
+// This regexp only works if you parseFloat first, it won't validate a float on its own
+// It prevents scientific 1e10, or trailing decimal 1.2.3, or trailing garbage 1.2xyz
+const isFloatRegExp = /^-?\d*\.?\d*$/;
 export const isFloat = (value: string) => {
-  const regexp = /^-?\d*(\.\d+)?$/;
-  return regexp.test(value);
+  try {
+    // Just checking it's not scientific notation or "NaN" here.
+    // Also parse float will parse up to the first invalid character,
+    // so we need to check there's no remaining invalids e.g. "1.2xyz" would parse as 1.2
+    return !Number.isNaN(parseFloat(value)) && isFloatRegExp.test(value);
+  } catch {
+    return false;
+  }
 };
 
 export const findParentWithClass = function (className: string, child: Node): HTMLElement | null {