improv(client): Return JsonValue type

Related prisma/prisma-client-js#691
prisma · May 29, 2020 · bf4426e · bf4426e
1 parent 878bae6
commit bf4426e
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 2 deletions.
diff --git a/src/packages/client/src/generation/TSClient.ts b/src/packages/client/src/generation/TSClient.ts
@@ -140,6 +140,25 @@ export declare const prismaVersion: PrismaVersion
  * Utility Types
  */
 
+/**
+ * From https://github.com/sindresorhus/type-fest/
+ * Matches a JSON object.
+ * This type can be useful to enforce some input to be JSON-compatible or as a super-type to be extended from. 
+ */
+declare type JsonObject = {[Key in string]?: JsonValue}
+ 
+/**
+ * From https://github.com/sindresorhus/type-fest/
+ * Matches a JSON array.
+ */
+declare interface JsonArray extends Array<JsonValue> {}
+ 
+/**
+ * From https://github.com/sindresorhus/type-fest/
+ * Matches any valid JSON value.
+ */
+declare type JsonValue = string | number | boolean | null | JsonObject | JsonArray
+ 
 declare type SelectAndInclude = {
   select: any
   include: any
@@ -153,7 +172,6 @@ declare type HasInclude = {
   include: any
 }
 
-
 declare type CheckSelect<T, S, U> = T extends SelectAndInclude
   ? 'Please either choose \`select\` or \`include\`'
   : T extends HasSelect

diff --git a/src/packages/client/src/runtime/utils/common.ts b/src/packages/client/src/runtime/utils/common.ts
@@ -45,7 +45,7 @@ export const GraphQLScalarToJSTypeTable = {
   DateTime: ['Date', 'string'],
   ID: 'string',
   UUID: 'string',
-  Json: 'object',
+  Json: 'JsonValue',
 }
 
 export const JSTypeToGraphQLType = {