# prisma-generator-omit-extra-fields
> protect prisma from extra fields
Latest version **0.3.2** (published 2023-10-28) · MIT license · 0 weekly downloads
## Install
```sh
npm install prisma-generator-omit-extra-fields
pnpm add prisma-generator-omit-extra-fields
yarn add prisma-generator-omit-extra-fields
bun add prisma-generator-omit-extra-fields
```
Provides the command `prisma-generator-omit-extra-fields`.
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support; pre 1.0.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 0.3.2 |
| Published | 2023-10-28 |
| First published | 2023-02-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 32 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Eugene Tree |
| Maintainers | eugenetree |
| Keywords | prisma2, prisma, prisma-generator, prisma-schema, code-generation, extra-fields, extra fields, omit, fields |
## Links
- npm: https://www.npmjs.com/package/prisma-generator-omit-extra-fields
- Repository: https://github.com/eugenetree/prisma-generator-omit-extra-fields
- Issues: https://github.com/eugenetree/prisma-generator-omit-extra-fields/issues
- npm.io page: https://npm.io/package/prisma-generator-omit-extra-fields
## Dependencies (2)
- [prettier](https://npm.io/package/prettier.md) ^2.8.4
- [@prisma/generator-helper](https://npm.io/package/@prisma/generator-helper.md) ^4.10.1
## 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.3.2 (latest) — 2023-10-28
- 0.3.1 — 2023-02-27
- 0.3.0 — 2023-02-27
- 0.2.0 — 2023-02-25
- 0.1.1 — 2023-02-25
## README
prisma-generator-omit-extra-fields
[](https://badge.fury.io/js/prisma-generator-omit-extra-fields)
[](https://www.npmjs.com/package/prisma-generator-omit-extra-fields)
[](http://hits.dwyl.com/eugenetree/prisma-generator-omit-extra-fields)
## Table of Contents
- [Motivation](#motivation)
- [Installation](#installation)
- [Usage](#usage)
# Motivation
Motivation of this generator - fix typescript and prisma mismatch in case of "exact" types.
In typescript, if value has all required fields and some extra fields - typescript will be satisfied:
```typescript
type Person = {
first: string, last: string
}
declare function savePerson(person: Person);
const tooFew = { first: 'Stefan' };
const exact = { first: 'Stefan', last: 'Baumgartner' }
const tooMany = { first: 'Stefan', last: 'Baumgartner', age: 37 }
savePerson(tooFew); // 💥 doesn't work
savePerson(exact); // ✅ satisfies the contract
savePerson(tooMany); // ✅ satisfies the contract
// example from "https://fettblog.eu/"
```
But despite typescript satisfaction, prisma will throw error in case of having extra fields being passed.
As a solution - this generator creates utility functions to omit extra fields.
Links related to this problem:
- [github issue](https://github.com/prisma/prisma/issues/5220)
- [stackoverflow question](https://stackoverflow.com/questions/71101647/how-to-ignore-extra-fields-when-storing-prisma-data)
# Installation
Using npm:
```bash
npm i --save-dev prisma-generator-omit-extra-fields
```
Using yarn:
```bash
yarn add -D prisma-generator-omit-extra-fields
```
# Usage
1 - Add the generator to your Prisma schema
```prisma
generator omitExtraFields {
provider = "prisma-generator-omit-extra-fields"
// optional parameter to change directory or name of generated file
// if output is specified, it should contain filename of generated file
// (output like "../generated" is invalid)
output = "../generated/extra-fields.ts"
}
```
2- Run `npx prisma generate` for the following schema.prisma, or your schema
```prisma
enum Role {
Admin
Default
}
model User {
id Int @id @default(autoincrement())
createdAt DateTime @default(now())
updatedAt DateTime @updatedAt
name String
email String
role Role
}
```
3 - Now you're able to use generated functions. For above schema you'll get next functions:
```typescript
polishUser(user); // remove extra fields but has no explicit types
polishDefaultUser(user); // remove extra fields and is suitable for "data" field in queries
polistPartialUser(user); // remove extra fields and is suitalble for "where" field in queries
```
Example of their usage:
```typescript
const userWithExtraFields = {
email: 'test@gmail.com',
name: 'test',
role: 'Default',
a: 1, // extra field
} as const;
// typescript is satisfied, but prisma will throw error
// because of extra field 'a: 1'
prisma.user.create({ data: userWithExtraFields });
// this one will be fine for prisma
prisma.user.create({ data: polishUser(userWithExtraFields) })
// or this one, if you want more excplicit types
prisma.user.create({ data: polishDefaultUser(userWithExtraFields) });
prisma.user.findFirst({ where: polishPartialUser(userWithExtraFields) });
```
---
_Source: https://npm.io/package/prisma-generator-omit-extra-fields · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._