prisma-generator-express 1.0.0 → 1.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 multipliedtwice
+
+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.

package/README.md

@@ -0,0 +1,179 @@
+# Prisma Generator Express
+
+[![npm version](https://badge.fury.io/js/prisma-generator-express.svg)](https://badge.fury.io/js/prisma-generator-express)
+[![npm](https://img.shields.io/npm/dt/prisma-generator-express.svg)](https://www.npmjs.com/package/prisma-generator-express)
+[![HitCount](https://hits.dwyl.com/multipliedtwice/prisma-generator-express.svg?style=flat)](http://hits.dwyl.com/multipliedtwice/prisma-generator-express)
+[![npm](https://img.shields.io/npm/l/prisma-generator-express.svg)](LICENSE)
+
+This tool helps you quickly create API endpoints in your Express app using your Prisma models.
+
+When you run `npx prisma generate`, it automatically creates two things:
+
+- Service functions that you can import into your Express routes. By default these functions handle CRUD operations and output validation. This behavior can be controlled.
+- Router generator function that lets you select which routes to add to the application and which middlewares to apply.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Customizations](#customizations)
+- [Request Object Properties](#request-object-properties)
+
+# Installation
+
+Using npm:
+
+```bash
+ npm install prisma-generator-express
+```
+
+Using yarn:
+
+```bash
+ yarn add prisma-generator-express
+```
+
+# Basic usage
+
+- Include this generator in your schema.prisma file:
+
+```prisma
+generator express {
+  provider = "prisma-generator-express"
+}
+```
+
+- Generate your middleware functions by running:
+
+```bash
+  npx prisma generate
+```
+
+- Attach Prisma instance
+
+```ts
+import { PrismaClient } from '@prisma/client'
+import express from 'express'
+
+const prisma = new PrismaClient()
+const app = express()
+
+app.use(express.json()) // for parsing application/json
+
+// Attach Prisma to every request
+app.use((req, res, next) => {
+  req.prisma = prisma
+  next()
+})
+```
+
+- Here’s how you can use a generated function in your Express app:
+
+```ts
+import { UserFindUnique } from './generated/UserFindUnique' // Adjust the path as necessary
+import { FindUniqueUserSchema } from './prisma-zod-generator/schemas/FindUniqueUser.schema' // Adjust the path as necessary
+import { FindUniqueUserSchemaOutput } from './prisma-zod-generator/schemas/FindUniqueUserOutput.schema' // Adjust the path as necessary
+
+// move this to /helpers
+export function validateQuery(schema: ZodSchema) {
+  return async (req: Request, res: Response, next: NextFunction) => {
+    try {
+      req.query = schema.parse(req.query)
+      next()
+    } catch (error) {
+      res.status(400).json({
+        error: 'Input Validation failed',
+        details: error.errors,
+      })
+    }
+  }
+}
+
+app.get(
+  '/user/:id',
+  validateQuery(FindUniqueUserSchema),
+  async (req, res, next) => {
+    // Attach generated Zod schema for output validation
+    req.outputValidation = FindUniqueUserOutput
+
+    // Use the generated middleware to handle the request
+    await UserFindUnique(req, res, next)
+  },
+)
+```
+
+The `UserFindUnique` function will fetch the user details from the database, validate the output with Zod, and handle the API response.
+
+# Router generator usage
+
+The library will create functions to generate routers per each model in schema. Each route can accept middleware that will be injected right before generated handler is invoked. You can use it to modify/remove/validate request payload. The output validation can be also attached to `req` object on this step.
+
+```ts
+import express from 'express'
+import { UserRouter } from './path/to/generated/UserRouter' // Adjust the path as necessary
+import { UserFindManyArgs } from './prisma-zod-generator/schemas/UserFindManyArgs.schema' // Adjust the path as necessary
+
+const app = express()
+
+export const validateUserQuery = (
+  req: Request,
+  res: Response,
+  next: NextFunction,
+) => {
+  try {
+    UserFindManyArgs.parse(req.query)
+    next()
+  } catch (error) {
+    if (error instanceof ZodError) {
+      return res.status(400).json({
+        message: 'Validation failed',
+        errors: error.errors,
+      })
+    }
+    next(error)
+  }
+}
+
+const userRouterConfig = {
+  findManyMiddleware: [validateUserQuery], // Add other middleware as needed
+  findUniqueMiddleware: undefined, // This can be omitted, route won't be generated if middleware is not provided
+}
+
+// Use the router in your application
+app.use('/users', UserRouter(userRouterConfig))
+
+app.listen(3000, () => {
+  console.log('Server is running on http://localhost:3000')
+})
+```
+
+## Request Object Properties
+
+The following properties can be attached to the `req` object to control the behavior of generated middleware:
+
+| Property               | Type         | Description                                                                                                                                                                        |
+| ---------------------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `prisma`               | PrismaClient | An instance of PrismaClient that allows the middleware to interact with your database.                                                                                             |
+| `passToNext`           | boolean      | Optional, if `true` - the result of a Prisma request will be passed to a next middleware as `req.locals.data`                                                                      |
+| `query`                | Object       | A structured object that conforms to Prisma's API for the selected method.                                                                                                         |
+| `outputValidation`     | ZodTypeAny   | (Optional) A Zod schema used to validate the data returned from the Prisma query before sending it to the client. This helps ensure the response adheres to expected data formats. |
+| `omitOutputValidation` | Boolean      | (Optional) A flag that, if set to `true`, disables output validation even if a Zod schema is provided.                                                                             |
+
+## Roadmap
+
+| Function       | Supported          | Notes      |
+| -------------- | ------------------ | ---------- |
+| `Model router` | :white_check_mark: | Available. |
+| `findUnique`   | :white_check_mark: | Available. |
+| `findFirst`    | :white_check_mark: | Available. |
+| `findMany`     | :white_check_mark: | Available. |
+| `create`       | :white_check_mark: | Available. |
+| `createMany`   | :white_check_mark: | Available. |
+| `update`       | :white_check_mark: | Available. |
+| `updateMany`   | :white_check_mark: | Available. |
+| `upsert`       | :white_check_mark: | Available. |
+| `delete`       | :white_check_mark: | Available. |
+| `deleteMany`   | :white_check_mark: | Available. |
+| `aggregate`    | :white_check_mark: | Available. |
+| `count`        | :white_check_mark: | Available. |
+| `groupBy`      | :white_check_mark: | Available. |

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "prisma-generator-express",
   "description": "Prisma generator of Express CRUD API",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "main": "dist/generator.js",
   "license": "MIT",
   "bin": {