Guardian Register

.env.example

@@ -0,0 +1,7 @@
+NODE_ENV=development
+POSTGRES_USER=admin
+POSTGRES_PASSWORD=admin
+POSTGRES_DB=database
+PG_HOST=localhost
+PG_PORT=54320
+DATABASE_URL="postgresql://admin:admin@localhost:54320/database?schema=public"

.eslintignore

@@ -1,3 +1,12 @@
-node_modules
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
 dist
 coverage
+node_modules
+.env*
+!.env.example

.eslintrc.json

@@ -2,5 +2,10 @@
  "extends": "standard-with-typescript",
  "parserOptions": {
  "project": "./tsconfig.json"
+ },
+ "rules": {
+ "@typescript-eslint/no-namespace": "off",
+ "@typescript-eslint/strict-boolean-expressions": "off",
+ "@typescript-eslint/no-misused-promises": "off"
  }
 }

.gitignore

@@ -1,3 +1,12 @@
-node_modules
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
 dist
 coverage
+node_modules
+.env*
+!.env.example

.husky/commit-msg

@@ -1,4 +1,4 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
 
-npx --no -- commitlint --edit "$1"
+yarn run commitlint --edit "$1"

.husky/pre-commit

@@ -1,4 +1,4 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
 
-npx lint-staged
+yarn run lint-staged

.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+ "recommendations": [
+ "arcanis.vscode-zipfs",
+ "dbaeumer.vscode-eslint",
+ "editorconfig.editorconfig"
+ ]
+}

.vscode/settings.json

@@ -0,0 +1,9 @@
+{
+ "search.exclude": {
+ "**/.yarn": true,
+ "**/.pnp.*": true
+ },
+ "eslint.nodePath": ".yarn/sdks",
+ "typescript.tsdk": ".yarn/sdks/typescript/lib",
+ "typescript.enablePromptUseWorkspaceTsdk": true
+}

.yarnrc.yml

@@ -0,0 +1,3 @@
+nodeLinker: node-modules
+
+yarnPath: .yarn/releases/yarn-3.5.0.cjs

docker-compose.dev.yml

@@ -0,0 +1,16 @@
+version: '3.8'
+
+services:
+ db:
+ image: postgres
+ container_name: petjournal_db
+ restart: always
+ ports:
+ - 54320:5432
+ env_file:
+ - .env.dev
+ volumes:
+ - pgdata:/var/lib/postgresql/data
+
+volumes:
+ pgdata:

jest.config.js

@@ -0,0 +1,22 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+ collectCoverageFrom: [
+ '<rootDir>/src/**/*.ts',
+ '!<rootDir>/src/main/**',
+ '!<rootDir>/src/**/index.ts'
+ ],
+ coverageDirectory: 'coverage',
+ coverageProvider: 'babel',
+ moduleNameMapper: {
+ '@/tests/(.+)': '<rootDir>/tests/$1',
+ '@/(.+)': '<rootDir>/src/$1'
+ },
+ roots: [
+ '<rootDir>/src',
+ '<rootDir>/tests'
+ ],
+ preset: 'ts-jest',
+ transform: {
+ '\\.ts$': 'ts-jest'
+ }
+}

package.json

@@ -4,13 +4,16 @@
  "description": "",
  "main": "index.js",
  "scripts": {
+ "start": "node dist/main/server.js",
+ "dev": "sucrase-node src/main/server.ts",
  "build": "rimraf dist && tsc -p tsconfig-build.json",
  "lint": "eslint .",
- "lint:fix": "yarn run lint -- --fix",
- "test": "jest --passWithNoTests --no-cache --runInBand",
- "test:watch": "yarn test -- --watch",
- "test:staged": "yarn test -- --findRelatedTests",
- "test:coverage": "yarn test -- --coverage",
+ "lint:fix": "yarn run lint --fix",
+ "test": "jest --passWithNoTests --no-cache --runInBand --silent --noStackTrace",
+ "test:watch": "yarn test --watch",
+ "test:verbose": "jest --passWithNoTests --no-cache --runInBand",
+ "test:staged": "yarn test --findRelatedTests",
+ "test:coverage": "yarn test:verbose --coverage",
  "prepare": "husky install"
  },
  "keywords": [],
@@ -19,8 +22,15 @@
  "devDependencies": {
  "@commitlint/cli": "^17.4.4",
  "@commitlint/config-conventional": "^17.4.4",
+ "@types/bcrypt": "^5.0.0",
+ "@types/express": "^4.17.17",
  "@types/jest": "^29.5.0",
+ "@types/module-alias": "^2.0.1",
  "@types/node": "^18.15.5",
+ "@types/supertest": "^2.0.12",
+ "@types/swagger-ui-express": "^4.1.3",
+ "@types/uuid": "^9.0.1",
+ "@types/validator": "^13.7.14",
  "@typescript-eslint/eslint-plugin": "^5.43.0",
  "eslint": "^8.0.1",
  "eslint-config-standard-with-typescript": "^34.0.1",
@@ -30,10 +40,24 @@
  "husky": "^8.0.0",
  "jest": "^29.5.0",
  "lint-staged": "^13.2.0",
- "ts-jest": "^29.0.5",
- "typescript": "^5.0.2"
+ "prisma": "^4.12.0",
+ "sucrase": "^3.32.0",
+ "supertest": "^6.3.3",
+ "ts-jest": "^29.1.0",
+ "typescript": "^5.0.2",
+ "uuid": "^9.0.0"
  },
  "dependencies": {
- "rimraf": "^4.4.0"
+ "@prisma/client": "^4.12.0",
+ "bcrypt": "^5.1.0",
+ "express": "^4.18.2",
+ "module-alias": "^2.2.2",
+ "rimraf": "^4.4.0",
+ "swagger-ui-express": "^4.6.2",
+ "validator": "^13.9.0"
+ },
+ "packageManager": "[email protected]",
+ "prisma": {
+ "schema": "./src/infra/repos/postgresql/prisma/schema.prisma"
  }
 }

src/application/controllers/controller.ts

@@ -0,0 +1,5 @@
+import { type HttpRequest, type HttpResponse } from '@/application/helpers/http'
+
+export interface Controller {
+ handle: (httpRequest: HttpRequest) => Promise<HttpResponse>
+}

src/application/controllers/signup.ts

@@ -0,0 +1,67 @@
+import { InvalidParamError, MissingParamError } from '@/application/errors'
+import { type EmailValidator, type NameValidator, type PasswordValidator, type PhoneValidator } from '@/application/validation/protocols'
+import { badRequest, serverError, success, type HttpRequest, type HttpResponse } from '@/application/helpers/http'
+import { type Controller } from '@/application/controllers/controller'
+import { type AddGuardian } from '@/domain/use-cases/add-guardian'
+
+export class SignUpController implements Controller {
+ private readonly addGuardian: AddGuardian
+ private readonly emailValidator: EmailValidator
+ private readonly nameValidator: NameValidator
+ private readonly passwordValidator: PasswordValidator
+ private readonly phoneValidator: PhoneValidator
+
+ constructor (addGuardian: AddGuardian, emailValidator: EmailValidator, nameValidator: NameValidator, passwordValidator: PasswordValidator, phoneValidator: PhoneValidator) {
+ this.emailValidator = emailValidator
+ this.addGuardian = addGuardian
+ this.nameValidator = nameValidator
+ this.passwordValidator = passwordValidator
+ this.phoneValidator = phoneValidator
+ }
+
+ async handle (httpRequest: HttpRequest): Promise<HttpResponse> {
+ try {
+ const requiredFields = ['firstName', 'lastName', 'email', 'password', 'passwordConfirmation', 'isPrivacyPolicyAccepted']
+ for (const field of requiredFields) {
+ if (httpRequest.body[field] === undefined) {
+ return badRequest(new MissingParamError(field))
+ }
+ }
+ const { firstName, lastName, email, phone, password, passwordConfirmation, isPrivacyPolicyAccepted } = httpRequest.body
+ if (passwordConfirmation !== password) {
+ return badRequest(new InvalidParamError('passwordConfirmation'))
+ }
+ if (!isPrivacyPolicyAccepted) {
+ return badRequest(new InvalidParamError('isPrivacyPolicyAccepted'))
+ }
+ const isValidName = this.nameValidator.isValid(firstName, lastName)
+ if (!isValidName) {
+ return badRequest(new InvalidParamError('name'))
+ }
+ const isValidEmail = this.emailValidator.isValid(email)
+ if (!isValidEmail) {
+ return badRequest(new InvalidParamError('email'))
+ }
+ const isValidPassword = this.passwordValidator.isValid(password)
+ if (!isValidPassword) {
+ return badRequest(new InvalidParamError('password'))
+ }
+ const isValidPhone = this.phoneValidator.isValid(phone)
+ if (!isValidPhone) {
+ return badRequest(new InvalidParamError('phone'))
+ }
+ const guardian = await this.addGuardian.add({
+ firstName,
+ lastName,
+ email,
+ phone,
+ password,
+ isPrivacyPolicyAccepted
+ })
+ return success(guardian)
+ } catch (error) {
+ console.error(error)
+ return serverError()
+ }
+ }
+}

src/application/errors/index.ts

@@ -0,0 +1,3 @@
+export * from './invalid-param-error'
+export * from './missing-param-error'
+export * from './server-error'

src/application/errors/invalid-param-error.ts

@@ -0,0 +1,6 @@
+export class InvalidParamError extends Error {
+ constructor (paramName: string) {
+ super(`Invalid param: ${paramName}`)
+ this.name = 'InvalidParamError'
+ }
+}

src/application/errors/missing-param-error.ts

@@ -0,0 +1,6 @@
+export class MissingParamError extends Error {
+ constructor (paramName: string) {
+ super(`Missing param: ${paramName}`)
+ this.name = 'MissingParamError'
+ }
+}

src/application/errors/server-error.ts

@@ -0,0 +1,6 @@
+export class ServerError extends Error {
+ constructor () {
+ super('Internal server error.\nAn unexpected error happened. Please try again in a moment.')
+ this.name = 'ServerError'
+ }
+}

src/application/helpers/http.ts

@@ -0,0 +1,25 @@
+import { ServerError } from '@/application/errors'
+
+export interface HttpRequest {
+ body?: any
+}
+
+export interface HttpResponse {
+ statusCode: number
+ body: any
+}
+
+export const badRequest = (error: Error): HttpResponse => ({
+ statusCode: 400,
+ body: error
+})
+
+export const serverError = (): HttpResponse => ({
+ statusCode: 500,
+ body: new ServerError()
+})
+
+export const success = (data: any): HttpResponse => ({
+ statusCode: 200,
+ body: data
+})

src/application/validation/protocols/email-validator.ts

@@ -0,0 +1,3 @@
+export interface EmailValidator {
+ isValid: (email: string) => boolean
+}

src/application/validation/protocols/index.ts

@@ -0,0 +1,4 @@
+export * from './email-validator'
+export * from './name-validator'
+export * from './password-validator'
+export * from './phone-validator'

src/application/validation/protocols/name-validator.ts

@@ -0,0 +1,3 @@
+export interface NameValidator {
+ isValid: (firstName: string, lastName: string) => boolean
+}

src/application/validation/protocols/password-validator.ts

@@ -0,0 +1,3 @@
+export interface PasswordValidator {
+ isValid: (password: string) => boolean
+}

src/application/validation/protocols/phone-validator.ts

@@ -0,0 +1,3 @@
+export interface PhoneValidator {
+ isValid: (phone: string) => boolean
+}

src/application/validation/validators/email-validator-adapter.ts

@@ -0,0 +1,8 @@
+import { type EmailValidator } from '@/application/validation/protocols/email-validator'
+import validator from 'validator'
+
+export class EmailValidatorAdapter implements EmailValidator {
+ isValid (email: string): boolean {
+ return validator.isEmail(email)
+ }
+}

src/application/validation/validators/index.ts

@@ -0,0 +1,4 @@
+export * from './email-validator-adapter'
+export * from './name-validator-adapter'
+export * from './password-validator-adapter'
+export * from './phone-validator-adapter'

src/application/validation/validators/name-validator-adapter.ts

@@ -0,0 +1,14 @@
+import { type NameValidator } from '@/application/validation/protocols'
+import validator from 'validator'
+
+export class NameValidatorAdapter implements NameValidator {
+ isValid (firstName: string, lastName: string): boolean {
+ const isValidName = (field: string): boolean => validator.matches(field, /^[a-zA-Z]{3,}$/)
+
+ if (isValidName(firstName) && isValidName(lastName)) {
+ return true
+ }
+
+ return false
+ }
+}

src/application/validation/validators/password-validator-adapter.ts

@@ -0,0 +1,8 @@
+import { type PasswordValidator } from '@/application/validation/protocols'
+import validator from 'validator'
+
+export class PasswordValidatorAdapter implements PasswordValidator {
+ isValid (password: string): boolean {
+ return validator.isStrongPassword(password)
+ }
+}

src/application/validation/validators/phone-validator-adapter.ts

@@ -0,0 +1,8 @@
+import { type PhoneValidator } from '@/application/validation/protocols'
+import validator from 'validator'
+
+export class PhoneValidatorAdapter implements PhoneValidator {
+ isValid (phone: string): boolean {
+ return validator.isMobilePhone(phone, 'pt-BR')
+ }
+}