@coopdigital/react 1.31.1 → 1.32.0

package/src/validations/date.ts

@@ -0,0 +1,177 @@
+// Date validation, shared by date components.
+
+import {
+  formatLimit,
+  getDateErrors,
+  getInvalidParts,
+  getMessage,
+  getRangeError,
+  type Limits,
+  parseDateValue,
+  toISODate,
+  toLimit,
+  trimParts,
+} from "./date-internal"
+
+export type DatePart = "day" | "month" | "year"
+
+export interface DateParts {
+  day?: string
+  month?: string
+  year?: string
+}
+
+export type DateErrorCode =
+  | "missing-date"
+  | "missing-day"
+  | "missing-month"
+  | "missing-year"
+  | "invalid-day"
+  | "invalid-month"
+  | "invalid-year"
+  | "impossible-date"
+  | "unsupported-parts"
+  | "before-min"
+  | "after-max"
+
+/** A message, or a function that builds one from the subject. */
+export type DateErrorMessage = string | ((subject?: string) => string)
+
+export interface DateValidationOptions {
+  /** Upper bound, as a `Date` or ISO string.
+   *
+   * Only the parts used are compared. */
+  max?: Date | string
+  /** Messages to use instead of defaults. */
+  messages?: Partial<Record<DateErrorCode, DateErrorMessage>>
+  /** Lower bound, as a `Date` or ISO string.
+   *
+   * Only the parts used are compared. */
+  min?: Date | string
+  /** The parts used, in the order they are entered.
+   *
+   * Default: `day`, `month`, `year`. */
+  parts?: DatePart[]
+  /** Date as it would start a sentence, such as "Date of birth".
+   *
+   * Default: `Date`. */
+  subject?: string
+}
+
+export interface DateValidationSuccess {
+  /** Whether the date is valid. */
+  valid: true
+  /** The date as an ISO 8601 string, such as 1990-08-21. */
+  value: string
+}
+
+export interface DateValidationError {
+  /** Error code for the first problem. */
+  error: DateErrorCode
+  /** Parts with an error. Every part is invalid when the date is empty,
+   * impossible, has no ISO format or is outside min/max. */
+  invalid: DatePart[]
+  /** Error message. */
+  message: string
+  /** Whether the date is valid. */
+  valid: false
+}
+
+export type DateValidation = DateValidationSuccess | DateValidationError
+
+export const DATE_PARTS: DatePart[] = ["day", "month", "year"]
+
+const realDate = (subject = "Date") => `${subject} must be a real date`
+
+export const DATE_ERROR_MESSAGES: Record<
+  DateErrorCode,
+  string | ((subject?: string, limits?: Limits) => string)
+> = {
+  "after-max": (subject = "Date", limits) => `${subject} must be on or before ${limits?.max}`,
+  "before-min": (subject = "Date", limits) => `${subject} must be on or after ${limits?.min}`,
+  "impossible-date": realDate,
+  "invalid-day": realDate,
+  "invalid-month": realDate,
+  "invalid-year": "Year must include 4 numbers",
+  "missing-date": "Enter a date",
+  "missing-day": (subject = "Date") => `${subject} must include a day`,
+  "missing-month": (subject = "Date") => `${subject} must include a month`,
+  "missing-year": (subject = "Date") => `${subject} must include a year`,
+  "unsupported-parts": realDate,
+}
+
+// Check parts and return if they make a valid date with an ISO format
+// within min/max. Valid date holds its ISO value. Invalid date has
+// error code and message for the first problem, and error parts.
+export const validateDateParts = (
+  date: DateParts,
+  { max, messages = {}, min, parts = DATE_PARTS, subject }: DateValidationOptions = {}
+): DateValidation => {
+  const minDate = min === undefined ? undefined : toLimit(min, "min")
+  const maxDate = max === undefined ? undefined : toLimit(max, "max")
+  const values = trimParts(date)
+  const errors = getDateErrors(values, parts)
+  let value = ""
+
+  if (errors.length === 0) {
+    value = toISODate(values, parts)
+    const rangeError = value ? getRangeError(value, minDate, maxDate) : "unsupported-parts"
+
+    if (!rangeError) return { valid: true, value }
+    errors.push(rangeError)
+  }
+
+  const [error] = errors
+  const limits = {
+    max: maxDate && value ? formatLimit(maxDate, value.length) : undefined,
+    min: minDate && value ? formatLimit(minDate, value.length) : undefined,
+  }
+
+  return {
+    error,
+    invalid: getInvalidParts(errors, parts),
+    message: getMessage(error, subject, messages, limits, DATE_ERROR_MESSAGES),
+    valid: false,
+  }
+}
+
+/** Validate a date.
+ *
+ * If you are only validating a partial date (eg month-year), provide
+ * the `parts` option. */
+export const validateDate = (
+  value: string,
+  options: DateValidationOptions = {}
+): DateValidation => {
+  const date = parseDateValue(value, options.parts)
+  if (date) return validateDateParts(date, options)
+
+  const { messages, parts = DATE_PARTS, subject } = options
+
+  return {
+    error: "impossible-date",
+    invalid: parts,
+    message: getMessage("impossible-date", subject, messages, {}, DATE_ERROR_MESSAGES),
+    valid: false,
+  }
+}
+
+/** Validate a date of birth. */
+export const validateDob = (value: string, options: DateValidationOptions = {}): DateValidation => {
+  // As this is a more specific function for dob validation, we can make
+  // some assumptions. Date needs to be today or in the past and error
+  // messages should reflect dob.
+
+  const { messages, ...rest } = options
+  return validateDate(value, {
+    max: new Date(),
+    messages: {
+      "after-max": "Date of birth must be today or in the past",
+      "missing-date": "Enter your date of birth",
+      ...messages,
+    },
+    parts: DATE_PARTS,
+    subject: "Date of birth",
+    ...rest,
+  })
+}

package/src/validations/index.ts

@@ -0,0 +1 @@
+export * from "./date"

package/dist/components/DateInput/dateinput-internal.d.ts

@@ -1,6 +0,0 @@
-//#region src/components/DateInput/dateinput-internal.d.ts
-export interface Limits {
-  max?: string;
-  min?: string;
-}
-//#endregion