Use GraphQL Scalars

Author: ardatan

packages/openapi-to-graphql/package.json

@@ -85,8 +85,8 @@
     "debug": "^4.2.0",
     "deep-equal": "^2.0.5",
     "form-urlencoded": "^6.0.4",
+    "graphql-scalars": "^1.10.0",
     "graphql-subscriptions": "^1.1.0",
-    "graphql-type-json": "^0.3.2",
     "json-ptr": "^1.3.1",
     "jsonpath-plus": "^4.0.0",
     "oas-validator": "^5.0.2",

packages/openapi-to-graphql/src/oas_3_tools.ts

@@ -471,12 +471,8 @@ export function getSchemaTargetGraphQLType<TSource, TContext, TArgs>(
 
   // Special edge cases involving the schema format
   if (typeof schema.format === 'string') {
-    /**
-     * CASE: 64 bit int - return number instead of integer, leading to use of
-     * GraphQLFloat, which can support 64 bits:
-     */
     if (schema.type === 'integer' && schema.format === 'int64') {
-      return TargetGraphQLType.float
+      return TargetGraphQLType.bigint
 
       // CASE: id
     } else if (

packages/openapi-to-graphql/src/schema_builder.ts

@@ -38,7 +38,7 @@ import {
 } from 'graphql'
 
 // Imports:
-import GraphQLJSON from 'graphql-type-json'
+import { GraphQLBigInt, GraphQLJSON } from 'graphql-scalars'
 import * as Oas3Tools from './oas_3_tools'
 import { getResolver, OPENAPI_TO_GRAPHQL } from './resolver_builder'
 import { createDataDef } from './preprocessor'
@@ -218,6 +218,10 @@ export function getGraphQLType<TSource, TContext, TArgs>({
     case TargetGraphQLType.json:
       def.graphQLType = CleanGraphQLJSON
       return def.graphQLType
+
+    case TargetGraphQLType.bigint:
+      def.graphQLType = GraphQLBigInt
+      return def.graphQLType
   }
 }
 

packages/openapi-to-graphql/src/types/operation.ts

@@ -37,6 +37,7 @@ export enum TargetGraphQLType {
   float = 'float',
   boolean = 'boolean',
   id = 'id',
+  bigint = 'bigint',
 
   // JSON
   json = 'json',

packages/openapi-to-graphql/test/example_api.test.ts

@@ -635,7 +635,7 @@ test('Ensure good naming for operations with duplicated schemas', () => {
  * CASE: 64 bit int - return number instead of integer, leading to use of
  * GraphQLFloat, which can support 64 bits:
  */
-test('Get response containing 64-bit integer (using GraphQLFloat)', () => {
+test('Get response containing 64-bit integer (using GraphQLBigInt)', () => {
   const query = `{
     productReviews (id: "100") {
       timestamp
@@ -646,8 +646,8 @@ test('Get response containing 64-bit integer (using GraphQLFloat)', () => {
     expect(result).toEqual({
       data: {
         productReviews: [
-          { timestamp: 1502787600000000 },
-          { timestamp: 1502787400000000 }
+          { timestamp: BigInt('1502787600000000') },
+          { timestamp: BigInt('1502787400000000') }
         ]
       }
     })

yarn.lock

@@ -3028,6 +3028,13 @@ graphql-redis-subscriptions@^2.0.0:
   optionalDependencies:
     ioredis "^4.17.3"
 
+graphql-scalars@^1.10.0:
+  version "1.10.0"
+  resolved "https://registry.yarnpkg.com/graphql-scalars/-/graphql-scalars-1.10.0.tgz#9daf9252b16e6fae553a06976163a23f41b65dfd"
+  integrity sha512-LONlj8FfhA2iGpkZJWf5e4PVAHXxnZEHSOEvowLYvNXl/TNnhIck8VmE+lren/aa6GKrG+lZufo5lgnyjxcF6g==
+  dependencies:
+    tslib "~2.2.0"
+
 graphql-subscriptions@^0.4.2:
   version "0.4.4"
   resolved "https://registry.yarnpkg.com/graphql-subscriptions/-/graphql-subscriptions-0.4.4.tgz#39cff32d08dd3c990113864bab77154403727e9b"
@@ -3044,11 +3051,6 @@ graphql-subscriptions@^1.1.0:
   dependencies:
     iterall "^1.3.0"
 
-graphql-type-json@^0.3.2:
-  version "0.3.2"
-  resolved "https://registry.yarnpkg.com/graphql-type-json/-/graphql-type-json-0.3.2.tgz#f53a851dbfe07bd1c8157d24150064baab41e115"
-  integrity sha512-J+vjof74oMlCWXSvt0DOf2APEdZOCdubEvGDUAlqH//VBYcOYsGgRW7Xzorr44LvkjiuvecWc8fChxuZZbChtg==
-
 graphql@*, graphql@^15.3.0:
   version "15.5.1"
   resolved "https://registry.yarnpkg.com/graphql/-/graphql-15.5.1.tgz#f2f84415d8985e7b84731e7f3536f8bb9d383aad"
@@ -6629,6 +6631,11 @@ tslib@^2.0.0, tslib@^2.0.3, tslib@^2.3.0:
   resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.3.0.tgz#803b8cdab3e12ba581a4ca41c8839bbb0dacb09e"
   integrity sha512-N82ooyxVNm6h1riLCoyS9e3fuJ3AMG2zIZs2Gd1ATcSFjSA23Q0fzjjZeh0jbJvWVDZ0cJT8yaNNaaXHzueNjg==
 
+tslib@~2.2.0:
+  version "2.2.0"
+  resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.2.0.tgz#fb2c475977e35e241311ede2693cee1ec6698f5c"
+  integrity sha512-gS9GVHRU+RGn5KQM2rllAlR3dU6m7AcpJKdtH8gFvQiC4Otgk98XnmMU+nZenHt/+VhnBPWwgrJsyrdcw6i23w==
+
 tslint-config-standard@^9.0.0:
   version "9.0.0"
   resolved "https://registry.yarnpkg.com/tslint-config-standard/-/tslint-config-standard-9.0.0.tgz#349a94819d93d5f8d803e3c71cb58ef38eff88e0"