fix: Remove old validation schema in names in favour of a standard na…

…ming pattern
theopensystemslab · Jan 22, 2025 · 93edced · 93edced
1 parent b77f302
commit 93edced
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 17 deletions.
diff --git a/editor.planx.uk/src/@planx/components/DateInput/model.test.ts b/editor.planx.uk/src/@planx/components/DateInput/model.test.ts
@@ -1,7 +1,7 @@
 import {
   DateInput,
-  dateRangeSchema,
   dateSchema,
+  dateValidationSchema,
   paddedDate,
   parseDate,
 } from "./model";
@@ -104,22 +104,22 @@ describe("dateSchema", () => {
   });
 });
 
-describe("dateRangeSchema", () => {
+describe("dateValidationSchema", () => {
   test("basic validation", async () => {
     expect(
-      await dateRangeSchema({
+      await dateValidationSchema({
         min: "1990-01-01",
         max: "1999-12-31",
       } as DateInput).isValid("1995-06-15"),
     ).toBe(true);
     expect(
-      await dateRangeSchema({
+      await dateValidationSchema({
         min: "1990-01-01",
         max: "1999-12-31",
       } as DateInput).isValid("2021-06-15"),
     ).toBe(false);
     expect(
-      await dateRangeSchema({
+      await dateValidationSchema({
         min: "1990-01-01",
         max: "1999-12-31",
       } as DateInput).isValid("1980-06-15"),

diff --git a/editor.planx.uk/src/@planx/components/DateInput/model.ts b/editor.planx.uk/src/@planx/components/DateInput/model.ts
@@ -65,6 +65,9 @@ export const parseDate = (date?: string) => {
   return { year, month, day };
 };
 
+/**
+ * Validates that a given string is a date in the correct format
+ */
 export const dateSchema = () => {
   return string()
     .test("missing day", "Date must include a day", (date?: string) => {
@@ -97,7 +100,10 @@ export const dateSchema = () => {
     );
 };
 
-export const dateRangeSchema: (input: DateInput) => SchemaOf<string> = (
+/**
+ * Validates that date is both valid and fits within the provided min/max
+ */
+export const dateValidationSchema: (input: DateInput) => SchemaOf<string> = (
   params,
 ) =>
   dateSchema()

diff --git a/editor.planx.uk/src/@planx/components/TextInput/Public.tsx b/editor.planx.uk/src/@planx/components/TextInput/Public.tsx
@@ -12,7 +12,7 @@ import { object } from "yup";
 import { DESCRIPTION_TEXT, ERROR_MESSAGE } from "../shared/constants";
 import { getPreviouslySubmittedData, makeData } from "../shared/utils";
 import type { TextInput } from "./model";
-import { TextInputType, userDataSchema } from "./model";
+import { TextInputType, textInputValidationSchema } from "./model";
 
 export type Props = PublicProps<TextInput>;
 
@@ -28,7 +28,7 @@ const TextInputComponent: React.FC<Props> = (props) => {
     validateOnBlur: false,
     validateOnChange: false,
     validationSchema: object({
-      text: userDataSchema(props),
+      text: textInputValidationSchema(props),
     }),
   });
 

diff --git a/editor.planx.uk/src/@planx/components/TextInput/model.ts b/editor.planx.uk/src/@planx/components/TextInput/model.ts
@@ -22,7 +22,9 @@ export const emailRegex =
   // eslint-disable-next-line
   /^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/;
 
-export const userDataSchema = ({ type }: TextInput): SchemaOf<UserData> =>
+export const textInputValidationSchema = ({
+  type,
+}: TextInput): SchemaOf<UserData> =>
   string()
     .required("Enter your answer before continuing")
     .test({

diff --git a/editor.planx.uk/src/@planx/components/shared/Schema/model.ts b/editor.planx.uk/src/@planx/components/shared/Schema/model.ts
@@ -8,18 +8,12 @@ import { exhaustiveCheck } from "utils";
 import { array, BaseSchema, object, ObjectSchema, string } from "yup";
 
 import { checklistValidationSchema } from "../../Checklist/model";
-import {
-  DateInput,
-  dateRangeSchema as dateValidationSchema,
-} from "../../DateInput/model";
+import { DateInput, dateValidationSchema } from "../../DateInput/model";
 import {
   NumberInput,
   numberInputValidationSchema,
 } from "../../NumberInput/model";
-import {
-  TextInput,
-  userDataSchema as textInputValidationSchema,
-} from "../../TextInput/model";
+import { TextInput, textInputValidationSchema } from "../../TextInput/model";
 import { Option } from "..";
 
 /**