@linzjs/step-ag-grid 23.0.1 → 25.0.0

package/src/utils/textValidator.test.ts

@@ -1,118 +1,117 @@
-import { GridBaseRow } from "../components/Grid";
-import { TextInputValidator, TextInputValidatorProps } from "./textValidator";
+import { describe, expect, test, vi } from 'vitest';
 
-describe("TextInputValidator", () => {
-  test("number format", () => {
+import { GridBaseRow } from '../components/Grid';
+import { TextInputValidator, TextInputValidatorProps } from './textValidator';
+
+describe('TextInputValidator', () => {
+  test('number format', () => {
     const validate = [
       {
         numberFormat: {},
         tests: [
-          ["x", "Must be a valid number"],
-          ["1.2e6", "Must be a valid number"],
-          ["", null],
-          ["1", null],
-          ["1.2", null],
-          [".2", null],
-          ["-1.2", null],
-          ["-.2", null],
-          ["-.2", null],
+          ['x', 'Must be a valid number'],
+          ['1.2e6', 'Must be a valid number'],
+          ['', null],
+          ['1', null],
+          ['1.2', null],
+          ['.2', null],
+          ['-1.2', null],
+          ['-.2', null],
+          ['-.2', null],
         ],
       },
       {
         numberFormat: { geMin: 0, leMax: 10 },
         tests: [
-          ["x", "Must be a valid number"],
-          ["", null],
-          ["1", null],
-          ["0", null],
-          ["-1", "Must not be less than 0"],
-          ["10", null],
-          ["10.1", "Must not be greater than 10"],
+          ['x', 'Must be a valid number'],
+          ['', null],
+          ['1', null],
+          ['0', null],
+          ['-1', 'Must not be less than 0'],
+          ['10', null],
+          ['10.1', 'Must not be greater than 10'],
         ],
       },
       {
         numberFormat: { gtMin: 0, ltMax: 10 },
         tests: [
-          ["x", "Must be a valid number"],
-          ["", null],
-          ["1", null],
-          ["0", "Must be greater than 0"],
-          ["10", "Must be less than 10"],
+          ['x', 'Must be a valid number'],
+          ['', null],
+          ['1', null],
+          ['0', 'Must be greater than 0'],
+          ['10', 'Must be less than 10'],
         ],
       },
       {
         numberFormat: { precision: 3 },
         tests: [
-          ["x", "Must be a valid number"],
-          ["", null],
-          ["1.22", null],
-          ["0.122", null],
-          ["1.123", "Must have no more than 3 digits precision"],
-          ["0.1234", "Must have no more than 3 digits precision"],
+          ['x', 'Must be a valid number'],
+          ['', null],
+          ['1.22', null],
+          ['0.122', null],
+          ['1.123', 'Must have no more than 3 digits precision'],
+          ['0.1234', 'Must have no more than 3 digits precision'],
         ],
       },
       {
         numberFormat: { scale: 2 },
         tests: [
-          ["x", "Must be a valid number"],
-          ["", null],
-          ["1.22", null],
-          ["0.122", "Must have no more than 2 decimal places"],
-          ["1.123", "Must have no more than 2 decimal places"],
+          ['x', 'Must be a valid number'],
+          ['', null],
+          ['1.22', null],
+          ['0.122', 'Must have no more than 2 decimal places'],
+          ['1.123', 'Must have no more than 2 decimal places'],
         ],
       },
       {
         numberFormat: { scale: 0 },
         tests: [
-          ["1", null],
-          ["1.1", "Must be a whole number"],
+          ['1', null],
+          ['1.1', 'Must be a whole number'],
         ],
       },
       {
         numberFormat: { notZero: true },
         tests: [
-          ["1", null],
-          ["0", "Must not be 0"],
+          ['1', null],
+          ['0', 'Must not be 0'],
         ],
       },
       {
         required: true,
         tests: [
-          ["xx", null],
-          ["", "Must not be empty"],
-          ["\t", "Must not be empty"],
-          ["\n", "Must not be empty"],
-          ["\r", "Must not be empty"],
-          [" ", "Must not be empty"],
+          ['xx', null],
+          ['', 'Must not be empty'],
+          ['\t', 'Must not be empty'],
+          ['\n', 'Must not be empty'],
+          ['\r', 'Must not be empty'],
+          [' ', 'Must not be empty'],
         ],
       },
     ] as (TextInputValidatorProps<GridBaseRow> & { tests: [string, string | undefined][] })[];
 
-    validate.forEach((v, i) => {
+    validate.forEach((v) => {
       for (const test of v.tests) {
-        expect(
-          TextInputValidator(v, test[0], { id: 0 }, {}),
-          `Test ${i}: "${test[0]}" should return "${test[1]}"`,
-        ).toBe(test[1]);
+        expect(TextInputValidator(v, test[0], { id: 0 }, {})).toBe(test[1]);
       }
     });
   });
 
-  test("validator is called", () => {
-    const fn = jest.fn();
-    TextInputValidator({ invalid: fn }, "", { id: 0 }, {});
+  test('validator is called', () => {
+    const fn = vi.fn();
+    TextInputValidator({ invalid: fn }, '', { id: 0 }, {});
     expect(fn).toHaveBeenCalled();
   });
 
-  test("maxLength", () => {
-    expect(TextInputValidator({ maxLength: 2 }, "", { id: 0 }, {})).toBeNull();
-    expect(TextInputValidator({ maxLength: 2 }, "aa", { id: 0 }, {})).toBeNull();
-    expect(TextInputValidator({ maxLength: 2 }, "aaa", { id: 0 }, {})).toBe("Must be no longer than 2 characters");
+  test('maxLength', () => {
+    expect(TextInputValidator({ maxLength: 2 }, '', { id: 0 }, {})).toBeNull();
+    expect(TextInputValidator({ maxLength: 2 }, 'aa', { id: 0 }, {})).toBeNull();
+    expect(TextInputValidator({ maxLength: 2 }, 'aaa', { id: 0 }, {})).toBe('Must be no longer than 2 characters');
   });
 
-  test("maxBytes", () => {
-    expect(TextInputValidator({ maxBytes: 2 }, "", { id: 0 }, {})).toBeNull();
-    expect(TextInputValidator({ maxBytes: 2 }, "aa", { id: 0 }, {})).toBeNull();
-    expect(TextInputValidator({ maxBytes: 2 }, "a–", { id: 0 }, {})).toBe("Must be no longer than 2 bytes");
+  test('maxBytes', () => {
+    expect(TextInputValidator({ maxBytes: 2 }, '', { id: 0 }, {})).toBeNull();
+    expect(TextInputValidator({ maxBytes: 2 }, 'aa', { id: 0 }, {})).toBeNull();
+    expect(TextInputValidator({ maxBytes: 2 }, 'a–', { id: 0 }, {})).toBe('Must be no longer than 2 bytes');
   });
 });

package/src/utils/textValidator.ts

@@ -1,7 +1,7 @@
-import { ReactElement } from "react";
+import { ReactElement } from 'react';
 
-import { GridBaseRow } from "../components/Grid";
-import { isFloat, stringByteLengthIsInvalid } from "./util";
+import { GridBaseRow } from '../components/Grid';
+import { isFloat, stringByteLengthIsInvalid } from './util';
 
 export interface TextInputValidatorProps<TData extends GridBaseRow> {
   required?: boolean;
@@ -28,11 +28,11 @@ export const TextInputValidator = <TData extends GridBaseRow>(
   if (value == null) return null;
 
   // This can happen because subcomponent is invoked without type safety
-  if (typeof value !== "string") {
-    return "Value is not a string";
+  if (typeof value !== 'string') {
+    return 'Value is not a string';
   }
-  if (props.required && value.trim() == "") {
-    return "Must not be empty";
+  if (props.required && value.trim() == '') {
+    return 'Must not be empty';
   }
   if (props.maxLength && value.length > props.maxLength) {
     return `Must be no longer than ${props.maxLength} characters`;
@@ -42,10 +42,10 @@ export const TextInputValidator = <TData extends GridBaseRow>(
   }
   const nf = props.numberFormat;
   if (nf) {
-    if (value != "" && !isFloat(value)) {
+    if (value != '' && !isFloat(value)) {
       return `Must be a valid number`;
     }
-    if (value != "") {
+    if (value != '') {
       const number = parseFloat(value);
       if (nf.notZero && number === 0) {
         return `Must not be 0`;
@@ -63,13 +63,13 @@ export const TextInputValidator = <TData extends GridBaseRow>(
         return `Must not be greater than ${nf.leMax.toLocaleString()}`;
       }
 
-      if (nf.precision != null && value != "") {
+      if (nf.precision != null && value != '') {
         if (parseFloat(number.toPrecision(nf.precision)) != number) {
           return `Must have no more than ${nf.precision} digits precision`;
         }
       }
 
-      if (nf.scale != null && value != "") {
+      if (nf.scale != null && value != '') {
         if (parseFloat(number.toFixed(nf.scale)) != number) {
           return nf.scale == 0 ? `Must be a whole number` : `Must have no more than ${nf.scale} decimal places`;
         }

package/src/utils/util.test.ts

@@ -1,29 +1,30 @@
-import { isFloat, sanitiseFileName } from "./util";
+import { describe, expect, test } from 'vitest';
 
-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);
+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 &%//*$.csv ")).toBe("LT_1235-543_-.csv");
-    expect(sanitiseFileName(" @filename here!!!.csv ")).toBe("filename_here.csv");
+  test('sanitiseFileName', () => {
+    expect(sanitiseFileName(' LT 1235/543 &%//*$.csv ')).toBe('LT_1235-543_-.csv');
+    expect(sanitiseFileName(' @filename here!!!.csv ')).toBe('filename_here.csv');
     // Trim to 64 char max for non extension part
-    expect(sanitiseFileName("long_long_long_long_long_long_long_long_long_long_long_long_long_long_.csv")).toBe(
-      "long_long_long_long_long_long_long_long_long_long_long_long_long.csv",
+    expect(sanitiseFileName('long_long_long_long_long_long_long_long_long_long_long_long_long_long_.csv')).toBe(
+      'long_long_long_long_long_long_long_long_long_long_long_long_long.csv',
     );
     // Test with no extension
-    expect(sanitiseFileName("long_long_long_long_long_long_long_long_long_long_long_long_long_long_")).toBe(
-      "long_long_long_long_long_long_long_long_long_long_long_long_long",
+    expect(sanitiseFileName('long_long_long_long_long_long_long_long_long_long_long_long_long_long_')).toBe(
+      'long_long_long_long_long_long_long_long_long_long_long_long_long',
     );
     // Test with no name
-    expect(sanitiseFileName(".csv")).toBe(".csv");
+    expect(sanitiseFileName('.csv')).toBe('.csv');
   });
 });

package/src/utils/util.ts

@@ -1,4 +1,4 @@
-import { isEmpty, negate } from "lodash-es";
+import { isEmpty, negate } from 'lodash-es';
 
 export const isNotEmpty = negate(isEmpty);
 
@@ -44,17 +44,17 @@ export const hasParentClass = function (className: string, child: Node) {
 export const stringByteLengthIsInvalid = (str: string, maxBytes: number) =>
   new TextEncoder().encode(str).length > maxBytes;
 
-export const fnOrVar = (fn: any, param?: any) => (typeof fn === "function" ? fn(param) : fn);
+export const fnOrVar = (fn: any, param?: any) => (typeof fn === 'function' ? fn(param) : fn);
 
 export const sanitiseFileName = (filename: string): string => {
   const valid = filename
     .trim()
-    .replaceAll(/(\/|\\)+/g, "-")
-    .replaceAll(/\s+/g, "_")
-    .replaceAll(/[^\w\-āēīōūĀĒĪŌŪ.]/g, "");
-  const parts = valid.split(".");
+    .replaceAll(/(\/|\\)+/g, '-')
+    .replaceAll(/\s+/g, '_')
+    .replaceAll(/[^\w\-āēīōūĀĒĪŌŪ.]/g, '');
+  const parts = valid.split('.');
   const fileExt = parts.length > 1 ? parts.pop() : undefined;
   // Arbitrary max filename length of 64 chars + extension
   if (!fileExt) return valid.slice().slice(0, 64);
-  return valid.slice(0, -fileExt.length - 1).slice(0, 64) + "." + fileExt;
+  return valid.slice(0, -fileExt.length - 1).slice(0, 64) + '.' + fileExt;
 };

package/dist/src/utils/storybookTestUtil.d.ts

@@ -1,3 +0,0 @@
-export declare const waitForGridReady: ({ canvasElement }: {
-    canvasElement: HTMLElement;
-}) => Promise<void>;

package/dist/src/utils/testQuick.d.ts

@@ -1,62 +0,0 @@
-/**
- * General query all by selected.  Internal use, use quick operations instead.
- *
- * @param selector Selector to use
- * @param container Optional container
- * @return HTMLElement array
- */
-import { IconName } from "@linzjs/lui/dist/components/LuiIcon/LuiIcon";
-/**
- * Filters for query quick operations.
- */
-export interface IQueryQuick {
-    testId?: string;
-    tagName?: "button" | "span" | "div" | "input" | "textarea" | any;
-    text?: string | RegExp;
-    icon?: IconName;
-    ariaLabel?: string;
-    role?: string;
-    classes?: string;
-    child?: IQueryQuick;
-}
-export declare const getMatcher: (matcherText: string | RegExp) => (e: HTMLElement) => boolean;
-/**
- * Query by filter.
- *
- * @param filter Filter
- * @param container Optional container to look in
- * @return HTMLElement if found else null
- */
-export declare const queryQuick: <T extends HTMLElement>(filter: IQueryQuick, container?: HTMLElement) => T | null;
-/**
- * Query all by filter.
- *
- * @param filter Filter
- * @param container Optional container to look in
- * @return HTMLElement array
- */
-export declare const queryAllQuick: <T extends HTMLElement>(filter: IQueryQuick, container?: HTMLElement) => T[];
-/**
- * Get all by filter.
- *
- * @param filter Filter
- * @param container Optional container to look in
- * @return HTMLElement array.  Throws exception if nothing is found.
- */
-export declare const getAllQuick: <T extends HTMLElement>(filter: IQueryQuick, container?: HTMLElement) => T[];
-/**
- * Get by filter.
- *
- * @param filter Filter
- * @param container Optional container to look in
- * @return HTMLElement.  Throws exception if not found.
- */
-export declare const getQuick: (filter: IQueryQuick, container?: HTMLElement) => HTMLElement;
-/**
- * Find by filter.  Waits up to 5 seconds to find filter.
- *
- * @param filter Filter
- * @param container Optional container to look in
- * @return HTMLElement.  Throws exception if not found.
- */
-export declare const findQuick: <T extends HTMLElement>(filter: IQueryQuick, container?: HTMLElement) => Promise<T>;

package/dist/src/utils/testUtil.d.ts

@@ -1,46 +0,0 @@
-/**
- * allow external userEvent to be used
- * @param customisedUserEvent
- */
-export declare const setUpUserEvent: (customisedUserEvent: any) => void;
-export declare const countRows: (within?: HTMLElement) => Promise<number>;
-export declare const findRowByIndex: (rowIndex: number | string, within?: HTMLElement) => Promise<HTMLDivElement>;
-export declare const findRow: (rowId: number | string, within?: HTMLElement) => Promise<HTMLDivElement>;
-export declare const queryRow: (rowId: number | string, within?: HTMLElement) => Promise<HTMLDivElement | null>;
-export declare const selectRow: (rowId: string | number, within?: HTMLElement) => Promise<void>;
-export declare const deselectRow: (rowId: string | number, within?: HTMLElement) => Promise<void>;
-export declare const findCell: (rowId: number | string, colId: string, within?: HTMLElement) => Promise<HTMLElement>;
-export declare const findCellContains: (rowId: number | string, colId: string, text: string | RegExp, within?: HTMLElement) => Promise<HTMLElement>;
-export declare const selectCell: (rowId: string | number, colId: string, within?: HTMLElement) => Promise<void>;
-export declare const editCell: (rowId: number | string, colId: string, within?: HTMLElement) => Promise<void>;
-export declare const isCellReadOnly: (rowId: number | string, colId: string, within?: HTMLElement) => Promise<boolean>;
-export declare const findOpenPopover: () => Promise<HTMLElement>;
-export declare const queryMenuOption: (menuOptionText: string | RegExp) => Promise<HTMLElement | null>;
-export declare const findMenuOption: (menuOptionText: string | RegExp) => Promise<HTMLElement>;
-export declare const validateMenuOptions: (rowId: number | string, colId: string, expectedMenuOptions: Array<string>) => Promise<boolean>;
-export declare const clickMenuOption: (menuOptionText: string | RegExp) => Promise<void>;
-export declare const openAndClickMenuOption: (rowId: number | string, colId: string, menuOptionText: string | RegExp, within?: HTMLElement) => Promise<void>;
-export declare const openAndFindMenuOption: (rowId: number | string, colId: string, menuOptionText: string | RegExp, within?: HTMLElement) => Promise<HTMLElement>;
-export declare const getMultiSelectOptions: () => Promise<{
-    v: string;
-    c: boolean;
-}[]>;
-export declare const findMultiSelectOption: (value: string) => Promise<HTMLElement>;
-export declare const clickMultiSelectOption: (value: string) => Promise<void>;
-export declare const typeOnlyInput: (value: string) => Promise<void>;
-export declare const typeInputByLabel: (value: string, labelText: string) => Promise<void>;
-export declare const typeInputByPlaceholder: (value: string, placeholder: string) => Promise<void>;
-export declare const typeOtherInput: (value: string) => Promise<void>;
-export declare const typeOtherTextArea: (value: string) => Promise<void>;
-export declare const closeMenu: () => Promise<void>;
-export declare const closePopover: () => Promise<void>;
-export declare const findActionButton: (text: string, container?: HTMLElement) => Promise<HTMLElement>;
-export declare const clickActionButton: (text: string, container?: HTMLElement) => Promise<void>;
-export declare const waitForGridReady: (props?: {
-    grid?: HTMLElement;
-    timeout?: number;
-}) => Promise<void>;
-export declare const waitForGridRows: (props?: {
-    grid?: HTMLElement;
-    timeout?: number;
-}) => Promise<void>;