Date-time should validate timezone

Author: P0lip

src/formats.ts

@@ -106,6 +106,12 @@ export const fastFormats: DefinedFormats = {
   email: /^[a-z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?(?:\.[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?)*$/i,
 }
 
+export const strictFormats: Partial<DefinedFormats> = {
+  // date-time: http://tools.ietf.org/html/rfc3339#section-5.6
+  time: fmtDef(strict_time, compareTime),
+  "date-time": fmtDef(strict_date_time, compareDateTime),
+}
+
 export const formatNames = Object.keys(fullFormats) as FormatName[]
 
 function isLeapYear(year: number): boolean {
@@ -139,8 +145,11 @@ function compareDate(d1: string, d2: string): number | undefined {
 }
 
 const TIME = /^(\d\d):(\d\d):(\d\d)(\.\d+)?(z|[+-]\d\d(?::?\d\d)?)?$/i
+const PLUS_MINUS = /^[+-]/
+const TIMEZONE = /^[Zz]$/
+const ISO_8601_TIME = /^[+-](?:[01][0-9]|2[0-4])(?::?[0-5][0-9])?$/
 
-function time(str: string, withTimeZone?: boolean): boolean {
+function time(str: string, withTimeZone?: boolean, strict?: boolean): boolean {
   const matches: string[] | null = TIME.exec(str)
   if (!matches) return false
 
@@ -151,10 +160,19 @@ function time(str: string, withTimeZone?: boolean): boolean {
   return (
     ((hour <= 23 && minute <= 59 && second <= 59) ||
       (hour === 23 && minute === 59 && second === 60)) &&
-    (!withTimeZone || timeZone !== "")
+    (!withTimeZone ||
+      (strict
+        ? TIMEZONE.test(timeZone) ||
+          (PLUS_MINUS.test(timeZone) && time(timeZone.slice(1) + ":00")) ||
+          ISO_8601_TIME.test(timeZone)
+        : timeZone !== ""))
   )
 }
 
+function strict_time(str: string, withTimeZone?: boolean): boolean {
+  return time(str, withTimeZone, true)
+}
+
 function compareTime(t1: string, t2: string): number | undefined {
   if (!(t1 && t2)) return undefined
   const a1 = TIME.exec(t1)
@@ -174,6 +192,11 @@ function date_time(str: string): boolean {
   return dateTime.length === 2 && date(dateTime[0]) && time(dateTime[1], true)
 }
 
+function strict_date_time(str: string): boolean {
+  const dateTime: string[] = str.split(DATE_TIME_SEPARATOR)
+  return dateTime.length === 2 && date(dateTime[0]) && strict_time(dateTime[1], true)
+}
+
 function compareDateTime(dt1: string, dt2: string): number | undefined {
   if (!(dt1 && dt2)) return undefined
   const [d1, t1] = dt1.split(DATE_TIME_SEPARATOR)

src/index.ts

@@ -5,6 +5,7 @@ import {
   formatNames,
   fastFormats,
   fullFormats,
+  strictFormats,
 } from "./formats"
 import formatLimit from "./limit"
 import type Ajv from "ajv"
@@ -17,6 +18,7 @@ export interface FormatOptions {
   mode?: FormatMode
   formats?: FormatName[]
   keywords?: boolean
+  strictDate?: boolean
 }
 
 export type FormatsPluginOptions = FormatName[] | FormatOptions
@@ -30,7 +32,7 @@ const fastName = new Name("fastFormats")
 
 const formatsPlugin: FormatsPlugin = (
   ajv: Ajv,
-  opts: FormatsPluginOptions = {keywords: true}
+  opts: FormatsPluginOptions = {keywords: true, strictDate: false}
 ): Ajv => {
   if (Array.isArray(opts)) {
     addFormats(ajv, opts, fullFormats, fullName)
@@ -39,7 +41,7 @@ const formatsPlugin: FormatsPlugin = (
   const [formats, exportName] =
     opts.mode === "fast" ? [fastFormats, fastName] : [fullFormats, fullName]
   const list = opts.formats || formatNames
-  addFormats(ajv, list, formats, exportName)
+  addFormats(ajv, list, opts.strictDate ? {...formats, ...strictFormats} : formats, exportName)
   if (opts.keywords) formatLimit(ajv)
   return ajv
 }

tests/strictDate.spec.ts

@@ -0,0 +1,43 @@
+import Ajv from "ajv"
+import addFormats from "../dist"
+
+const ajv = new Ajv({$data: true, strictTypes: false, formats: {allowedUnknown: true}})
+addFormats(ajv, {strictDate: true})
+
+describe("strictDate option", () => {
+  it("a valid date-time string with time offset", () => {
+    expect(
+      ajv.validate(
+        {
+          type: "string",
+          format: "date-time",
+        },
+        "2020-06-19T12:13:14+05:00"
+      )
+    ).toBe(true)
+  })
+
+  it("an invalid date-time string (no time offset)", () => {
+    expect(
+      ajv.validate(
+        {
+          type: "string",
+          format: "date-time",
+        },
+        "2020-06-19T12:13:14"
+      )
+    ).toBe(false)
+  })
+
+  it("an invalid date-time string (invalid time offset)", () => {
+    expect(
+      ajv.validate(
+        {
+          type: "string",
+          format: "date-time",
+        },
+        "2020-06-19T12:13:14+26:00"
+      )
+    ).toBe(false)
+  })
+})