Merge pull request #72 from charlypoly/newhouse/38/support-id-scalar

.gitignore

@@ -51,7 +51,8 @@ typings/
 # Output of 'npm pack'
 *.tgz
 
-# Yarn Integrity file
+# Yarn stuff
+yarn.lock
 .yarn-integrity
 
 # dotenv environment variables file

README.md

@@ -28,7 +28,10 @@ const options = {
   // Defaults to `false` for backwards compatibility, but in future versions
   // the effect of `true` is likely going to be the default and only way. It is
   // highly recommended that new implementations set this value to `true`.
-  nullableArrayItems: true
+  nullableArrayItems: true,
+  // Indicates how to define the `ID` scalar as part of a JSON Schema. Valid options
+  // are `string`, `number`, or `both`. Defaults to `string`
+  idTypeMapping: 'string'
 }
 
 // schema is your GraphQL schema.
@@ -43,7 +46,7 @@ const jsonSchema = fromIntrospectionQuery(introspection, options);
 
 ```graphql
   type Todo {
-      id: String!
+      id: ID!
       name: String!
       completed: Boolean
       color: Color
@@ -55,7 +58,7 @@ const jsonSchema = fromIntrospectionQuery(introspection, options);
   }
 
   type SimpleTodo {
-    id: String!
+    id: ID!
     name: String!
   }
 
@@ -77,7 +80,7 @@ const jsonSchema = fromIntrospectionQuery(introspection, options);
   type Query {
       "A Query with 1 required argument and 1 optional argument"
       todo(
-        id: String!,
+        id: ID!,
         "A default value of false"
         isCompleted: Boolean=false
       ): Todo
@@ -97,7 +100,7 @@ const jsonSchema = fromIntrospectionQuery(introspection, options);
 
       "A Mutation with 2 required arguments"
       update_todo(
-        id: String!,
+        id: ID!,
         data: TodoInputType!
       ): Todo!
 
@@ -129,7 +132,7 @@ const options = { nullableArrayItems: true }
             arguments: {
               type: 'object',
               properties: {
-                id: { '$ref': '#/definitions/String' },
+                id: { '$ref': '#/definitions/ID' },
                 isCompleted: {
                   description: 'A default value of false',
                   '$ref': '#/definitions/Boolean',
@@ -192,7 +195,7 @@ const options = { nullableArrayItems: true }
             arguments: {
               type: 'object',
               properties: {
-                id: { '$ref': '#/definitions/String' },
+                id: { '$ref': '#/definitions/ID' },
                 data: { '$ref': '#/definitions/TodoInputType' }
               },
               required: [ 'id', 'data' ]
@@ -235,7 +238,7 @@ const options = { nullableArrayItems: true }
         id: {
           type: 'object',
           properties: {
-            return: { '$ref': '#/definitions/String' },
+            return: { '$ref': '#/definitions/ID' },
             arguments: { type: 'object', properties: {}, required: [] }
           },
           required: []
@@ -285,13 +288,18 @@ const options = { nullableArrayItems: true }
       },
       required: [ 'id', 'name', 'colors' ]
     },
+    ID: {
+      description: 'The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"4"`) or integer (such as `4`) input value will be accepted as an ID.',
+      type: 'string',
+      title: 'ID'
+    },
     SimpleTodo: {
       type: 'object',
       properties: {
         id: {
           type: 'object',
           properties: {
-            return: { '$ref': '#/definitions/String' },
+            return: { '$ref': '#/definitions/ID' },
             arguments: { type: 'object', properties: {}, required: [] }
           },
           required: []

__tests__/spec.ts

@@ -1,10 +1,13 @@
 import ajv from 'ajv'
 import { JSONSchema6 } from 'json-schema'
 import { fromIntrospectionQuery } from '../lib/fromIntrospectionQuery'
+import type { IDTypeMapping as IDTypeMappingType } from '../lib/types'
 import {
   getTodoSchemaIntrospection,
   todoSchemaAsJsonSchema,
   todoSchemaAsJsonSchemaWithoutNullableArrayItems,
+  todoSchemaAsJsonSchemaWithIdTypeNumber,
+  todoSchemaAsJsonSchemaWithIdTypeStringOrNumber,
 } from '../test-utils'
 
 describe('GraphQL to JSON Schema', () => {
@@ -30,4 +33,30 @@ describe('GraphQL to JSON Schema', () => {
     validator.addMetaSchema(require('ajv/lib/refs/json-schema-draft-06.json'))
     expect(validator.validateSchema(result)).toBe(true)
   })
+
+  test('from IntrospectionQuery object with idTypeMapping = "number"', () => {
+    const options = {
+      nullableArrayItems: true,
+      idTypeMapping: 'number' as IDTypeMappingType,
+    }
+    const result = fromIntrospectionQuery(introspection, options)
+    expect(result).toEqual(<JSONSchema6>todoSchemaAsJsonSchemaWithIdTypeNumber)
+    const validator = new ajv()
+    validator.addMetaSchema(require('ajv/lib/refs/json-schema-draft-06.json'))
+    expect(validator.validateSchema(result)).toBe(true)
+  })
+
+  test('from IntrospectionQuery object with idTypeMapping = "both"', () => {
+    const options = {
+      nullableArrayItems: true,
+      idTypeMapping: 'both' as IDTypeMappingType,
+    }
+    const result = fromIntrospectionQuery(introspection, options)
+    expect(result).toEqual(
+      <JSONSchema6>todoSchemaAsJsonSchemaWithIdTypeStringOrNumber
+    )
+    const validator = new ajv()
+    validator.addMetaSchema(require('ajv/lib/refs/json-schema-draft-06.json'))
+    expect(validator.validateSchema(result)).toBe(true)
+  })
 })

doc-exampleGenerator.ts

@@ -14,7 +14,7 @@ const nativeScalarsToFilter = ['String', 'Int', 'Boolean']
 
 const readmeSDL: string = `
   type Todo {
-      id: String!
+      id: ID!
       name: String!
       completed: Boolean
       color: Color
@@ -26,7 +26,7 @@ const readmeSDL: string = `
   }
 
   type SimpleTodo {
-    id: String!
+    id: ID!
     name: String!
   }
 
@@ -48,7 +48,7 @@ const readmeSDL: string = `
   type Query {
       "A Query with 1 required argument and 1 optional argument"
       todo(
-        id: String!,
+        id: ID!,
         "A default value of false"
         isCompleted: Boolean=false
       ): Todo
@@ -68,7 +68,7 @@ const readmeSDL: string = `
 
       "A Mutation with 2 required arguments"
       update_todo(
-        id: String!,
+        id: ID!,
         data: TodoInputType!
       ): Todo!
 

lib/fromIntrospectionQuery.ts

@@ -2,7 +2,13 @@ import { IntrospectionQuery, IntrospectionType } from 'graphql'
 import { JSONSchema6 } from 'json-schema'
 import { includes, partition, reduce } from 'lodash'
 import { introspectionTypeReducer, JSONSchema6Acc } from './reducer'
-import { filterDefinitionsTypes, isIntrospectionObjectType } from './typeGuards'
+import {
+  ID_TYPE_MAPPING_OPTION_DEFAULT,
+  filterDefinitionsTypes,
+  isIntrospectionObjectType,
+} from './typeGuards'
+
+import type { IDTypeMapping as IDTypeMappingType } from './types'
 
 // FIXME: finish this type
 export interface GraphQLJSONSchema6 extends JSONSchema6 {
@@ -16,6 +22,7 @@ export interface GraphQLJSONSchema6 extends JSONSchema6 {
 export interface FromIntrospectionQueryOptions {
   ignoreInternals?: boolean
   nullableArrayItems?: boolean
+  idTypeMapping?: IDTypeMappingType
 }
 
 export const fromIntrospectionQuery = (
@@ -26,6 +33,7 @@ export const fromIntrospectionQuery = (
     // Defaults
     ignoreInternals: true,
     nullableArrayItems: false,
+    idTypeMapping: ID_TYPE_MAPPING_OPTION_DEFAULT,
     // User-specified
     ...(opts || {}),
   }

lib/reducer.ts

@@ -20,14 +20,20 @@ import {
   isIntrospectionScalarType,
   isIntrospectionDefaultScalarType,
 } from './typeGuards'
-import { graphqlToJSONType, typesMapping } from './typesMapping'
+import { graphqlToJSONType, scalarToJsonType } from './typesMapping'
+
+import type {
+  GraphQLTypeNames,
+  IDTypeMapping as IDTypeMappingType,
+} from './types'
 
 export type JSONSchema6Acc = {
   [k: string]: JSONSchema6
 }
 
 type ReducerOptions = {
   nullableArrayItems?: boolean
+  idTypeMapping?: IDTypeMappingType
 }
 
 type GetRequiredFieldsType = ReadonlyArray<
@@ -199,7 +205,7 @@ export const introspectionTypeReducer: (
     }
   } else if (isIntrospectionDefaultScalarType(curr)) {
     acc[curr.name] = {
-      type: (typesMapping as any)[curr.name],
+      type: scalarToJsonType(curr.name as GraphQLTypeNames, options),
       title: curr.name,
     }
   } else if (isIntrospectionScalarType(curr)) {

lib/typeGuards.ts

@@ -19,14 +19,24 @@ import {
 } from 'graphql'
 import { filter, has, startsWith, includes } from 'lodash'
 
-export const SUPPORTED_KINDS = [
+export { ID_TYPE_MAPPING_OPTION_DEFAULT } from './typesMapping'
+
+export const SUPPORTED_SCALARS = Object.freeze([
+  'Boolean',
+  'String',
+  'Int',
+  'Float',
+  'ID',
+])
+
+export const SUPPORTED_KINDS = Object.freeze([
   TypeKind.SCALAR,
   TypeKind.OBJECT,
   TypeKind.INPUT_OBJECT,
   TypeKind.INTERFACE,
   TypeKind.ENUM,
   TypeKind.UNION,
-]
+])
 
 ///////////////////
 /// Type guards ///
@@ -81,8 +91,7 @@ export const isIntrospectionUnionType = (
 export const isIntrospectionDefaultScalarType = (
   type: IntrospectionSchema['types'][0]
 ): type is IntrospectionScalarType =>
-  type.kind === TypeKind.SCALAR &&
-  includes(['Boolean', 'String', 'Int', 'Float'], type.name)
+  type.kind === TypeKind.SCALAR && includes(SUPPORTED_SCALARS, type.name)
 
 // Ignore all GraphQL native Scalars, directives, etc...
 export interface FilterDefinitionsTypesOptions {

lib/types.ts

@@ -0,0 +1,2 @@
+export type GraphQLTypeNames = 'String' | 'Int' | 'Float' | 'Boolean' | 'ID'
+export type IDTypeMapping = 'string' | 'number' | 'both'

lib/typesMapping.ts

@@ -14,16 +14,36 @@ import {
   isNonNullIntrospectionType,
 } from './typeGuards'
 
-export type GraphQLTypeNames = 'String' | 'Int' | 'Float' | 'Boolean' | 'ID'
+import { GraphQLTypeNames, IDTypeMapping as IDTypeMappingType } from './types'
 
-export const typesMapping: { [k in GraphQLTypeNames]: JSONSchema6TypeName } = {
+export const ID_TYPE_MAPPING_OPTION_DEFAULT = 'string' as IDTypeMappingType
+
+const ID_TYPES: {
+  [k in IDTypeMappingType]: JSONSchema6TypeName | JSONSchema6TypeName[]
+} = {
+  string: 'string',
+  number: 'number',
+  both: ['string', 'number'],
+}
+
+const SCALAR_TO_JSON: {
+  [k in GraphQLTypeNames]: JSONSchema6TypeName | JSONSchema6TypeName[]
+} = {
   Boolean: 'boolean',
   String: 'string',
   Int: 'number',
   Float: 'number',
-  ID: 'string',
+  ID: ID_TYPES[ID_TYPE_MAPPING_OPTION_DEFAULT],
 }
 
+export const scalarToJsonType = (
+  scalarName: GraphQLTypeNames,
+  options: GraphqlToJSONTypeOptions = {}
+): JSONSchema6TypeName | JSONSchema6TypeName[] =>
+  Object.assign({}, SCALAR_TO_JSON, {
+    ID: ID_TYPES[options.idTypeMapping || ID_TYPE_MAPPING_OPTION_DEFAULT],
+  })[scalarName]
+
 // Convert a GraphQL Type to a valid JSON Schema type
 export type GraphqlToJSONTypeArg =
   | IntrospectionTypeRef
@@ -34,6 +54,7 @@ export type GraphqlToJSONTypeOptions = {
   nullableArrayItems?: boolean
   isArray?: boolean
   isNonNull?: boolean
+  idTypeMapping?: IDTypeMappingType
 }
 
 export const graphqlToJSONType = (
@@ -59,7 +80,7 @@ export const graphqlToJSONType = (
     if (includes(SUPPORTED_KINDS, k.kind)) {
       jsonType.$ref = `#/definitions/${name}`
     } else {
-      jsonType.type = (typesMapping as any)[name]
+      jsonType.type = scalarToJsonType(name as GraphQLTypeNames, options)
     }
 
     // Only if the option allows for it, represent an array with nullable items