Merge pull request #48 from zhumeisongsong/feature/user-dto

feat: ✨ add UserDto

README.md

@@ -54,11 +54,13 @@ You can use `npx nx list` to get a list of installed plugins. Then, run `npx nx
 
 ## Architecture
 
-| Layer              | Description                                                                                                                                                                                                                                                                                                                                                                    |
-| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| use-case(application)            | Define business use cases and encapsulate business logic.                                                                                                                                                                                                                                                                                                                      |
-| entity(domain)     | Define core business entities and business rules.<br/> Maintain entity independence from database and framework.                                                                                                                                                                                                                                                               |
-| repository(domain) | Interfaces (or abstract classes), which define methods for manipulating data without concern for specific database implementations. <br/>By defining this interface, we can decouple database access: the specific details of data access will be done by implementation classes, such as specific implementations using tools like Mongoose, TypeORM, Prisma, and so on. |
+| Layer                 | Description                                                                                                                                                                                                                                                                                                                                                               |
+| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| dto(presentation)     | Define DTOs for GraphQL schema.                                                                                                                                                                                                                                                                                                                                           |
+| resolver(presentation) | Define GraphQL schema and resolver.                                                                                                                                                                                                                                                                                                                                       |
+| use-case(application) | Define business use cases and encapsulate business logic.                                                                                                                                                                                                                                                                                                                 |
+| entity(domain)        | Define core business entities and business rules.<br/> Maintain entity independence from database and framework.                                                                                                                                                                                                                                                          |
+| repository(domain)    | Interfaces (or abstract classes), which define methods for manipulating data without concern for specific database implementations. <br/>By defining this interface, we can decouple database access: the specific details of data access will be done by implementation classes, such as specific implementations using tools like Mongoose, TypeORM, Prisma, and so on. |
 
 ## Useful links
 

apps/users/src/users/users.module.ts

@@ -4,7 +4,7 @@ import {
 } from '@nestjs/apollo';
 import { Module } from '@nestjs/common';
 import { GraphQLModule } from '@nestjs/graphql';
-import { UsersResolver } from '@users/presentation';
+import { UsersResolver } from '@users/presentation-resolver';
 import { UsersService } from '@users/application';
 import { ApolloServerPluginInlineTrace } from '@apollo/server/plugin/inlineTrace';
 

libs/users/presentation/dto/README.md

@@ -0,0 +1,7 @@
+# users-presentation-dto
+
+This library was generated with [Nx](https://nx.dev).
+
+## Running unit tests
+
+Run `nx test users-presentation-dto` to execute the unit tests via [Jest](https://jestjs.io).

libs/users/presentation/dto/eslint.config.js

@@ -0,0 +1,3 @@
+const baseConfig = require('../../../../eslint.config.js');
+
+module.exports = [...baseConfig];

libs/users/presentation/jest.config.ts → libs/users/presentation/dto/jest.config.ts

@@ -1,10 +1,10 @@
 export default {
-  displayName: 'users-presentation',
-  preset: '../../../jest.preset.js',
+  displayName: 'users-presentation-dto',
+  preset: '../../../../jest.preset.js',
   testEnvironment: 'node',
   transform: {
     '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
   },
   moduleFileExtensions: ['ts', 'js', 'html'],
-  coverageDirectory: '../../../coverage/libs/users/presentation',
+  coverageDirectory: '../../../../coverage/libs/users/presentation/dto',
 };

libs/users/presentation/dto/project.json

@@ -0,0 +1,9 @@
+{
+  "name": "users-presentation-dto",
+  "$schema": "../../../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "libs/users/presentation/dto/src",
+  "projectType": "library",
+  "tags": [],
+  "// targets": "to see all targets run: nx show project users-presentation-dto --web",
+  "targets": {}
+}

libs/users/presentation/dto/src/index.ts

@@ -0,0 +1 @@
+export * from './lib/user.dto';

libs/users/presentation/dto/src/lib/user.dto.spec.ts

@@ -0,0 +1,13 @@
+import { UserDto } from './user.dto';
+
+describe('UserDto', () => {
+  it('should create a new UserDto instance', () => {
+    const id = '123';
+    const name = 'Test User';
+    const userDto = new UserDto(id, name);
+
+    expect(userDto).toBeDefined();
+    expect(userDto.id).toBe(id);
+    expect(userDto.name).toBe(name);
+  });
+});

libs/users/presentation/dto/src/lib/user.dto.ts

@@ -0,0 +1,16 @@
+import { Directive, Field, ID, ObjectType } from '@nestjs/graphql';
+
+@ObjectType()
+@Directive('@key(fields: "id")')
+export class UserDto {
+  @Field(() => ID)
+  id: string;
+
+  @Field()
+  name: string;
+
+  constructor(id: string, name: string) {
+    this.id = id;
+    this.name = name;
+  }
+}

libs/users/presentation/tsconfig.json → libs/users/presentation/dto/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "../../../tsconfig.base.json",
+  "extends": "../../../../tsconfig.base.json",
   "compilerOptions": {
     "module": "commonjs",
     "forceConsistentCasingInFileNames": true,

libs/users/presentation/tsconfig.lib.json → libs/users/presentation/dto/tsconfig.lib.json

@@ -2,7 +2,7 @@
   "extends": "./tsconfig.json",
   "compilerOptions": {
     "module": "commonjs",
-    "outDir": "../../../dist/out-tsc",
+    "outDir": "../../../../dist/out-tsc",
     "declaration": true,
     "types": ["node"]
   },

libs/users/presentation/tsconfig.spec.json → libs/users/presentation/dto/tsconfig.spec.json

@@ -1,7 +1,7 @@
 {
   "extends": "./tsconfig.json",
   "compilerOptions": {
-    "outDir": "../../../dist/out-tsc",
+    "outDir": "../../../../dist/out-tsc",
     "module": "commonjs",
     "types": ["jest", "node"]
   },

libs/users/presentation/resolver/README.md

@@ -0,0 +1,7 @@
+# users-presentation-resolver
+
+This library was generated with [Nx](https://nx.dev).
+
+## Running unit tests
+
+Run `nx test users-presentation-resolver` to execute the unit tests via [Jest](https://jestjs.io).

libs/users/presentation/resolver/eslint.config.js

@@ -0,0 +1,3 @@
+const baseConfig = require('../../../../eslint.config.js');
+
+module.exports = [...baseConfig];

libs/users/presentation/resolver/jest.config.ts

@@ -0,0 +1,10 @@
+export default {
+  displayName: 'users-presentation-resolver',
+  preset: '../../../../jest.preset.js',
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory: '../../../../coverage/libs/users/presentation/resolver',
+};

libs/users/presentation/resolver/project.json

@@ -0,0 +1,9 @@
+{
+  "name": "users-presentation-resolver",
+  "$schema": "../../../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "libs/users/presentation/resolver/src",
+  "projectType": "library",
+  "tags": [],
+  "// targets": "to see all targets run: nx show project users-presentation-resolver --web",
+  "targets": {}
+}

libs/users/presentation/src/lib/users.resolver.spec.ts → libs/users/presentation/resolver/src/lib/users.resolver.spec.ts

@@ -41,7 +41,7 @@ describe('UsersResolver', () => {
     it('should return undefined if user not found', () => {
       jest.spyOn(service, 'findById').mockReturnValue(undefined);
 
-      expect(resolver.getUser('2')).toBeUndefined();
+      expect(resolver.getUser('2')).toBeNull();
       expect(service.findById).toHaveBeenCalledWith('2');
     });
   });

libs/users/presentation/src/lib/users.resolver.ts → libs/users/presentation/resolver/src/lib/users.resolver.ts

@@ -1,14 +1,16 @@
 import { Args, ID, Query, Resolver, ResolveReference } from '@nestjs/graphql';
 import { UsersService } from '@users/application';
 import { User } from '@user/domain';
+import { UserDto } from '@users/presentation-dto';
 
-@Resolver(() => User)
+@Resolver(() => UserDto)
 export class UsersResolver {
   constructor(private usersService: UsersService) {}
 
-  @Query(() => User, { nullable: true })
-  getUser(@Args({ name: 'id', type: () => ID }) id: string): User | undefined {
-    return this.usersService.findById(id);
+  @Query(() => UserDto, { nullable: true })
+  getUser(@Args({ name: 'id', type: () => ID }) id: string): UserDto | null {
+    const user: User | undefined = this.usersService.findById(id); // Domain entity
+    return user ? new UserDto(user.id, user.name) : null; 
   }
 
   @ResolveReference()

libs/users/presentation/resolver/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "extends": "../../../../tsconfig.base.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "noPropertyAccessFromIndexSignature": true
+  },
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ]
+}

libs/users/presentation/resolver/tsconfig.lib.json

@@ -0,0 +1,11 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "outDir": "../../../../dist/out-tsc",
+    "declaration": true,
+    "types": ["node"]
+  },
+  "exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"],
+  "include": ["src/**/*.ts"]
+}

libs/users/presentation/resolver/tsconfig.spec.json

@@ -0,0 +1,14 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../../../dist/out-tsc",
+    "module": "commonjs",
+    "types": ["jest", "node"]
+  },
+  "include": [
+    "jest.config.ts",
+    "src/**/*.test.ts",
+    "src/**/*.spec.ts",
+    "src/**/*.d.ts"
+  ]
+}

tsconfig.base.json

@@ -19,7 +19,10 @@
       "@prompt/domain": ["libs/prompt/domain/src/index.ts"],
       "@user/domain": ["libs/user/domain/src/index.ts"],
       "@users/application": ["libs/users/application/src/index.ts"],
-      "@users/presentation": ["libs/users/presentation/src/index.ts"]
+      "@users/presentation-dto": ["libs/users/presentation/dto/src/index.ts"],
+      "@users/presentation-resolver": [
+        "libs/users/presentation/resolver/src/index.ts"
+      ]
     }
   },
   "exclude": ["node_modules", "tmp"]