Merge pull request #24 from Karibash/feature/validate

Add a validate package

README.md

@@ -5,9 +5,10 @@
 [![Github][github-follower-badge]][github-follower-link]
 [![Twitter][twitter-follower-badge]][twitter-follower-link]
 
-| package                                     | Version                                                             | Description                                                                            | Changelog                                 |
-|---------------------------------------------|---------------------------------------------------------------------|----------------------------------------------------------------------------------------|-------------------------------------------|
-| [`@nestjs-modular/inject`](packages/inject) | [![npm version][inject-npm-version-badge]][inject-npm-version-link] | This module provides the ability to inject features in bulk by specifying a directory. | [CHANGELOG](packages/inject/CHANGELOG.md) |
+| package                                         | Version                                                                 | Description                                                                                           | Changelog                                   |
+|-------------------------------------------------|-------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|---------------------------------------------|
+| [`@nestjs-modular/inject`](packages/inject)     | [![npm version][inject-npm-version-badge]][inject-npm-version-link]     | This module provides the ability to inject features in bulk by specifying a directory.                | [CHANGELOG](packages/inject/CHANGELOG.md)   |
+| [`@nestjs-modular/validate`](packages/validate) | [![npm version][validate-npm-version-badge]][validate-npm-version-link] | This module provides a pipe to validate incoming requests using schema validation such as Zod or Yup. | [CHANGELOG](packages/validate/CHANGELOG.md) |
 
 ## 🤝 Contributing
 
@@ -31,3 +32,5 @@ This project is [```MIT```](https://github.com/Karibash/nestjs-modular/blob/main
 [twitter-follower-link]: https://twitter.com/intent/follow?screen_name=Karibash
 [inject-npm-version-badge]: https://badge.fury.io/js/@nestjs-modular%2Finject.svg
 [inject-npm-version-link]: https://www.npmjs.com/package/@nestjs-modular/inject
+[validate-npm-version-badge]: https://badge.fury.io/js/@nestjs-modular%2Fvalidate.svg
+[validate-npm-version-link]: https://www.npmjs.com/package/@nestjs-modular/validate

examples/inject/README.md

@@ -7,6 +7,6 @@ This is a example program describing the basic usage of @nestjs-modular/inject p
 The example program can be run by executing the following command.
 
 ```sh
-npm install
-npm run start
+$ npm install
+$ npm run start
 ```

examples/inject/tsconfig.json

@@ -1,5 +1,6 @@
 {
   "compilerOptions": {
+    "strict": true,
     "module": "commonjs",
     "declaration": true,
     "removeComments": true,
@@ -13,9 +14,6 @@
     "baseUrl": "./",
     "incremental": true,
     "skipLibCheck": true,
-    "strictNullChecks": false,
-    "noImplicitAny": false,
-    "strictBindCallApply": false,
     "forceConsistentCasingInFileNames": false,
     "noFallthroughCasesInSwitch": false
   }

examples/validate/.gitignore

@@ -0,0 +1,35 @@
+# compiled output
+/dist
+/node_modules
+
+# Logs
+logs
+*.log
+npm-debug.log*
+pnpm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# OS
+.DS_Store
+
+# Tests
+/coverage
+/.nyc_output
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json

examples/validate/README.md

@@ -0,0 +1,12 @@
+# nest-js-modular-validate
+
+This is a example program describing the basic usage of @nestjs-modular/validate package.
+
+## Usage
+
+The example program can be run by executing the following command.
+
+```sh
+$ npm install
+$ npm run start
+```

examples/validate/nest-cli.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://json.schemastore.org/nest-cli",
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src"
+}

examples/validate/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "nest-js-modular-validate-example",
+  "version": "0.0.0",
+  "description": "",
+  "author": "",
+  "private": true,
+  "license": "MIT",
+  "scripts": {
+    "prebuild": "rimraf dist",
+    "build": "nest build",
+    "start": "nest start",
+    "start:mock": "APP_ENV=mock nest start",
+    "start:dev": "nest start --watch",
+    "start:debug": "nest start --debug --watch",
+    "start:prod": "node dist/main"
+  },
+  "dependencies": {
+    "@nestjs-modular/validate": "1.0.0",
+    "@nestjs/common": "9.2.1",
+    "@nestjs/core": "9.2.1",
+    "@nestjs/platform-express": "9.2.1",
+    "@valivali/myzod": "1.0.0",
+    "@valivali/runtypes": "1.0.0",
+    "@valivali/superstruct": "1.0.0",
+    "@valivali/yup": "1.0.0",
+    "@valivali/zod": "1.0.0",
+    "myzod": "1.10.0",
+    "reflect-metadata": "0.1.13",
+    "rimraf": "3.0.2",
+    "runtypes": "6.6.0",
+    "rxjs": "7.6.0",
+    "superstruct": "1.0.3",
+    "yup": "1.0.2",
+    "zod": "3.20.2"
+  },
+  "devDependencies": {
+    "@nestjs/cli": "9.1.5",
+    "@nestjs/schematics": "9.0.3",
+    "@types/express": "4.17.14",
+    "@types/node": "16.18.8",
+    "source-map-support": "0.5.21",
+    "ts-loader": "9.4.2",
+    "ts-node": "10.9.1",
+    "tsconfig-paths": "4.1.1",
+    "typescript": "4.9.4"
+  }
+}

examples/validate/src/app.module.ts

@@ -0,0 +1,26 @@
+import { IncomingValidatePipe } from '@nestjs-modular/validate';
+import { Module } from '@nestjs/common';
+import { APP_PIPE } from '@nestjs/core';
+
+import { MyzodModule } from './modules/myzod/myzod.module';
+import { RuntypesModule } from './modules/runtypes/runtypes.module';
+import { SuperstructModule } from './modules/superstruct/superstruct.module';
+import { YupModule } from './modules/yup/yup.module';
+import { ZodModule } from './modules/zod/zod.module';
+
+@Module({
+  imports: [
+    MyzodModule,
+    RuntypesModule,
+    SuperstructModule,
+    YupModule,
+    ZodModule,
+  ],
+  providers: [
+    {
+      provide: APP_PIPE,
+      useClass: IncomingValidatePipe,
+    },
+  ],
+})
+export class AppModule {}

examples/validate/src/main.ts

@@ -0,0 +1,10 @@
+import { NestFactory } from '@nestjs/core';
+
+import { AppModule } from './app.module';
+
+const bootstrap = async () => {
+  const app = await NestFactory.create(AppModule);
+  await app.listen(3005);
+};
+
+bootstrap().then();

examples/validate/src/modules/myzod/myzod.controller.ts

@@ -0,0 +1,24 @@
+import { createIncomingDto } from '@nestjs-modular/validate';
+import { Body, Controller, Param, Post } from '@nestjs/common';
+import { resolver } from '@valivali/myzod';
+import z from 'myzod';
+
+class ParamDto extends createIncomingDto(resolver(z.object({
+  id: z.string(),
+}))) {}
+
+class BodyDto extends createIncomingDto(resolver(z.object({
+  title: z.string(),
+  content: z.string(),
+}))) {}
+
+@Controller('myzod')
+export class MyzodController {
+  @Post(':id')
+  public endpoint(
+    @Param() param: ParamDto,
+    @Body() body: BodyDto,
+  ): void {
+    console.log({ param, body });
+  }
+}

examples/validate/src/modules/myzod/myzod.module.ts

@@ -0,0 +1,10 @@
+import { Module } from '@nestjs/common';
+
+import { MyzodController } from './myzod.controller';
+
+@Module({
+  controllers: [
+    MyzodController,
+  ],
+})
+export class MyzodModule {}

examples/validate/src/modules/runtypes/runtypes.controller.ts

@@ -0,0 +1,24 @@
+import { createIncomingDto } from '@nestjs-modular/validate';
+import { Body, Controller, Param, Post } from '@nestjs/common';
+import { resolver } from '@valivali/runtypes';
+import * as rt from 'runtypes';
+
+class ParamDto extends createIncomingDto(resolver(rt.Record({
+  id: rt.String,
+}))) {}
+
+class BodyDto extends createIncomingDto(resolver(rt.Record({
+  title: rt.String,
+  content: rt.String,
+}))) {}
+
+@Controller('runtypes')
+export class RuntypesController {
+  @Post(':id')
+  public endpoint(
+    @Param() param: ParamDto,
+    @Body() body: BodyDto,
+  ): void {
+    console.log({ param, body });
+  }
+}

examples/validate/src/modules/runtypes/runtypes.module.ts

@@ -0,0 +1,10 @@
+import { Module } from '@nestjs/common';
+
+import { RuntypesController } from './runtypes.controller';
+
+@Module({
+  controllers: [
+    RuntypesController,
+  ],
+})
+export class RuntypesModule {}

examples/validate/src/modules/superstruct/superstruct.controller.ts

@@ -0,0 +1,24 @@
+import { createIncomingDto } from '@nestjs-modular/validate';
+import { Body, Controller, Param, Post } from '@nestjs/common';
+import { resolver } from '@valivali/superstruct';
+import st from 'superstruct';
+
+class ParamDto extends createIncomingDto(resolver(st.object({
+  id: st.string(),
+}))) {}
+
+class BodyDto extends createIncomingDto(resolver(st.object({
+  title: st.string(),
+  content: st.string(),
+}))) {}
+
+@Controller('superstruct')
+export class SuperstructController {
+  @Post(':id')
+  public endpoint(
+    @Param() param: ParamDto,
+    @Body() body: BodyDto,
+  ): void {
+    console.log({ param, body });
+  }
+}

examples/validate/src/modules/superstruct/superstruct.module.ts

@@ -0,0 +1,10 @@
+import { Module } from '@nestjs/common';
+
+import { SuperstructController } from './superstruct.controller';
+
+@Module({
+  controllers: [
+    SuperstructController,
+  ],
+})
+export class SuperstructModule {}

examples/validate/src/modules/yup/yup.controller.ts

@@ -0,0 +1,24 @@
+import { createIncomingDto } from '@nestjs-modular/validate';
+import { Body, Controller, Param, Post } from '@nestjs/common';
+import { resolver } from '@valivali/yup';
+import * as yup from 'yup';
+
+class ParamDto extends createIncomingDto(resolver(yup.object({
+  id: yup.string().required(),
+}))) {}
+
+class BodyDto extends createIncomingDto(resolver(yup.object({
+  title: yup.string().required(),
+  content: yup.string().required(),
+}))) {}
+
+@Controller('yup')
+export class YupController {
+  @Post(':id')
+  public endpoint(
+    @Param() param: ParamDto,
+    @Body() body: BodyDto,
+  ): void {
+    console.log({ param, body });
+  }
+}

examples/validate/src/modules/yup/yup.module.ts

@@ -0,0 +1,10 @@
+import { Module } from '@nestjs/common';
+
+import { YupController } from './yup.controller';
+
+@Module({
+  controllers: [
+    YupController,
+  ],
+})
+export class YupModule {}

examples/validate/src/modules/zod/zod.controller.ts

@@ -0,0 +1,24 @@
+import { createIncomingDto } from '@nestjs-modular/validate';
+import { Body, Controller, Param, Post } from '@nestjs/common';
+import { resolver } from '@valivali/zod';
+import { z } from 'zod';
+
+class ParamDto extends createIncomingDto(resolver(z.object({
+  id: z.string(),
+}))) {}
+
+class BodyDto extends createIncomingDto(resolver(z.object({
+  title: z.string(),
+  content: z.string(),
+}))) {}
+
+@Controller('zod')
+export class ZodController {
+  @Post(':id')
+  public endpoint(
+    @Param() param: ParamDto,
+    @Body() body: BodyDto,
+  ): void {
+    console.log({ param, body });
+  }
+}

examples/validate/src/modules/zod/zod.module.ts

@@ -0,0 +1,10 @@
+import { Module } from '@nestjs/common';
+
+import { ZodController } from './zod.controller';
+
+@Module({
+  controllers: [
+    ZodController,
+  ],
+})
+export class ZodModule {}

examples/validate/tsconfig.build.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": ["node_modules", "test", "dist", "**/*spec.ts"]
+}

examples/validate/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "strict": true,
+    "module": "commonjs",
+    "declaration": true,
+    "removeComments": true,
+    "esModuleInterop": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "allowSyntheticDefaultImports": true,
+    "target": "es2017",
+    "sourceMap": true,
+    "outDir": "./dist",
+    "baseUrl": "./",
+    "incremental": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": false,
+    "noFallthroughCasesInSwitch": false
+  }
+}