# prisma-nestjs-dto-generator

> Prisma 2+ generator to emit typescript models of your database with nestjs dto

Latest version **0.1.12** (published 2023-05-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install prisma-nestjs-dto-generator
pnpm add prisma-nestjs-dto-generator
yarn add prisma-nestjs-dto-generator
bun add prisma-nestjs-dto-generator
```

Provides the command `prisma-nestjs-dto-generator`.

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.12 |
| Published | 2023-05-02 |
| First published | 2022-10-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 31.5 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Huy Le |
| Maintainers | letienhuy |
| Keywords | prisma, prisma-client, prisma-schema, nestjs prisma, prisma-generator, prisma-nestjs-dto-generator, nestjs dto, nestjs dto swagger |

## Links

- npm: https://www.npmjs.com/package/prisma-nestjs-dto-generator
- Repository: https://github.com/huy97/prisma-nestjs-dto-generator
- Homepage: https://github.com/huy97/prisma-nestjs-dto-generator#readme
- Issues: https://github.com/huy97/prisma-nestjs-dto-generator/issues
- npm.io page: https://npm.io/package/prisma-nestjs-dto-generator

## Dependencies (8)

- [tslib](https://npm.io/package/tslib.md) ^2.4.0
- [prettier](https://npm.io/package/prettier.md) ^2.7.1
- [ts-morph](https://npm.io/package/ts-morph.md) ^15.1.0
- [pluralize](https://npm.io/package/pluralize.md) ^8.0.0
- [@prisma/client](https://npm.io/package/@prisma/client.md) ^4.0.0
- [class-validator](https://npm.io/package/class-validator.md) ^0.13.2
- [@prisma/internals](https://npm.io/package/@prisma/internals.md) ^4.0.0
- [@prisma/generator-helper](https://npm.io/package/@prisma/generator-helper.md) ^4.0.0

## Alternatives

- [@oh-my-pi/pi-natives](https://npm.io/package/@oh-my-pi/pi-natives.md) — 51.8K weekly downloads
- [@capgo/capacitor-light-sensor](https://npm.io/package/@capgo/capacitor-light-sensor.md) — 3.0K weekly downloads
- [@heyhuynhgiabuu/pi-diff](https://npm.io/package/@heyhuynhgiabuu/pi-diff.md) — 492 weekly downloads
- [@lotsa/verdant-lang-asm](https://npm.io/package/@lotsa/verdant-lang-asm.md) — 38 weekly downloads
- [new-era-syntax](https://npm.io/package/new-era-syntax.md) — 20 weekly downloads

## Recent versions

- 0.1.12 (latest) — 2023-05-02
- 0.1.11 — 2022-12-07
- 0.1.10 — 2022-10-20
- 0.1.9 — 2022-10-19
- 0.1.8 — 2022-10-19
- 0.1.7 — 2022-10-19
- 0.1.5 — 2022-10-19
- 0.1.4 — 2022-10-19
- 0.1.3 — 2022-10-15
- 0.1.2 — 2022-10-15
- 0.1.1 — 2022-10-14
- 0.1.0 — 2022-10-14

## README

# Prisma NestJS DTO Generator

[![npm version](https://badge.fury.io/js/prisma-nestjs-dto-generator.svg)](https://badge.fury.io/js/prisma-nestjs-dto-generator)
[![npm](https://img.shields.io/npm/dt/prisma-nestjs-dto-generator.svg)](https://www.npmjs.com/package/prisma-nestjs-dto-generator)
[![HitCount](https://hits.dwyl.com/huy97/prisma-nestjs-dto-generator.svg?style=flat)](http://hits.dwyl.com/huy97/prisma-nestjs-dto-generator)
[![npm](https://img.shields.io/npm/l/prisma-nestjs-dto-generator.svg)](LICENSE)

Automatically generate typescript models of your database with class validator validations ready, from your [Prisma](https://github.com/prisma/prisma) Schema. Updates every time `npx prisma generate` runs.

## Table of Contents

- [Supported Prisma Versions](#supported-prisma-versions)
- [Installation](#installing)
- [Usage](#usage)
- [Additional Options](#additional-options)

# Supported Prisma Versions

Probably no breaking changes for this library, so try newer versions first.

### Prisma 4

- 0.2.0 and higher

### Prisma 2/3

- 0.1.1 and lower

## Installation

Using npm:

```bash
 npm install --save-dev prisma-nestjs-dto-generator
```

Using yarn:

```bash
 yarn add -D prisma-nestjs-dto-generator
```

# Usage

1, Star this repo 😉

2, Add the generator to your Prisma schema

```prisma
generator nestjs_dto_generator {
  provider = "prisma-nestjs-dto-generator"
}
```

3, Running `npx prisma generate` for the following schema.prisma

```prisma
generator client {
  provider = "prisma-client-js"
}

generator nestjs_dto_generator {
  provider = "prisma-nestjs-dto-generator"
  enableModel = true // default: true
  modelFileNameSuffix = ".model" // default: ".model"
  modelClassNameSuffix = "Model" // default: ""
  enableSwagger = true // default: false
  dtoClassNameSuffix = "Dto" // default: "Dto"
  dtoFileNameSuffix = ".dto" // default: ".dto"
  toLowerCase = true // field name to lower case, default: false
}

datasource db {
  provider = "postgresql"
  url      = env("DATABASE_URL")
}

enum Role {
  ADMIN
  USER
}

model User {
  id    Int     @id @default(autoincrement())
  email String  @unique
  name  String?
  posts Post[]
  role  Role    @default(USER)
}

model Post {
  id        Int      @id @default(autoincrement())
  createdAt DateTime @default(now())
  updatedAt DateTime @updatedAt
  title     String
  content   String?
  published Boolean  @default(false)
  viewCount Int      @default(0)
  author    User?    @relation(fields: [authorId], references: [id])
  authorId  Int?
  // This comment is just for you. It will not be displayed.
  /// It will be displayed as description ApiProperty
  rating    Float
}

```

Will generate the following path:

```
- prisma
  - genarated
    - dtos
    - models
    - enums
```

Inside `UserModel` model:

```ts
import {
  IsNumber,
  IsNotEmpty,
  IsString,
  IsOptional,
  IsEnum,
} from 'class-validator';
import { PostModel } from './';
import { Role } from '../enums';

export class UserModel {
  @IsNotEmpty()
  @IsNumber()
  id: number;

  @IsNotEmpty()
  @IsString()
  email: string;

  @IsOptional()
  @IsString()
  name?: string;

  @IsOptional()
  posts: PostModel[];

  @IsNotEmpty()
  @IsEnum(Role)
  role: Role;
}
```

Inside `UserDto`:

```ts
import { ApiProperty } from '@nestjs/swagger';
import {
  IsNumber,
  IsNotEmpty,
  IsString,
  IsOptional,
  IsEnum,
} from 'class-validator';
import { PostDto } from './';
import { Role } from '../enums';

export class UserDto {
  @ApiProperty({ required: true })
  @IsNotEmpty()
  @IsNumber()
  id: number;

  @ApiProperty({ required: true })
  @IsNotEmpty()
  @IsString()
  email: string;

  @ApiProperty()
  @IsOptional()
  @IsString()
  name?: string;

  @ApiProperty({ required: true, type: () => PostDto })
  @IsOptional()
  posts: PostDto[];

  @ApiProperty({ required: true })
  @IsNotEmpty()
  @IsEnum(Role)
  role: Role;
}
```

## Using with Nest.js Swagger module

```ts

import { extraModels } from 'prisma/generated/dtos';
...

const document = SwaggerModule.createDocument(app, config, {
    extraModels: extraModels,
  });
```

## Additional Options

| Option                 |  Description                                | Type      |  Default      |
| ---------------------- | ------------------------------------------- | --------- | ------------- |
| `output`               | Output directory for the generated models   | `string`  | `./generated` |
| `enableModel`          | Enable generate models folder and class     | `boolean` | `true`        |
| `modelFileNameSuffix`  | Suffix model file name, ex: `user.model.ts` | `string`  | `.model`      |
| `modelClassNameSuffix` | Suffix model class name, ex: `UserModel`    | `string`  | `null`        |
| `enableSwagger`        | Enable generate dtos folder and Dto class   | `boolean` | `false`       |
| `dtoClassNameSuffix`   | Suffix dto class name, ex: `UserDto`        | `string`  | `Dto`         |
| `dtoFileNameSuffix`    | Suffix dto file name, ex: `user.dto.ts`     | `string`  | `.dto`        |
| `toLowerCase`          | Convert generated file name to lower case   | `boolean` | `false`       |

Use additional options in the `schema.prisma`

```prisma
generator nestjs_dto_generator {
  provider = "prisma-nestjs-dto-generator"
  output = "./output-generated"
  enableModel = true // default: true
  modelFileNameSuffix = ".model" // default: ".model"
  modelClassNameSuffix = "Model" // default: ""
  enableSwagger = true // default: false
  dtoClassNameSuffix = "Dto" // default: "Dto"
  dtoFileNameSuffix = ".dto" // default: ".dto"
  toLowerCase = true // field name to lower case, default: false
}
```

## Tips

Add description for `ApiProperty` can use `///` in `schema.prisma`. Follow example bellow!

In `schema.prisma`
Add `It will be displayed as description ApiProperty` description for `rating` column

```prisma
model Post {
  id        Int      @id @default(autoincrement())
  createdAt DateTime @default(now())
  updatedAt DateTime @updatedAt
  title     String
  content   String?
  published Boolean  @default(false)
  viewCount Int      @default(0)
  author    User?    @relation(fields: [authorId], references: [id])
  authorId  Int?
  // This comment is just for you. It will not be displayed.
  /// It will be displayed as description ApiProperty
  rating    Float
}
```

In `PostDto`

```ts
import { ApiProperty } from '@nestjs/swagger';
import {
  IsNumber,
  IsNotEmpty,
  IsDate,
  IsString,
  IsOptional,
  IsBoolean,
} from 'class-validator';
import { UserDto } from './';

export class PostDto {
  @ApiProperty({ required: true })
  @IsNotEmpty()
  @IsNumber()
  id: number;

  @ApiProperty({ required: true })
  @IsNotEmpty()
  @IsDate()
  createdAt: Date;

  @ApiProperty({ required: true })
  @IsNotEmpty()
  @IsDate()
  updatedAt: Date;

  @ApiProperty({ required: true })
  @IsNotEmpty()
  @IsString()
  title: string;

  @ApiProperty()
  @IsOptional()
  @IsString()
  content?: string;

  @ApiProperty({ required: true })
  @IsNotEmpty()
  @IsBoolean()
  published: boolean;

  @ApiProperty({ required: true })
  @IsNotEmpty()
  @IsNumber()
  viewCount: number;

  @ApiProperty({ type: () => UserDto })
  @IsOptional()
  author?: UserDto;

  @ApiProperty()
  @IsOptional()
  @IsNumber()
  authorId?: number;

  @ApiProperty({
    description: 'It will be displayed as description ApiProperty',
    required: true,
  })
  @IsNotEmpty()
  @IsNumber()
  rating: number;
}
```

---
_Source: https://npm.io/package/prisma-nestjs-dto-generator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._