feat: Generate JSON scalar type

Author: unlight

README.md

@@ -39,6 +39,8 @@ npx prisma generate
 
 -   https://ts-ast-viewer.com/
 -   https://github.com/unlight/nestjs-graphql-prisma-realworld-example-app
+-   https://www.prisma.io/docs/reference/tools-and-interfaces/prisma-schema/data-model
+-   JSON type for the code first approach - https://github.com/nestjs/graphql/issues/111#issuecomment-631452899
 
 ## Todo
 

package.json

@@ -4,6 +4,7 @@
   "license": "MIT",
   "description": "Generate object types, inputs, args, etc. from prisma schema file for usage with @nestjs/graphql module",
   "main": "index.js",
+  "bin": "index.js",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/unlight/nestjs-graphql-prisma.git"
@@ -33,8 +34,7 @@
     "eslint:w": "watchexec -w src \"npm run eslint\"",
     "eslint": "node node_modules/eslint/bin/eslint \"src/**/*.{ts,tsx}\"",
     "lint:fix": "npm run eslint -- --fix",
-    "build": "sh Taskfile build",
-    "bundle": "sh Taskfile bundle",
+    "build": "sh Taskfile bundle",
     "prisma:g": "node node_modules/@prisma/cli/build/index.js generate",
     "unused": "no-unused-export \"src/**/*.ts\"",
     "prettier:format": "npx prettier src --write"
@@ -85,6 +85,7 @@
     "eslint-plugin-unicorn": "^21.0.0",
     "eslint-plugin-wix-editor": "^3.2.0",
     "git-branch-is": "^4.0.0",
+    "graphql-type-json": "^0.3.2",
     "husky": "^4.2.5",
     "mocha": "^8.1.1",
     "no-unused-export": "^1.12.2",

src/generate-model.spec.ts

@@ -1,5 +1,12 @@
 import assert from 'assert';
-import { Project, QuoteKind, SourceFile } from 'ts-morph';
+import {
+    Node,
+    ObjectLiteralExpression,
+    Project,
+    PropertyDeclaration,
+    QuoteKind,
+    SourceFile,
+} from 'ts-morph';
 
 import { generateModel } from './generate-model';
 import { generatorOptions, stringContains, stringNotContains } from './testing';
@@ -20,11 +27,11 @@ describe('generate models', () => {
         const [model] = models;
         sourceFile = project.createSourceFile('_.ts', sourceFileText);
         generateModel({ model, sourceFile, projectFilePath: () => '_.ts' });
-        return sourceFile;
+        sourceText = sourceFile.getText();
     }
 
     it('model', async () => {
-        sourceFile = await getResult(`model User {
+        await getResult(`model User {
                 id String @id
             }`);
         sourceText = sourceFile.getText();
@@ -34,7 +41,7 @@ describe('generate models', () => {
     });
 
     it('field nullable', async () => {
-        sourceFile = await getResult(`model User {
+        await getResult(`model User {
                 id Int @id
                 image String?
             }`);
@@ -47,7 +54,7 @@ describe('generate models', () => {
     });
 
     it('default value', async () => {
-        sourceFile = await getResult(`model User {
+        await getResult(`model User {
                 count Int @id @default(1)
             }`);
         const sourceText = sourceFile.getText();
@@ -58,7 +65,7 @@ describe('generate models', () => {
     });
 
     it('self relation', async () => {
-        sourceFile = await getResult(`
+        await getResult(`
             model User {
                 id  String  @id
                 following   User[]   @relation("UserFollows", references: [id])
@@ -68,7 +75,7 @@ describe('generate models', () => {
     });
 
     it('extend existing class', async () => {
-        sourceFile = await getResult(
+        await getResult(
             `model User {
                 id String @id
             }`,
@@ -79,7 +86,7 @@ describe('generate models', () => {
     });
 
     it('object type description', async () => {
-        sourceFile = await getResult(
+        await getResult(
             `/// User really
             model User {
                 id Int @id
@@ -90,7 +97,7 @@ describe('generate models', () => {
     });
 
     it('property description', async () => {
-        sourceFile = await getResult(
+        await getResult(
             `model User {
                 /// user id
                 id Int @id
@@ -104,7 +111,7 @@ describe('generate models', () => {
     });
 
     it('update description to undefined', async () => {
-        sourceFile = await getResult(
+        await getResult(
             `model User {
                 id String @id
             }`,
@@ -117,7 +124,7 @@ describe('generate models', () => {
     });
 
     it('model import scalar types', async () => {
-        sourceFile = await getResult(`model User {
+        await getResult(`model User {
                 id String @id
                 count Int
                 money Float
@@ -131,7 +138,6 @@ describe('generate models', () => {
                 .flatMap((x) => x.getNamedImports())
                 .map((x) => x.getName()),
         );
-        sourceText = sourceFile.getText();
         stringContains(
             '@Field(() => Boolean, { nullable: false, description: undefined }) humanoid!: boolean',
             sourceText,
@@ -154,4 +160,24 @@ describe('generate models', () => {
         assert(imports.has('Int') === true, 'Imports should includes Int');
         assert(imports.has('Float') === true, 'Imports should includes Float');
     });
+
+    it('model scalar json', async () => {
+        await getResult(`model User {
+                id String @id
+                data Json
+            }`);
+        sourceText = sourceFile.getText();
+        const propertyDeclaration = sourceFile.getClass('User')?.getProperty('data');
+        assert(propertyDeclaration);
+        stringContains(`@Field(() => GraphQLJSON`, propertyDeclaration.getText());
+
+        const importDeclaration = sourceFile.getImportDeclaration(
+            (d) => d.getModuleSpecifier().getLiteralValue() === 'graphql-type-json',
+        );
+        assert(importDeclaration, 'import graphql-type-json should exists');
+        const importSpecifier = importDeclaration
+            .getNamedImports()
+            .find((x) => x.getName() === 'GraphQLJSON');
+        assert(importSpecifier, 'const GraphQLJSON should be imported');
+    });
 });

src/generate.spec.ts

@@ -20,7 +20,8 @@ describe('main generate', () => {
 
     it('smoke one', async () => {
         await getResult({
-            schema: `model User {
+            schema: `
+            model User {
               id        Int      @id
             }
             `,

src/testing/generator-options.ts

@@ -21,6 +21,10 @@ export async function generatorOptions(
     if (!fs.existsSync(optionsCacheFile)) {
         const schemaFile = `${cachePath}/schema-${hash}.prisma`;
         const schemaData = `
+            datasource database {
+                provider = "postgresql"
+                url = env("DATABASE_URL")
+            }
             generator client {
                 provider = "prisma-client-js"
             }

src/to-graphql-import-type.ts

@@ -1,17 +1,21 @@
 type ToGraphqlImportTypeArgs = {
     isId?: boolean;
     type: string;
+    kind: string;
 };
 
 export function toGraphqlImportType(args: ToGraphqlImportTypeArgs) {
-    const { isId, type } = args;
+    const { isId, type, kind } = args;
     let name = type;
     if (isId) {
         return { name: 'ID', moduleSpecifier: '@nestjs/graphql' };
     }
     if (name === 'Int' || name === 'Float') {
         return { name, moduleSpecifier: '@nestjs/graphql' };
     }
+    if (kind === 'scalar' && type === 'Json') {
+        return { name: 'GraphQLJSON', moduleSpecifier: 'graphql-type-json' };
+    }
     if (name === 'DateTime') {
         name = 'String';
     }

src/to-property-type.ts

@@ -4,6 +4,7 @@ const patterns = new Map([
     [{ type: (type: string) => type === 'Float', kind: 'scalar' }, () => 'number'],
     [{ type: (type: string) => type === 'Int', kind: 'scalar' }, () => 'number'],
     [{ type: (type: string) => type === 'Boolean', kind: 'scalar' }, () => 'boolean'],
+    [{ type: (type: string) => type === 'Json', kind: 'scalar' }, () => 'object'],
     [{ type: () => true, kind: 'object' }, (field: { type: string }) => field.type],
     [{ type: () => true, kind: 'enum' }, (field: { type: string }) => field.type],
     [{ type: () => true, kind: 'scalar' }, (field: { type: string }) => field.type],