Introduce new ISO Date scalars (#380)

* Introduce new ISO Date scalars

* Upgrade to Node 14

* Add mocks and missing exports

* Add Timestamp

* acknowledgement

* Add missing typeDef

Author: ardatan

.github/workflows/main.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node_version: [10, 12, 13]
+        node_version: [10, 12, 14]
     steps:
       - name: Checkout Master
         uses: actions/checkout@v1
@@ -38,7 +38,7 @@ jobs:
       - name: Use Node
         uses: actions/setup-node@v1
         with:
-          node-version: '13.x'
+          node-version: '14.x'
       - name: Install Dependencies using Yarn
         run: yarn install
       - name: Build

README.md

@@ -435,12 +435,63 @@ common in defining schemas or interfaces to data.
 
 ## The Types
 
+### Date
+
+A date string, such as 2007-12-03, compliant with the `full-date` format outlined in section 5.6 of the [RFC 3339](./rfc3339.txt) profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
+
+This scalar is a description of the date, as used for birthdays for example. It cannot represent an instant on the time-line.
+
+**Result Coercion**
+
+Javascript Date instances are coerced to an RFC 3339 compliant date string. Invalid Date instances raise a field error.
+
+**Input Coercion**
+
+When expected as an input type, only RFC 3339 compliant date strings are accepted. All other input values raise a query error indicating an incorrect type.
+
+### Time
+
+A time string at UTC, such as 10:15:30Z, compliant with the `full-time` format outlined in section 5.6 of the [RFC 3339](./rfc3339.txt) profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
+
+This scalar is a description of a time instant such as the opening bell of the New York Stock Exchange for example. It cannot represent an exact instant on the time-line.
+
+This scalar ignores leap seconds (thereby assuming that a minute constitutes of 59 seconds), in this respect it diverges from the RFC 3339 profile.
+
+Where an RFC 3339 compliant time string has a time-zone other than UTC, it is shifted to UTC. For example, the time string "14:10:20+01:00" is shifted to "13:10:20Z".
+
+**Result Coercion**
+
+Javascript Date instances are coerced to an RFC 3339 compliant time string by extracting the UTC time part. Invalid Date instances raise a field error.
+
+**Input Coercion**
+
+When expected as an input type, only RFC 3339 compliant time strings are accepted. All other input values raise a query error indicating an incorrect type.
+
 ### DateTime
 
-Use real JavaScript Dates for GraphQL fields. Currently you can use a String or an Int (e.g., a
-timestamp in milliseconds) to represent a date/time. This scalar makes it easy to be explicit about
-the type and have a real JavaScript Date returned that the client can use _without_ doing the
-inevitable parsing or conversion themselves.
+A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the `date-time` format outlined in section 5.6 of the [RFC 3339](./rfc3339.txt) profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
+
+This scalar is a description of an exact instant on the time-line such as the instant that a user account was created.
+
+This scalar ignores leap seconds (thereby assuming that a minute constitutes of 59 seconds). In this respect it diverges from the RFC 3339 profile.
+
+Where an RFC 3339 compliant date-time string has a time-zone other than UTC, it is shifted to UTC. For example, the date-time string "2016-01-01T14:10:20+01:00" is shifted to "2016-01-01T13:10:20Z".
+
+**Result Coercion**
+
+JavaScript Date instances and Unix timestamps (represented as 32-bit signed integers) are coerced to RFC 3339 compliant date-time strings. Invalid Date instances raise a field error.
+
+**Input Coercion**
+
+When expected as an input type, only RFC 3339 compliant date-time strings are accepted. All other input values raise a query error indicating an incorrect type.
+
+> Taken from [graphql-iso-date](https://github.com/excitement-engineer/graphql-iso-date/)
+
+### Timestamp
+
+The javascript `Date` as integer. Type represents date and time as number of milliseconds from start of UNIX epoch.
+
+> Taken from [GraphQLTimestamp.js](https://gist.github.com/langpavel/b30f3d507a47713b0c6e89016e4e9eb7)
 
 ### UtcOffset
 
@@ -534,7 +585,7 @@ The [GraphQL spec](https://facebook.github.io/graphql/#sec-Int) limits its Int t
 
 ```
 GraphQLError: Argument "num" has invalid value 9007199254740990.
-              Expected type "Int", found 9007199254740990.
+              Expected value of type ""Int"", found 9007199254740990.
 ```
 
 > Based on [graphql-bigint](https://github.com/stems/graphql-bigint)
@@ -597,18 +648,18 @@ A field whose value is an [ISO-4217 currency](https://en.wikipedia.org/wiki/ISO_
 
 The `JSON` scalar type represents JSON values as specified by [ECMA-404](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf).
 
-> Uses [graphql-type-json](https://github.com/taion/graphql-type-json)
+> Based on [graphql-type-json](https://github.com/taion/graphql-type-json)
 
 ### JSONObject
 
 The `JSONObject` scalar type represents JSON objects as specified by [ECMA-404](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf).
 
+> Based on [graphql-type-json](https://github.com/taion/graphql-type-json)
+
 ### Byte
 
 The `Byte` scalar type represents byte value as specified by [NodeJS Buffer type](https://nodejs.org/api/buffer.html)
 
-> Uses [graphql-type-json](https://github.com/taion/graphql-type-json)
-
 ### IBAN
 
 Includes IBAN specifications for the following countries:
@@ -747,3 +798,5 @@ It was created and maintained by the company `ok-grow`.
 We, The Guild, took over the maintaince of that library [later on](https://medium.com/the-guild/the-guild-is-taking-over-maintenance-of-merge-graphql-schemas-so-lets-talk-about-graphql-schema-46246557a225).
 
 We also like to say thank you to [@adriano-di-giovanni](https://github.com/adriano-di-giovanni) for being extremely generous and giving us the `graphql-scalars` name on npm which was previously owned by his own [library](https://github.com/adriano-di-giovanni/graphql-scalars).
+
+And thanks to [excitement-engineer](https://github.com/excitement-engineer) for [graphql-iso-date](https://github.com/excitement-engineer/graphql-iso-date), [stems](https://github.com/stems) for [graphql-bigint](https://github.com/stems/graphql-bigint), [taion](https://github.com/taion) for [graphql-type-json](https://github.com/taion/graphql-type-json), [langpavel](https://github.com/langpavel) for [GraphQLTimestamp.js](https://gist.github.com/langpavel/b30f3d507a47713b0c6e89016e4e9eb7)

bundle-test/package.json

@@ -10,7 +10,7 @@
   "bundlesize": [
     {
       "path": "./dist/index.js",
-      "maxSize": "98 kB",
+      "maxSize": "150 kB",
       "compression": "none"
     }
   ],

package.json

@@ -59,6 +59,7 @@
     "husky": "4.2.5",
     "jest": "26.0.1",
     "lint-staged": "10.2.11",
+    "mockdate": "3.0.2",
     "prettier": "2.0.5",
     "semver": "7.3.2",
     "ts-jest": "26.1.0",

src/index.ts

@@ -2,7 +2,10 @@ import * as resolvers from './resolvers';
 import * as mocks from './mocks';
 
 export {
+  Date as DateTypeDefinition,
+  Time as TimeTypeDefinition,
   DateTime as DateTimeTypeDefinition,
+  Timestamp as TimestampTypeDefinition,
   UtcOffset as UtcOffsetTypeDefinition,
   EmailAddress as EmailAddressTypeDefinition,
   NegativeFloat as NegativeFloatTypeDefinition,
@@ -45,7 +48,10 @@ export {
 export { default as typeDefs } from './typeDefs';
 
 export {
+  Date as DateResolver,
+  Time as TimeResolver,
   DateTime as DateTimeResolver,
+  Timestamp as TimestampResolver,
   UtcOffset as UtcOffsetResolver,
   EmailAddress as EmailAddressResolver,
   NegativeFloat as NegativeFloatResolver,
@@ -86,7 +92,10 @@ export {
 } from './resolvers';
 
 export {
+  Date as GraphQLDate,
+  Time as GraphQLTime,
   DateTime as GraphQLDateTime,
+  Timestamp as GraphQLTimestamp,
   UtcOffset as GraphQLUtcOffset,
   EmailAddress as GraphQLEmailAddress,
   NegativeFloat as GraphQLNegativeFloat,
@@ -129,7 +138,10 @@ export {
 export { resolvers };
 
 export {
+  Date as DateMock,
+  Time as TimeMock,
   DateTime as DateTimeMock,
+  Timestamp as TimestampMock,
   UtcOffset as UtcOffsetMock,
   EmailAddress as EmailAddressMock,
   NegativeFloat as NegativeFloatMock,

src/mocks.ts

@@ -1,6 +1,9 @@
 const BigIntMock = () => BigInt(Number.MAX_SAFE_INTEGER);
 const ByteMock = () => new Uint8Array([1988, 1981, 1965, 1963, 1959, 1955]);
-export const DateTime = () => new Date();
+const DateMock = () => '2007-12-03';
+export const Time = () => '10:15:30Z';
+export const DateTime = () => '2007-12-03T10:15:30Z';
+export const Timestamp = () => 1592577642;
 export const UtcOffset = () => '+03:00';
 export const EmailAddress = () => '[email protected]';
 export const NegativeFloat = () => -123.45;
@@ -83,6 +86,7 @@ export const IBAN = () => 'NL55INGB4789170233';
 export const Void = (): null => null;
 
 export {
+  DateMock as Date,
   URLMock as URL,
   NonNegativeInt as UnsignedInt,
   NonNegativeFloat as UnsignedFloat,

src/resolvers/DateTime.ts

@@ -0,0 +1,46 @@
+import { GraphQLScalarType, Kind, ValueNode } from 'graphql';
+
+// Taken from https://gist.github.com/langpavel/b30f3d507a47713b0c6e89016e4e9eb7
+
+function serializeDate(value: any) {
+  if (value instanceof Date) {
+    return value.getTime();
+  } else if (typeof value === 'number') {
+    return Math.trunc(value);
+  } else if (typeof value === 'string') {
+    return Date.parse(value);
+  }
+  return null;
+}
+
+function parseDate(value: any) {
+  if (value === null) {
+    return null;
+  }
+
+  try {
+    return new Date(value);
+  } catch (err) {
+    return null;
+  }
+}
+
+function parseDateFromLiteral(ast: ValueNode) {
+  if (ast.kind === Kind.INT) {
+    const num = parseInt(ast.value, 10);
+    return new Date(num);
+  } else if (ast.kind === Kind.STRING) {
+    return parseDate(ast.value);
+  }
+  return null;
+}
+
+export default new GraphQLScalarType({
+  name: 'Timestamp',
+  description:
+    'The javascript `Date` as integer. Type represents date and time ' +
+    'as number of milliseconds from start of UNIX epoch.',
+  serialize: serializeDate,
+  parseValue: parseDate,
+  parseLiteral: parseDateFromLiteral,
+});

src/resolvers/Timestamp.ts

@@ -1,4 +1,7 @@
-import DateTime from './DateTime';
+import Date from './iso-date/Date';
+import Time from './iso-date/Time';
+import DateTime from './iso-date/DateTime';
+import Timestamp from './Timestamp';
 import UtcOffset from './UtcOffset';
 import NonPositiveInt from './NonPositiveInt';
 import PositiveInt from './PositiveInt';
@@ -43,7 +46,10 @@ const NonNegativeFloatResolver = NonNegativeFloatFactory('NonNegativeFloat');
 const UnsignedFloatResolver = NonNegativeFloatFactory('UnsignedFloat');
 
 export {
+  Date,
+  Time,
   DateTime,
+  Timestamp,
   UtcOffset,
   NonPositiveInt,
   PositiveInt,