feat(core utils): Add is_iso_date_time method to check for valid ISO 8601 date/time strings.

Author: thet

src/core/utils.js

@@ -576,7 +576,7 @@ const ensureArray = (it, force_array) => {
 
 const localized_isodate = (date) => {
     // Return a iso date (date only) in the current timezone instead of a
-    // UTC ISO 8602 date+time component which toISOString returns.
+    // UTC ISO 8601 date+time component which toISOString returns.
 
     const day = date.getDate().toString().padStart(2, "0");
     const month = (date.getMonth() + 1).toString().padStart(2, "0");
@@ -628,6 +628,20 @@ const unescape_html = (escaped_html) => {
         .replace(/"/g, '"');
 };
 
+/**
+ * Return true, if the given value is a valid ISO 8601 date/time string with or without an optional time component.
+ *
+ * @param {String} value - The date/time value to be checked.
+ * @param {Boolean} [optional_time=false] - True, if time component is optional.
+ * @return {Boolean} - True, if the given value is a valid Date string. False if not.
+ */
+const is_iso_date_time = (value, optional_time = false) => {
+    const re_date_time = optional_time
+        ? /^\d{4}-[01]\d-[0-3]\d(T[0-2]\d:[0-5]\d)?$/
+        : /^\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d$/;
+    return re_date_time.test(value);
+};
+
 var utils = {
     // pattern pimping - own module?
     jqueryPlugin: jqueryPlugin,
@@ -658,6 +672,7 @@ var utils = {
     localized_isodate: localized_isodate,
     escape_html: escape_html,
     unescape_html: unescape_html,
+    is_iso_date_time: is_iso_date_time,
     getCSSValue: dom.get_css_value, // BBB: moved to dom. TODO: Remove in upcoming version.
 };
 

src/core/utils.test.js

@@ -721,3 +721,31 @@ describe("escape/unescape html ...", function () {
         expect(utils.unescape_html(undefined)).toBe("");
     });
 });
+
+describe("is_iso_date_time ...", function () {
+    it("detects valid date/time objects", () => {
+        expect(utils.is_iso_date_time("2022-05-04T21:00")).toBe(true);
+
+        // We actually do not strictly check for a valid datetime, just if the
+        // format is correct.
+        expect(utils.is_iso_date_time("2222-19-39T29:59")).toBe(true);
+
+        // But some basic constraints are in place
+        expect(utils.is_iso_date_time("2222-20-40T30:60")).toBe(false);
+
+        // And this is for sure no valid date/time
+        expect(utils.is_iso_date_time("not2-ok-40T30:60")).toBe(false);
+
+        // Also, the time component cannot be left out
+        expect(utils.is_iso_date_time("2022-05-04")).toBe(false);
+
+        // Not even partially.
+        expect(utils.is_iso_date_time("2022-05-04T21")).toBe(false);
+
+        // Unless we set optional_time to true.
+        expect(utils.is_iso_date_time("2022-05-04", true)).toBe(true);
+
+        // But still, partial time component does not pass.
+        expect(utils.is_iso_date_time("2022-05-04T21", true)).toBe(false);
+    });
+});