Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/AnandChowdhary/prisma-class-validator
💎 Generate class-validator types from a Prisma project
https://github.com/AnandChowdhary/prisma-class-validator
class-transformer class-validator generator prisma prisma-client typescript
Last synced: about 1 month ago
JSON representation
💎 Generate class-validator types from a Prisma project
- Host: GitHub
- URL: https://github.com/AnandChowdhary/prisma-class-validator
- Owner: AnandChowdhary
- License: mit
- Archived: true
- Created: 2021-02-13T10:19:08.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-08-07T09:16:16.000Z (about 3 years ago)
- Last Synced: 2024-07-24T21:15:15.441Z (about 2 months ago)
- Topics: class-transformer, class-validator, generator, prisma, prisma-client, typescript
- Language: TypeScript
- Homepage: https://npmjs.com/package/prisma-class-validator
- Size: 4.88 MB
- Stars: 3
- Watchers: 4
- Forks: 3
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 💎 Prisma Class Validator
Automatically generator `class-validator` schema from Prisma client projects.
| | Status |
| - | - |
| Build | [](https://github.com/koj-co/prisma-class-validator/actions?query=workflow%3A%22Node+CI%22) [](https://libraries.io/github/koj-co/prisma-class-validator) [](https://github.com/koj-co/prisma-class-validator/releases) [](https://snyk.io/test/github/koj-co/prisma-class-validator) |
| Health | [](https://github.com/koj-co/prisma-class-validator/actions?query=workflow%3A%22License+CI%22) [](https://github.com/koj-co/prisma-class-validator/actions?query=workflow%3A%22CLA+Assistant%22) [](https://github.com/koj-co/prisma-class-validator/actions?query=workflow%3A%22Pull+Request+Labeler%22) |
| PRs | [](https://github.com/koj-co/prisma-class-validator/actions?query=workflow%3A%22PR+Generator+CI%22) [](https://github.com/koj-co/prisma-class-validator/actions?query=workflow%3A%22Merge+PRs%22) |
At Koj, we use this package to automatically generate [`@koj/types`](https://www.npmjs.com/package/@koj/types) from our Prisma schema.
## ⭐️ Features
The `readAndGenerateClassValidator` method reads your generated Prisma client (after running `npx prisma generate`) and automatically generates a class-validator schema.
First, install from npm:
```bash
npm install --save-dev prisma-class-validator
```
Usage with TypeScript/Node.js:
```ts
import { readAndGenerateClassValidator } from "prisma-class-validator";
import { writeFile } from "fs/promises";
(async () => {
const schema = await readAndGenerateClassValidator();
await writeFile("validator.ts", schema);
})();
```
Usage with JavaScript/Node.js:
```js
const { readAndGenerateClassValidator } = require("prisma-class-validator");
const { writeFile } = require("fs/promises");
(async () => {
const schema = await readAndGenerateClassValidator();
await writeFile("validator.ts", schema);
})();
```
## 💻 Example
The `generateClassValidatorFromPrismaClient` method is used to take a string consisting of generated Prisma schema and converting it to class-validator. In this case, you are expected to read the generated Prisma schema `index.d.ts` file and supply that as the input.
Example input
```ts
generateClassValidatorFromPrismaClient(`
/**
* Client
**/
import * as runtime from '@prisma/client/runtime';
/**
* Model Lead
*/
export type Lead = {
browser: string | null
city: string | null
countryCode: string | null
createdAt: Date
email: string
id: number
name: string
operatingSystem: string | null
region: string | null
responses: Prisma.JsonValue | null
timezone: string | null
updatedAt: Date
}
/**
* Model User
*/
export type User = {
active: boolean
attributes: Prisma.JsonValue | null
checkLocationOnLogin: boolean
countryCode: string
createdAt: Date
gender: Gender
}
/**
* Enums
*/
// Based on
// https://github.com/microsoft/TypeScript/issues/3192#issuecomment-261720275
export const Gender: {
FEMALE: 'FEMALE',
MALE: 'MALE',
NONBINARY: 'NONBINARY',
UNKNOWN: 'UNKNOWN'
};
export type Gender = (typeof Gender)[keyof typeof Gender]
`);
```
Resulting output
```ts
`/**
* DO NOT EDIT THIS FILE MANUALLY
* ==============================
*
* This file is automatically generated by Prisma Class Validator using @prisma/client
* Source: https://github.com/koj-co/prisma-class-validator/blob/HEAD/scripts/generate-types.ts
*/
import {
IsOptional,
IsString,
IsNumber,
IsNotEmpty,
IsBoolean,
IsObject,
IsDateString,
IsIn,
} from "class-validator";
/**
* Model Lead
*/
export class Lead {
@IsString()
@IsOptional()
browser?: string | null;
@IsString()
@IsOptional()
city?: string | null;
@IsString()
@IsOptional()
countryCode?: string | null;
@IsDateString()
@IsNotEmpty()
createdAt!: Date;
@IsString()
@IsNotEmpty()
email!: string;
@IsNumber()
@IsNotEmpty()
id!: number;
@IsString()
@IsNotEmpty()
name!: string;
@IsString()
@IsOptional()
operatingSystem?: string | null;
@IsString()
@IsOptional()
region?: string | null;
@IsObject()
@IsOptional()
responses?: any | null;
@IsString()
@IsOptional()
timezone?: string | null;
@IsDateString()
@IsNotEmpty()
updatedAt!: Date;
}
/**
* Model User
*/
export class User {
@IsBoolean()
@IsNotEmpty()
active!: boolean;
@IsObject()
@IsOptional()
attributes?: any | null;
@IsBoolean()
@IsNotEmpty()
checkLocationOnLogin!: boolean;
@IsString()
@IsNotEmpty()
countryCode!: string;
@IsDateString()
@IsNotEmpty()
createdAt!: Date;
@IsString()
@IsIn(["FEMALE", "MALE", "NONBINARY", "UNKNOWN"])
@IsNotEmpty()
gender!: Gender;
}
/**
* Enums
*/
// Based on
// https://github.com/microsoft/TypeScript/issues/3192#issuecomment-261720275
export let Gender: {
FEMALE: "FEMALE";
MALE: "MALE";
NONBINARY: "NONBINARY";
UNKNOWN: "UNKNOWN";
};
export type Gender = typeof Gender[keyof typeof Gender];`;
```
## 📄 License
[MIT](./LICENSE) © [Koj](https://koj.co)
An open source project by Koj.
Furnish your home in style, for as low as CHF175/month →