Prisma tRPC Shield Generator
Automatically generate a tRPC Shield from your Prisma Schema. Updates every time npx prisma generate runs.
Table of Contents
Installation
Using npm:
npm install prisma-trpc-shield-generator
Using yarn:
yarn add prisma-trpc-shield-generator
Usage
1- Star this repo
2- Install tRPC Shield
npm install trpc-shield
3- Add the generator to your Prisma schema
generator trpc_shield {
provider = "prisma-trpc-shield-generator"
}
4- Running npx prisma generate for the following schema.prisma
model User {
id Int @id @default(autoincrement())
email String @unique
name String?
posts Post[]
}
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?
}
will generate the following shield
import { shield, allow } from 'trpc-shield';
export const permissions = shield({
query: {
aggregatePost: allow,
aggregateUser: allow,
findFirstPost: allow,
findFirstUser: allow,
findManyPost: allow,
findManyUser: allow,
findUniquePost: allow,
findUniqueUser: allow,
groupByPost: allow,
groupByUser: allow,
},
mutation: {
createOnePost: allow,
createOneUser: allow,
deleteManyPost: allow,
deleteManyUser: allow,
deleteOnePost: allow,
deleteOneUser: allow,
updateManyPost: allow,
updateManyUser: allow,
updateOnePost: allow,
updateOneUser: allow,
upsertOnePost: allow,
upsertOneUser: allow,
},
});
5- Attach generated shield as a middleware to your top-level router
export function createProtectedRouter() {
return (
trpc
.router<Context>()
.middleware(permissions)
);
}
Additional Options
| Option | Description | Type | Default |
|---|---|---|---|
output |
Output directory for the generated tRPC Shield | string |
./generated |
Use additional options in the schema.prisma
generator trpc_shield {
provider = "prisma-trpc-shield-generator"
output = "./shield"
}
26 Dec 24, 2022
17 Dec 17, 2022
39 Dec 2, 2022
65 Dec 28, 2022
115 Dec 19, 2022
187 Dec 21, 2022
6 Oct 12, 2022