+ 
+
+
+
+
+
+
+Ts.ED Prisma
+ +[](https://github.com/tsedio/tsed/actions/workflows/build.yml) +[](https://github.com/semantic-release/semantic-release) +[](https://github.com/prettier/prettier) +[](https://opencollective.com/tsed) + ++ +## Installation + +```sh +npm i -D prisma +npm i @tsed/prisma @prisma/client +``` + +## Configuration + +After installation, you need to update your `schema.prisma` file and then add a new generator section below the `client` one: + +```prisma +generator client { + // ... +} + +generator tsed { + provider = "@tsed/prisma" +} +``` + +Then after running `npx prisma generate`, this will emit the generated Ts.ED classes and Enums to `@tsed/prisma/.schema` in `node_modules` folder. + +You can also configure the default output folder, e.g.: + +```prisma +generator tsed { + provider = "@tsed/prisma" + output = "../prisma/generated/tsed" +} +``` + +By default, when the output path contains `node_modules`, the generated code is transpiled - containing `*.js` and `*.d.ts` files that are ready to use (import) in your code. +However, if you explicitly choose an other folder in `output` config, the generated code will be emitted as raw TS files which you can use and import as your other source code files. + +You can overwrite that by explicitly setting `emitTranspiledCode` config option: + +```prisma +generator tsed { + provider = "@tsed/prisma" + output = "../prisma/generated/tsed" + emitTranspiledCode = true +} +``` + +## Usage + +Given that you have this part of datamodel definitions: + +```groovy +model User { + /// @TsED.Groups("!creation") + /// Comment + id Int @id @default(autoincrement()) + createdAt DateTime @default(now()) + /// @TsED.Email() + /// @TsED.Description("User email. This email must be unique!") + email String @unique + weight Float? + is18 Boolean? + name String? + successorId Int? + successor User? @relation("BlogOwnerHistory", fields: [successorId], references: [id]) + predecessor User? @relation("BlogOwnerHistory") + role Role @default(USER) + posts Post[] + keywords String[] + biography Json + + /// @TsED.Ignore(ctx.endpoint === true) + ignored String +} + +model Post { + id Int @id @default(autoincrement()) + user User? @relation(fields: [userId], references: [id]) + userId Int? +} + +enum Role { + USER + ADMIN +} +``` + +it will generate the following UserModel: + +```typescript +import {Integer, Required, Property, Groups, Format, Email, Description, Allow, Enum, CollectionOf} from "@tsed/schema"; +import {User} from "../client"; +import {Role} from "../enums"; +import {PostModel} from "./PostModel"; + +export class UserModel implements User { + @Property(Number) + @Integer() + @Required() + @Groups("!creation") + id: number; + + @Property(Date) + @Format("date-time") + @Required() + createdAt: Date; + + @Property(String) + @Required() + @Email() + @Description("User email. This email must be unique!") + email: string; + + @Property(Number) + @Allow(null) + weight: number | null; + + @Property(Boolean) + @Allow(null) + is18: boolean | null; + + @Property(String) + @Allow(null) + name: string | null; + + @Property(Number) + @Integer() + @Allow(null) + successorId: number | null; + + @Property(() => UserModel) + @Allow(null) + predecessor: UserModel | null; + + @Required() + @Enum(Role) + role: Role; + + @CollectionOf(() => PostModel) + @Required() + posts: PostModel[]; + + @CollectionOf(String) + @Required() + keywords: string[]; + + @Property(Object) + @Required() + biography: any; + + @Ignore((value: any, ctx: any) => ctx.endpoint === true) + ignored: string; +} +``` + +And, the following repository: + +```typescript +import {isArray} from "@tsed/core"; +import {deserialize} from "@tsed/json-mapper"; +import {Injectable, Inject} from "@tsed/di"; +import {PrismaService} from "../services/PrismaService"; +import {Prisma, User} from "../client"; +import {UserModel} from "../models"; + +@Injectable() +export class UsersRepository { + @Inject() + protected prisma: PrismaService; + + get collection() { + return this.prisma.user; + } + + get groupBy() { + return this.collection.groupBy.bind(this.collection); + } + + protected deserialize
+
+## Backers
+
+Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/tsed#backer)]
+
+
+
+## Sponsors
+
+Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/tsed#sponsor)]
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2016 - 2021 Romain Lenzotti
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/packages/orm/prisma/scripts/backup-index.cjs.js b/packages/orm/prisma/scripts/backup-index.cjs.js
new file mode 100644
index 00000000000..5b25a20da5c
--- /dev/null
+++ b/packages/orm/prisma/scripts/backup-index.cjs.js
@@ -0,0 +1,9 @@
+const tsed = require("../.schema");
+const path = require("path");
+
+module.exports = tsed;
+
+/**
+ * Annotation for ncc/zeit
+ */
+path.join(__dirname, "../.schema");
diff --git a/packages/orm/prisma/scripts/backup-index.d.ts b/packages/orm/prisma/scripts/backup-index.d.ts
new file mode 100644
index 00000000000..f4aa627148f
--- /dev/null
+++ b/packages/orm/prisma/scripts/backup-index.d.ts
@@ -0,0 +1 @@
+export * from "../.schema";
diff --git a/packages/orm/prisma/scripts/backup-index.esm.js b/packages/orm/prisma/scripts/backup-index.esm.js
new file mode 100644
index 00000000000..755d23c819e
--- /dev/null
+++ b/packages/orm/prisma/scripts/backup-index.esm.js
@@ -0,0 +1,7 @@
+import path from "path";
+export * from "../.schema";
+
+/**
+ * Annotation for ncc/zeit
+ */
+path.join(__dirname, "../.schema");
diff --git a/packages/orm/prisma/src/__mock__/createContextFixture.ts b/packages/orm/prisma/src/__mock__/createContextFixture.ts
new file mode 100644
index 00000000000..c05326d9658
--- /dev/null
+++ b/packages/orm/prisma/src/__mock__/createContextFixture.ts
@@ -0,0 +1,23 @@
+import {TransformContext} from "../generator/domain/TransformContext";
+
+export function createContextFixture(): TransformContext {
+ return {
+ modelsMap: new Map()
+ .set("User", {
+ name: "User",
+ fields: [{type: "Role"}]
+ })
+ .set("Role", {
+ name: "Role",
+ fields: [{type: "User"}, {type: "Transitive"}]
+ })
+ .set("Transitive", {
+ name: "Transitive",
+ fields: [{type: "String"}, {type: "User"}]
+ })
+ .set("Hello", {
+ name: "Hello",
+ fields: [{type: "String"}, {type: "User"}]
+ })
+ } as any;
+}
diff --git a/packages/orm/prisma/src/__mock__/createDmmfFieldFixture.ts b/packages/orm/prisma/src/__mock__/createDmmfFieldFixture.ts
new file mode 100644
index 00000000000..393d0b00092
--- /dev/null
+++ b/packages/orm/prisma/src/__mock__/createDmmfFieldFixture.ts
@@ -0,0 +1,31 @@
+import {DmmfField} from "../generator/domain/DmmfField";
+
+export interface FieldFixtureOptions {
+ kind: string;
+ name: string;
+ isRequired: boolean;
+ isNullable: boolean;
+ type: string;
+ isList: boolean;
+ documentation: string;
+ isInputType: boolean;
+}
+
+export function createDmmfFieldFixture(options: Partial