Merge pull request #25 from storyofams/feat/parse-date-pipe

[feat] parse date pipe

Author: leeuwis

lib/e2e.test.ts

@@ -7,6 +7,7 @@ import { createHandler } from './createHandler';
 import { Body, Delete, Get, Header, HttpCode, Post, Put, Query, Req, Res, Response, SetHeader } from './decorators';
 import { ValidationPipe } from './pipes';
 import { ParseBooleanPipe } from './pipes/parseBoolean.pipe';
+import { ParseDatePipe } from './pipes/parseDate.pipe';
 import { ParseNumberPipe } from './pipes/parseNumber.pipe';
 
 enum CreateSource {
@@ -49,9 +50,18 @@ class TestHandler {
     @Header('Content-Type') contentType: string,
     @Query('id') id: string,
     @Query('step', ParseNumberPipe({ nullable: false })) step: number,
-    @Query('redirect', ParseBooleanPipe) redirect: boolean
+    @Query('redirect', ParseBooleanPipe) redirect: boolean,
+    @Query('startAt', ParseDatePipe) startAt: Date
   ) {
-    return { contentType, id, step, redirect, test: this.testField };
+    return {
+      contentType,
+      id,
+      step,
+      redirect,
+      test: this.testField,
+      startAt,
+      isStartAtDateInstance: startAt instanceof Date
+    };
   }
 
   @HttpCode(201)
@@ -94,7 +104,7 @@ describe('E2E', () => {
 
   it('read', () =>
     request(server)
-      .get('/?id=my-id&step=1&redirect=true')
+      .get('/?id=my-id&step=1&redirect=true&startAt=2021-01-01T22:00:00')
       .set('Content-Type', 'application/json')
       .expect(200)
       .then(res =>
@@ -108,7 +118,8 @@ describe('E2E', () => {
             contentType: 'application/json',
             id: 'my-id',
             step: 1,
-            redirect: true
+            redirect: true,
+            isStartAtDateInstance: true
           }
         })
       ));

lib/pipes/parseDate.pipe.spec.ts

@@ -0,0 +1,36 @@
+import { ParseDatePipe } from './parseDate.pipe';
+
+describe('ParseDatePipe', () => {
+  it('Should parse the given date', () => {
+    const parsed = ParseDatePipe()('2021-01-01');
+    expect(parsed).toBeInstanceOf(Date);
+    expect(parsed).toEqual(new Date('2021-01-01'));
+  });
+
+  it('Should parse the given date and time string with spaces in between.', () => {
+    const parsed = ParseDatePipe()('2021-01-01 20:00:00');
+    expect(parsed).toBeInstanceOf(Date);
+    expect(parsed).toEqual(new Date('2021-01-01T20:00:00'));
+  });
+
+  it('Should parse the given date and time string with T in between.', () => {
+    const parsed = ParseDatePipe()('2021-01-01T20:00:00');
+    expect(parsed).toBeInstanceOf(Date);
+    expect(parsed).toEqual(new Date('2021-01-01T20:00:00'));
+  });
+
+  it('Should throw when then given value is not a string.', () => expect(() => ParseDatePipe()(1)).toThrow());
+
+  it('Should pass for partial date (year and month).', () =>
+    expect(ParseDatePipe()('2021-01')).toEqual(new Date('2021-01-01')));
+
+  it('Should throw for non-existing date.', () => expect(() => ParseDatePipe()('2021-02-31')).toThrow());
+
+  it('Should throw when the given value is string `null`.', () => {
+    expect(() => ParseDatePipe()('null')).toThrow();
+  });
+
+  it('Should throw when the given value is `null`.', () => {
+    expect(() => ParseDatePipe()(null)).toThrow();
+  });
+});

lib/pipes/parseDate.pipe.ts

@@ -0,0 +1,54 @@
+import { BadRequestException } from '../exceptions';
+import type { PipeMetadata, PipeOptions } from './ParameterPipe';
+import { validatePipeOptions } from './validatePipeOptions';
+
+// The following variables and functions are taken from the validator.js (https://github.com/validatorjs/validator.js/blob/master/src/lib/isISO8601.js)
+
+// from http://goo.gl/0ejHHW
+const iso8601 = /^([+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-3])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24:?00)([.,]\d+(?!:))?)?(\17[0-5]\d([.,]\d+)?)?([zZ]|([+-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?$/;
+// same as above, except with a strict 'T' separator between date and time
+const iso8601StrictSeparator = /^([+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-3])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T]((([01]\d|2[0-3])((:?)[0-5]\d)?|24:?00)([.,]\d+(?!:))?)?(\17[0-5]\d([.,]\d+)?)?([zZ]|([+-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?$/;
+
+const isValidDate = (str: string) => {
+  // str must have passed the ISO8601 check
+  // this check is meant to catch invalid dates
+  // like 2009-02-31
+  const match = (str.match(/(\d{4})-?(\d{0,2})-?(\d*)/) ?? []).map(Number);
+  const year = match[1];
+  const month = match[2];
+  const day = match[3];
+  const monthString = month ? `0${month}`.slice(-2) : month;
+  const dayString = day ? `0${day}`.slice(-2) : day;
+
+  // create a date object and compare
+  const d = new Date(`${year}-${monthString || '01'}-${dayString || '01'}`);
+  if (month && day) {
+    return d.getUTCFullYear() === year && d.getUTCMonth() + 1 === month && d.getUTCDate() === day;
+  }
+
+  return true;
+};
+
+function isISO8601(str: string, options: { strictSeparator?: boolean; strict?: boolean } = {}) {
+  const check = options.strictSeparator ? iso8601StrictSeparator.test(str) : iso8601.test(str);
+
+  if (check && options.strict) {
+    return isValidDate(str);
+  }
+
+  return check;
+}
+
+export function ParseDatePipe(options?: PipeOptions) {
+  return (value: any, metadata?: PipeMetadata) => {
+    validatePipeOptions(value, metadata?.name, options);
+
+    if (value && !isISO8601(value, { strict: true })) {
+      throw new BadRequestException(
+        `Validation failed${metadata?.name ? ` for ${metadata.name}` : ''} (date string is expected)`
+      );
+    }
+
+    return new Date(value);
+  };
+}