prisma-generator-express 1.14.1 → 1.14.2

package/README.md

@@ -10,7 +10,7 @@ This tool helps you quickly create API endpoints in your Express app using your
 
 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.
+- 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
@@ -19,7 +19,7 @@ When you run `npx prisma generate`, it automatically creates two things:
 - [Basic Usage](#basic-usage)
 - [Router Generator Usage](#router-generator-usage)
 - [Request Object Properties](#request-object-properties)
-- [Roadmap](#roadmap)
+- [Router Schema](#router-schema)
 
 # Installation
 
@@ -72,7 +72,7 @@ app.use((req, res, 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 { UserFindUnique } from './generated/api/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
 
@@ -133,7 +133,7 @@ const addPrisma: RequestHandler = (
   next: NextFunction,
 ) => {
   req.prisma = prisma
-  // req.omitOutputValidation = true (not required if you use `select` instead of `include`)
+  // req.omitOutputValidation = true (output validation is not required if you use `select` instead of `include`)
   next()
 }
 
@@ -166,12 +166,12 @@ const afterFindFirst: RequestHandler = (
  * For generated route the middleware order will be as follows:
  * 1. Query parser (kicks in for GET requests)
  * 2. Custom middlewares: config.{method}.before[]
- * 3. Input validator middleware (Optional): config.{method}.input
+ * 3. Input validator middleware (Optional): config.{method}.input. For GET request validates `req.query`, for others - `req.body`
  * 4. Generated middleware
  * 5. Output validator middleware: config.{method}.input
  * 6. Custom middlewares: config.{method}.after[] (not available if req.passToNext is falsy)
  */
-const someRouterConfig: RouteConfig<RequestHandler> = {
+const userAccounRouterConfig: RouteConfig<RequestHandler> = {
   FindFirst: {
     before: [beforeFindFirst],
     after: [afterFindFirst],
@@ -194,7 +194,7 @@ const someRouterConfig: RouteConfig<RequestHandler> = {
 }
 
 app.use(addPrisma)
-app.use(UserAccountRouter(someRouterConfig))
+app.use(UserAccountRouter(userAccounRouterConfig))
 
 app.listen(3000, () => {
   console.log('Server is running on http://localhost:3000')
@@ -208,9 +208,8 @@ The following properties can be attached to the `req` object to control the beha
 | 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 `if (req.locals) 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. |
+| `passToNext`           | boolean      | Optional, if `true` - the result of a Prisma request will be passed to the next middleware as `if (req.locals) req.locals.data`                                                      |
+| `outputValidation`     | ZodTypeAny   | (Optional) A Zod schema used to validate the data returned from the Prisma query before sending it to the client. |
 | `omitOutputValidation` | Boolean      | (Optional) A flag that, if set to `true`, disables output validation even if a Zod schema is provided.                                                                             |
 
 ## Router Schema
@@ -219,7 +218,10 @@ The following properties can be attached to the `req` object to control the beha
 | ------------ | -------- | ------------ |
 | `findUnique` | `GET`    | `/:id`       |
 | `findFirst`  | `GET`    | `/first`     |
-| `FindFirst`  | `GET`    | `/`          |
+| `findMany`   | `GET`    | `/`          |
+| `aggregate`  | `GET`    | `/aggregate` |
+| `count`      | `GET`    | `/count`     |
+| `groupBy`    | `GET`    | `/groupby`   |
 | `create`     | `POST`   | `/`          |
 | `createMany` | `POST`   | `/many`      |
 | `update`     | `PUT`    | `/`          |
@@ -227,9 +229,7 @@ The following properties can be attached to the `req` object to control the beha
 | `upsert`     | `PATCH`  | `/`          |
 | `delete`     | `DELETE` | `/`          |
 | `deleteMany` | `DELETE` | `/many`      |
-| `aggregate`  | `GET`    | `/aggregate` |
-| `count`      | `GET`    | `/count`     |
-| `groupBy`    | `GET`    | `/groupby`   |
+
 
 ## Helper functions
 
@@ -248,7 +248,7 @@ interface ValidatorOptions {
 
 ### encodeQueryParams(params: Params)
 
-Can be used on frontend to encode Prisma compatible queries. Alternatively `qs` can be used, but it probably won't work with `OR: [{ blah: false }, { blah: null }]` or some other edge cases.
+It can be used on the frontend to encode Prisma-compatible queries. Alternatively `qs` can be used, but it probably won't work with `OR: [{ blah: false }, { blah: null }]` or some other edge cases.
 
 ```ts
 type RecursiveUrlParams = {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "prisma-generator-express",
   "description": "Prisma generator of Express CRUD API",
-  "version": "1.14.1",
+  "version": "1.14.2",
   "main": "dist/generator.js",
   "license": "MIT",
   "bin": {
@@ -35,12 +35,12 @@
     "@types/express": "^4.17.21",
     "@types/jest": "29.5.12",
     "@types/lodash": "^4.17.4",
-    "@types/node": "20.12.12",
+    "@types/node": "20.12.13",
     "@types/prettier": "3.0.0",
     "jest": "29.7.0",
     "prisma": "5.14.0",
     "semantic-release": "^23.1.1",
-    "ts-jest": "29.1.3",
+    "ts-jest": "29.1.4",
     "typescript": "5.4.5"
   },
   "homepage": "https://github.com/multipliedtwice/prisma-generator-express/blob/master/README.md",