- empty values now are parsed as unset in range (#4465)

jpmorganchase · Nov 29, 2024 · d04c38b · d04c38b
1 parent 33c8da5
commit d04c38b
Show file tree

Hide file tree

Showing 32 changed files with 867 additions and 469 deletions.
diff --git a/packages/date-adapters/src/date-fns/index.ts b/packages/date-adapters/src/date-fns/index.ts
@@ -152,20 +152,24 @@ export class AdapterDateFns implements SaltDateAdapter<Date, Locale> {
 
   /**
    * Formats a Date object using the specified format string.
+   * Returns an empty string when null or undefined date is given.
    * @param date - The Date object to format.
    * @param format - The format string to use.
    * @param locale - The locale to use for formatting.
    * @returns The formatted date string.
    */
   public format(
-    date: Date,
+    date: Date | null | undefined,
     format: RecommendedFormats = "dd MMM yyyy",
     locale?: Locale,
   ): string {
-    const dateFnsFormat = this.mapToDateFnsFormat(format);
-    return formatDateFns(date, dateFnsFormat, {
-      locale: locale ?? this.locale,
-    });
+    if (this.isValid(date)) {
+      const dateFnsFormat = this.mapToDateFnsFormat(format);
+      return formatDateFns(date, dateFnsFormat, {
+        locale: locale ?? this.locale,
+      });
+    }
+    return "";
   }
 
   /**
@@ -201,13 +205,16 @@ export class AdapterDateFns implements SaltDateAdapter<Date, Locale> {
         value,
       };
     }
+    const isDateDefined = !!value?.trim().length;
     return {
       date: parsedDate,
       value,
       errors: [
         {
-          message: "not a valid date",
-          type: DateDetailErrorEnum.INVALID_DATE,
+          message: isDateDefined ? "not a valid date" : "no date defined",
+          type: isDateDefined
+            ? DateDetailErrorEnum.INVALID_DATE
+            : DateDetailErrorEnum.UNSET,
         },
       ],
     };

diff --git a/packages/date-adapters/src/dayjs/index.ts b/packages/date-adapters/src/dayjs/index.ts
@@ -158,17 +158,21 @@ export class AdapterDayjs implements SaltDateAdapter<Dayjs, string> {
 
   /**
    * Formats a Day.js date object using the specified format string.
+   * Returns an empty string when null or undefined date is given.
    * @param date - The Day.js date object to format.
    * @param format - The format string to use.
    * @param locale - The locale to use for formatting.
    * @returns The formatted date string.
    */
   public format(
-    date: Dayjs,
+    date: Dayjs | null | undefined,
     format: RecommendedFormats = "DD MMM YYYY",
     locale?: string,
   ): string {
-    return date.locale(locale ?? this.locale).format(format);
+    if (this.isValid(date)) {
+      return date.locale(locale ?? this.locale).format(format);
+    }
+    return "";
   }
 
   /**
@@ -211,14 +215,16 @@ export class AdapterDayjs implements SaltDateAdapter<Dayjs, string> {
         value,
       };
     }
-
+    const isDateDefined = !!value?.trim().length;
     return {
       date: this.dayjs("Invalid Date"),
       value,
       errors: [
         {
-          message: "not a valid date",
-          type: DateDetailErrorEnum.INVALID_DATE,
+          message: isDateDefined ? "not a valid date" : "no date defined",
+          type: isDateDefined
+            ? DateDetailErrorEnum.INVALID_DATE
+            : DateDetailErrorEnum.UNSET,
         },
       ],
     };

diff --git a/packages/date-adapters/src/luxon/index.ts b/packages/date-adapters/src/luxon/index.ts
@@ -173,18 +173,22 @@ export class AdapterLuxon implements SaltDateAdapter<DateTime, string> {
 
   /**
    * Formats a Luxon DateTime object using the specified format string.
+   * Returns an empty string when null or undefined date is given.
    * @param date - The Luxon DateTime object to format.
    * @param format - The format string to use.
    * @param locale - The locale to use for formatting.
    * @returns The formatted date string.
    */
   public format(
-    date: DateTime,
+    date: DateTime | null | undefined,
     format: RecommendedFormats = "dd MMM yyyy",
     locale?: string,
   ): string {
-    const luxonFormat = this.mapToLuxonFormat(format);
-    return date.setLocale(locale ?? this.locale).toFormat(luxonFormat);
+    if (this.isValid(date)) {
+      const luxonFormat = this.mapToLuxonFormat(format);
+      return date.setLocale(locale ?? this.locale).toFormat(luxonFormat);
+    }
+    return "";
   }
 
   /**
@@ -222,13 +226,16 @@ export class AdapterLuxon implements SaltDateAdapter<DateTime, string> {
         value,
       };
     }
+    const isDateDefined = !!value?.trim().length;
     return {
       date: parsedDate,
       value,
       errors: [
         {
-          message: "not a valid date",
-          type: DateDetailErrorEnum.INVALID_DATE,
+          message: isDateDefined ? "not a valid date" : "no date defined",
+          type: isDateDefined
+            ? DateDetailErrorEnum.INVALID_DATE
+            : DateDetailErrorEnum.UNSET,
         },
       ],
     };

diff --git a/packages/date-adapters/src/moment/index.ts b/packages/date-adapters/src/moment/index.ts
@@ -149,20 +149,24 @@ export class AdapterMoment implements SaltDateAdapter<Moment, string> {
 
   /**
    * Formats a Moment.js date object using the specified format string.
+   * Returns an empty string when null or undefined date is given.
    * @param date - The Moment.js date object to format.
    * @param format - The format string to use.
    * @param locale - The locale to use for formatting.
    * @returns The formatted date string.
    */
   public format(
-    date: Moment,
+    date: Moment | null | undefined,
     format: RecommendedFormats = "DD MMM YYYY",
     locale?: string,
   ): string {
-    return date
-      .clone()
-      .locale(locale ?? this.locale)
-      .format(format);
+    if (this.isValid(date)) {
+      return date
+        .clone()
+        .locale(locale ?? this.locale)
+        .format(format);
+    }
+    return "";
   }
 
   /**
@@ -203,13 +207,16 @@ export class AdapterMoment implements SaltDateAdapter<Moment, string> {
         value,
       };
     }
+    const isDateDefined = !!value?.trim().length;
     return {
       date: parsedDate,
       value,
       errors: [
         {
-          message: "not a valid date",
-          type: DateDetailErrorEnum.INVALID_DATE,
+          message: isDateDefined ? "not a valid date" : "no date defined",
+          type: isDateDefined
+            ? DateDetailErrorEnum.INVALID_DATE
+            : DateDetailErrorEnum.UNSET,
         },
       ],
     };

diff --git a/packages/date-adapters/src/types.ts b/packages/date-adapters/src/types.ts
@@ -141,9 +141,13 @@ export interface SaltDateAdapter<
    * @param date - The date object to format.
    * @param format - The format string to use.
    * @param locale - The locale to use for formatting.
-   * @returns The formatted date string.
+   * Returns an empty string when null or undefined date is given.
    */
-  format(date: TDate, format?: RecommendedFormats, locale?: TLocale): string;
+  format(
+    date: TDate | null | undefined,
+    format?: RecommendedFormats,
+    locale?: TLocale,
+  ): string;
 
   /**
    * Compares two date objects.