prisma-generator-express 1.1.0 → 1.3.0

package/src/helpers/generateFindUnique.ts

@@ -0,0 +1,68 @@
+import { DMMF } from '@prisma/generator-helper'
+import { lowercaseFirstLetter } from '../utils/strings'
+/**
+ * Generates an Express middleware function that includes conditional output validation with Zod.
+ * This version dynamically includes the correct type for the query parameter based on the Prisma model.
+ * @param options - The options containing the model name and the import statement for Prisma types.
+ * @returns {string} - The generated middleware function as a string.
+ */
+export const generateFindUniqueFunction = (options: {
+  model: DMMF.Model
+  prismaImportStatement: string
+}): string => {
+  const { model, prismaImportStatement } = options
+  const modelName = model.name
+  const functionName = `${modelName}FindUnique`
+  const queryTypeName = `Prisma.${modelName}FindUniqueArgs`
+
+  return `
+${prismaImportStatement.replace('{ Prisma }', `{ Prisma, ${modelName} }`)}
+import { Request, Response, NextFunction } from 'express'
+import {
+  RequestHandler,
+  ParamsDictionary,
+} from 'express-serve-static-core' 
+import { ParsedQs } from 'qs';
+import { ZodTypeAny } from 'zod';
+
+export interface FindUniqueRequest extends Request {
+  prisma: PrismaClient;
+  query: ${queryTypeName} & ParsedQs;
+  outputValidation?: ZodTypeAny;
+  omitOutputValidation?: boolean;
+  passToNext?: boolean;
+  locals: {
+    data?: ${modelName} | null
+  }
+}
+export type FindUniqueMiddleware = RequestHandler<ParamsDictionary, any, any, ${queryTypeName} & ParsedQs, Record<string, any>>
+
+export async function ${functionName}(req: FindUniqueRequest, res: Response, next: NextFunction) {
+  try {
+    if (!req.outputValidation && !req.omitOutputValidation) {
+      throw new Error('Output validation schema or omission flag must be provided.');
+    }
+
+    const data = await req.prisma.${lowercaseFirstLetter(modelName)}.findUnique(req.query as ${queryTypeName});
+    if (req.passToNext) {
+      req.locals.data = data;
+      next();
+    } else if (!req.omitOutputValidation && req.outputValidation) {
+      const validationResult = req.outputValidation.safeParse(data);
+      if (validationResult.success) {
+        res.status(200).json(validationResult.data);
+      } else {
+        res.status(400).json({ error: 'Invalid data format', details: validationResult.error });
+      }
+    } else if (!req.omitOutputValidation) {
+      throw new Error('Output validation schema must be provided unless explicitly omitted. Attach omitOutputValidation = true to request to suppress this error.');
+    } else {
+      res.status(200).json(data);
+    }
+  } catch (error) {
+    console.error('Error in handling request:', error);
+    res.status(500).json({ error: error.message });
+    next(error);
+  }
+}`
+}

package/src/helpers/generateGroupBy.ts

@@ -0,0 +1,62 @@
+import { DMMF } from '@prisma/generator-helper'
+import { lowercaseFirstLetter } from '../utils/strings'
+import { PrismaClient, Prisma } from '@prisma/client'
+
+/**
+ * Generates an Express middleware function that handles groupBy queries
+ * and includes conditional output validation with Zod.
+ * This version dynamically includes the correct type for the arguments based on the Prisma model.
+ * @param options - The options containing the model name and the import statement for Prisma types.
+ * @returns {string} - The generated middleware function as a string.
+ */
+export const generateGroupByFunction = (options: {
+  model: DMMF.Model
+  prismaImportStatement: string
+}): string => {
+  const { model, prismaImportStatement } = options
+  const modelName = model.name
+  const functionName = `${modelName}GroupBy`
+  const argsTypeName = `Prisma.${modelName}GroupByArgs`
+
+  return `
+${prismaImportStatement}
+import { Request, Response, NextFunction } from 'express';
+import { RequestHandler, ParamsDictionary } from 'express-serve-static-core';
+import { ParsedQs } from 'qs';
+import { ZodTypeAny } from 'zod';
+
+interface GroupByRequest extends Request {
+  prisma: PrismaClient;
+  query: Partial<${argsTypeName}> & ParsedQs;
+  outputValidation?: ZodTypeAny;
+  omitOutputValidation?: boolean;
+}
+
+export type GroupByMiddleware = RequestHandler<ParamsDictionary, any, {}, ParsedQs>;
+
+export async function ${functionName}(req: GroupByRequest, res: Response, next: NextFunction) {
+  try {
+    if (!req.outputValidation && !req.omitOutputValidation) {
+      throw new Error('Output validation schema or omission flag must be provided.');
+    }
+
+    // @ts-ignore
+    const result = await req.prisma.${lowercaseFirstLetter(modelName)}.groupBy(req.query);
+
+    if (!req.omitOutputValidation && req.outputValidation) {
+      const validationResult = req.outputValidation.safeParse(result);
+      if (validationResult.success) {
+        res.status(200).json(validationResult.data);
+      } else {
+        res.status(400).json({ error: 'Invalid data format', details: validationResult.error });
+      }
+    } else {
+      res.status(200).json(result);
+    }
+  } catch (error) {
+    console.error('Error in handling groupBy request:', error);
+    res.status(500).json({ error: error.message });
+    next(error);
+  }
+}`
+}

package/src/helpers/generateImportPrismaStatement.ts

@@ -0,0 +1,38 @@
+import { GeneratorOptions } from '@prisma/generator-helper'
+import path from 'path'
+
+interface ImportPrismaStatementOptions {
+  outputPath: string
+}
+
+function getImportGeneratorOptions(
+  options: GeneratorOptions,
+): ImportPrismaStatementOptions {
+  const clientGenerator = options.otherGenerators.find(
+    (gen) => gen.name === 'client',
+  )
+
+  if (!clientGenerator || !clientGenerator.output?.value) {
+    throw new Error('Prisma client generator not found.')
+  }
+
+  const modelDirPath = path.join(
+    options.generator.output?.value!,
+    'modelFolder', // workaround for saving with /modelName/operation structure
+  )
+  const clientOutputPath = clientGenerator.output.value
+
+  const relativeImportPath = path.relative(modelDirPath, clientOutputPath)
+
+  return {
+    outputPath: relativeImportPath.split(path.sep).join(path.posix.sep),
+  }
+}
+
+export function generateImportPrismaStatement(
+  generatorOptions: GeneratorOptions,
+): string {
+  const options = getImportGeneratorOptions(generatorOptions)
+  // console.log('options.outputPath :>> ', options.outputPath)
+  return `import type { Prisma } from '${options.outputPath}';\nimport type { PrismaClient } from '${options.outputPath}';\n`
+}

package/src/helpers/generateRouteFile.ts

@@ -0,0 +1,183 @@
+import { DMMF } from '@prisma/generator-helper'
+
+export function generateRouterFunction({
+  model,
+}: {
+  model: DMMF.Model
+}): string {
+  const modelName = model.name
+  const routerFunctionName = `${modelName}Router`
+
+  return `
+import express, { RequestHandler } from 'express';
+import { ${modelName}FindFirst, type FindFirstMiddleware } from './${modelName}FindFirst';
+import { ${modelName}FindMany, type FindManyMiddleware } from './${modelName}FindMany';
+import { ${modelName}FindUnique, type FindUniqueMiddleware } from './${modelName}FindUnique';
+import { ${modelName}Create, type CreateMiddleware } from './${modelName}Create';
+import { ${modelName}CreateMany, type CreateManyMiddleware } from './${modelName}CreateMany';
+import { ${modelName}Update, type UpdateMiddleware } from './${modelName}Update';
+import { ${modelName}UpdateMany, type UpdateManyMiddleware } from './${modelName}UpdateMany';
+import { ${modelName}Upsert, type UpsertMiddleware } from './${modelName}Upsert';
+import { ${modelName}Delete, type DeleteMiddleware } from './${modelName}Delete';
+import { ${modelName}DeleteMany, type DeleteManyMiddleware } from './${modelName}DeleteMany';
+import { ${modelName}Aggregate, type AggregateMiddleware } from './${modelName}Aggregate';
+import { ${modelName}Count, type CountMiddleware } from './${modelName}Count';
+import { ${modelName}GroupBy, type GroupByMiddleware } from './${modelName}GroupBy';
+
+interface RouteConfig {
+  findFirstMiddleware?: FindFirstMiddleware[]
+  findFirstNextMiddleware?: RequestHandler[]
+
+  findManyMiddleware?: FindManyMiddleware[]
+  findManyNextMiddleware?: RequestHandler[]
+  
+  findUniqueMiddleware?: FindUniqueMiddleware[]
+  findUniqueNextMiddleware?: RequestHandler[]
+
+  createMiddleware?: CreateMiddleware[]
+  createNextMiddleware?: RequestHandler[]
+
+  createManyMiddleware?: CreateManyMiddleware[]
+  createManyNextMiddleware?: RequestHandler[]
+
+  updateMiddleware?: UpdateMiddleware[]
+  updateNextMiddleware?: RequestHandler[]
+
+  updateManyMiddleware?: UpdateManyMiddleware[]
+  updateManyNextMiddleware?: RequestHandler[]
+
+  upsertMiddleware?: UpsertMiddleware[]
+  upsertNextMiddleware?: RequestHandler[]
+
+  deleteMiddleware?: DeleteMiddleware[]
+  deleteNextMiddleware?: RequestHandler[]
+
+  deleteManyMiddleware?: DeleteManyMiddleware[]
+  deleteManyNextMiddleware?: RequestHandler[]
+
+  aggregateMiddleware?: AggregateMiddleware[]
+  aggregateNextMiddleware?: RequestHandler[]
+
+  countMiddleware?: CountMiddleware[]
+  countNextMiddleware?: RequestHandler[]
+
+  groupByMiddleware?: GroupByMiddleware[]
+  groupByNextMiddleware?: RequestHandler[]
+}
+
+/**
+ * Generates an Express router for ${modelName} model.
+ * @param config Contains optional middleware to enable routes.
+ * @returns {express.Router}
+ */
+export function ${routerFunctionName}(config: RouteConfig) {
+  const router = express.Router();
+  
+  if (config?.findFirstMiddleware && config?.findFirstMiddleware.length) {
+    const middlewares = [...config.findFirstMiddleware, ${modelName}FindFirst]
+    if (config.findFirstNextMiddleware) {
+      middlewares.push(...config.findFirstNextMiddleware);
+    }
+    router.get('/first', ...middlewares as FindFirstMiddleware[]);
+  }
+
+  if (config?.findManyMiddleware && config?.findManyMiddleware.length) {
+    const middlewares = [...config.findManyMiddleware, ${modelName}FindMany]
+    if (config.findManyNextMiddleware) {
+      middlewares.push(...config.findManyNextMiddleware);
+    }
+    router.get('/', ...middlewares as FindManyMiddleware[]);
+  }
+
+  if (config?.findUniqueMiddleware && config?.findUniqueMiddleware.length) {
+    const middlewares = [...config.findUniqueMiddleware, ${modelName}FindUnique]
+    if (config.findUniqueNextMiddleware) {
+      middlewares.push(...config.findUniqueNextMiddleware);
+    }
+    router.get('/:id', ...middlewares as FindUniqueMiddleware[]);
+  }
+
+  if (config?.createMiddleware && config?.createMiddleware.length) {
+    const middlewares = [...config.createMiddleware, ${modelName}Create]
+    if (config.createNextMiddleware) {
+      middlewares.push(...config.createNextMiddleware);
+    }
+    router.post('/', ...middlewares as CreateMiddleware[]);
+  }
+
+  if (config?.createManyMiddleware && config?.createManyMiddleware.length) {
+    const middlewares = [...config.createManyMiddleware, ${modelName}CreateMany]
+    if (config.createManyNextMiddleware) {
+      middlewares.push(...config.createManyNextMiddleware);
+    }
+    router.post('/many', ...middlewares as CreateManyMiddleware[]);
+  }
+
+  if (config?.updateMiddleware && config?.updateMiddleware.length) {
+    const middlewares = [...config.updateMiddleware, ${modelName}Update]
+    if (config.updateNextMiddleware) {
+      middlewares.push(...config.updateNextMiddleware);
+    }
+    router.put('/', ...middlewares as UpdateMiddleware[]);
+  }
+
+  if (config?.updateManyMiddleware && config?.updateManyMiddleware.length) {
+    const middlewares = [...config.updateManyMiddleware, ${modelName}UpdateMany]
+    if (config.updateManyNextMiddleware) {
+      middlewares.push(...config.updateManyNextMiddleware);
+    }
+    router.put('/many', ...middlewares as UpdateManyMiddleware[]);
+  }
+
+  if (config?.upsertMiddleware && config?.upsertMiddleware.length) {
+    const middlewares = [...config.upsertMiddleware, ${modelName}Upsert]
+    if (config.upsertNextMiddleware) {
+      middlewares.push(...config.upsertNextMiddleware);
+    }
+    router.patch('/', ...middlewares as UpsertMiddleware[]);
+  }
+
+  if (config?.deleteMiddleware && config?.deleteMiddleware.length) {
+    const middlewares = [...config.deleteMiddleware, ${modelName}Delete]
+    if (config.deleteNextMiddleware) {
+      middlewares.push(...config.deleteNextMiddleware);
+    }
+    router.delete('/', ...middlewares as DeleteMiddleware[]);
+  }
+
+  if (config?.deleteManyMiddleware && config?.deleteManyMiddleware.length) {
+    const middlewares = [...config.deleteManyMiddleware, ${modelName}DeleteMany]
+    if (config.deleteManyNextMiddleware) {
+      middlewares.push(...config.deleteManyNextMiddleware);
+    }
+    router.delete('/many', ...middlewares as DeleteManyMiddleware[]);
+  }
+
+  if (config?.aggregateMiddleware && config?.aggregateMiddleware.length) {
+    const middlewares = [...config.aggregateMiddleware, ${modelName}Aggregate]
+    if (config.aggregateNextMiddleware) {
+      middlewares.push(...config.aggregateNextMiddleware);
+    }
+    router.get('/aggregate', ...middlewares as AggregateMiddleware[]);
+  }
+
+  if (config?.countMiddleware && config?.countMiddleware.length) {
+    const middlewares = [...config.countMiddleware, ${modelName}Count]
+    if (config.countNextMiddleware) {
+      middlewares.push(...config.countNextMiddleware);
+    }
+    router.get('/count', ...middlewares as CountMiddleware[]);
+  }
+
+  if (config?.groupByMiddleware && config?.groupByMiddleware.length) {
+    const middlewares = [...config.groupByMiddleware, ${modelName}GroupBy]
+    if (config.groupByNextMiddleware) {
+      middlewares.push(...config.groupByNextMiddleware);
+    }
+    router.get('/groupby', ...middlewares as GroupByMiddleware[]);
+  }
+
+  return router;
+}
+`
+}

package/src/helpers/generateUpdate.ts

@@ -0,0 +1,59 @@
+import { DMMF } from '@prisma/generator-helper'
+import { lowercaseFirstLetter } from '../utils/strings'
+/**
+ * Generates an Express middleware function that handles updating records and includes conditional output validation with Zod.
+ * This version dynamically includes the correct type for the arguments based on the Prisma model.
+ * @param options - The options containing the model name and the import statement for Prisma types.
+ * @returns {string} - The generated middleware function as a string.
+ */
+export const generateUpdateFunction = (options: {
+  model: DMMF.Model
+  prismaImportStatement: string
+}): string => {
+  const { model, prismaImportStatement } = options
+  const modelName = model.name
+  const functionName = `${modelName}Update`
+  const argsTypeName = `Prisma.${modelName}UpdateArgs`
+
+  return `
+${prismaImportStatement}
+import { Request, Response, NextFunction } from 'express';
+import { RequestHandler, ParamsDictionary } from 'express-serve-static-core';
+import { ZodTypeAny } from 'zod';
+
+interface UpdateRequest extends Request {
+  prisma: PrismaClient;
+  body: ${argsTypeName};
+  outputValidation?: ZodTypeAny;
+  omitOutputValidation?: boolean;
+}
+
+export type UpdateMiddleware = RequestHandler<ParamsDictionary, any, ${argsTypeName}, Record<string, any>>
+
+export async function ${functionName}(req: UpdateRequest, res: Response, next: NextFunction) {
+  try {
+    if (!req.outputValidation && !req.omitOutputValidation) {
+      throw new Error('Output validation schema or omission flag must be provided.');
+    }
+
+    const data = await req.prisma.${lowercaseFirstLetter(modelName)}.update(req.body);
+
+    if (!req.omitOutputValidation && req.outputValidation) {
+      const validationResult = req.outputValidation.safeParse(data);
+      if (validationResult.success) {
+        res.status(200).json(validationResult.data);
+      } else {
+        res.status(400).json({ error: 'Invalid data format', details: validationResult.error });
+      }
+    } else if (!req.omitOutputValidation) {
+      throw new Error('Output validation schema must be provided unless explicitly omitted.');
+    } else {
+      res.status(200).json(data);
+    }
+  } catch (error) {
+    console.error('Error in handling update request:', error);
+    res.status(500).json({ error: error.message });
+    next(error);
+  }
+}`
+}

package/src/helpers/generateUpdateMany.ts

@@ -0,0 +1,59 @@
+import { DMMF } from '@prisma/generator-helper'
+import { lowercaseFirstLetter } from '../utils/strings'
+/**
+ * Generates an Express middleware function that handles updating multiple records and includes conditional output validation with Zod.
+ * This version dynamically includes the correct type for the arguments based on the Prisma model.
+ * @param options - The options containing the model name and the import statement for Prisma types.
+ * @returns {string} - The generated middleware function as a string.
+ */
+export const generateUpdateManyFunction = (options: {
+  model: DMMF.Model
+  prismaImportStatement: string
+}): string => {
+  const { model, prismaImportStatement } = options
+  const modelName = model.name
+  const functionName = `${modelName}UpdateMany`
+  const argsTypeName = `Prisma.${modelName}UpdateManyArgs`
+
+  return `
+${prismaImportStatement}
+import { Request, Response, NextFunction } from 'express';
+import { RequestHandler, ParamsDictionary } from 'express-serve-static-core';
+import { ZodTypeAny } from 'zod';
+
+interface UpdateManyRequest extends Request {
+  prisma: PrismaClient;
+  body: ${argsTypeName};
+  outputValidation?: ZodTypeAny;
+  omitOutputValidation?: boolean;
+}
+
+export type UpdateManyMiddleware = RequestHandler<ParamsDictionary, any, ${argsTypeName}, Record<string, any>>
+
+export async function ${functionName}(req: UpdateManyRequest, res: Response, next: NextFunction) {
+  try {
+    if (!req.outputValidation && !req.omitOutputValidation) {
+      throw new Error('Output validation schema or omission flag must be provided.');
+    }
+
+    const data = await req.prisma.${lowercaseFirstLetter(modelName)}.updateMany(req.body);
+
+    if (!req.omitOutputValidation && req.outputValidation) {
+      const validationResult = req.outputValidation.safeParse(data);
+      if (validationResult.success) {
+        res.status(200).json({ count: validationResult.data.count });
+      } else {
+        res.status(400).json({ error: 'Invalid data format', details: validationResult.error });
+      }
+    } else if (!req.omitOutputValidation) {
+      throw new Error('Output validation schema must be provided unless explicitly omitted.');
+    } else {
+      res.status(200).json({ count: data.count });
+    }
+  } catch (error) {
+    console.error('Error in handling updateMany request:', error);
+    res.status(500).json({ error: error.message });
+    next(error);
+  }
+}`
+}

package/src/helpers/generateUpsert.ts

@@ -0,0 +1,60 @@
+import { DMMF } from '@prisma/generator-helper'
+import { lowercaseFirstLetter } from '../utils/strings'
+/**
+ * Generates an Express middleware function that handles the upsert operation (create or update)
+ * and includes conditional output validation with Zod.
+ * This version dynamically includes the correct type for the arguments based on the Prisma model.
+ * @param options - The options containing the model name and the import statement for Prisma types.
+ * @returns {string} - The generated middleware function as a string.
+ */
+export const generateUpsertFunction = (options: {
+  model: DMMF.Model
+  prismaImportStatement: string
+}): string => {
+  const { model, prismaImportStatement } = options
+  const modelName = model.name
+  const functionName = `${modelName}Upsert`
+  const argsTypeName = `Prisma.${modelName}UpsertArgs`
+
+  return `
+${prismaImportStatement}
+import { Request, Response, NextFunction } from 'express';
+import { RequestHandler, ParamsDictionary } from 'express-serve-static-core';
+import { ZodTypeAny } from 'zod';
+
+interface UpsertRequest extends Request {
+  prisma: PrismaClient;
+  body: ${argsTypeName};
+  outputValidation?: ZodTypeAny;
+  omitOutputValidation?: boolean;
+}
+
+export type UpsertMiddleware = RequestHandler<ParamsDictionary, any, ${argsTypeName}, Record<string, any>>
+
+export async function ${functionName}(req: UpsertRequest, res: Response, next: NextFunction) {
+  try {
+    if (!req.outputValidation && !req.omitOutputValidation) {
+      throw new Error('Output validation schema or omission flag must be provided.');
+    }
+
+    const data = await req.prisma.${lowercaseFirstLetter(modelName)}.upsert(req.body);
+
+    if (!req.omitOutputValidation && req.outputValidation) {
+      const validationResult = req.outputValidation.safeParse(data);
+      if (validationResult.success) {
+        res.status(200).json(validationResult.data);
+      } else {
+        res.status(400).json({ error: 'Invalid data format', details: validationResult.error });
+      }
+    } else if (!req.omitOutputValidation) {
+      throw new Error('Output validation schema must be provided unless explicitly omitted.');
+    } else {
+      res.status(200).json(data);
+    }
+  } catch (error) {
+    console.error('Error in handling upsert request:', error);
+    res.status(500).json({ error: error.message });
+    next(error);
+  }
+}`
+}

package/src/utils/formatFile.ts

@@ -0,0 +1,22 @@
+import prettier from 'prettier'
+
+export const formatFile = (content: string): Promise<string> => {
+  return new Promise((res, rej) =>
+    prettier.resolveConfig(process.cwd()).then((options) => {
+      if (!options) {
+        res(content) // no prettier config was found, no need to format
+      }
+
+      try {
+        const formatted = prettier.format(content, {
+          ...options,
+          parser: 'typescript',
+        })
+
+        res(formatted)
+      } catch (error) {
+        rej(error)
+      }
+    })
+  )
+}

package/src/utils/strings.ts

@@ -0,0 +1,7 @@
+export const capitalize = (str: string) =>
+  str.charAt(0).toUpperCase() + str.slice(1)
+
+export function lowercaseFirstLetter(str: string) {
+  if (!str) return str
+  return str.charAt(0).toLowerCase() + str.slice(1)
+}

package/src/utils/writeFileSafely.ts

@@ -0,0 +1,28 @@
+import fs from 'fs/promises'
+import path from 'path'
+import { formatFile } from './formatFile'
+import { DMMF, GeneratorOptions } from '@prisma/generator-helper'
+
+export const writeFileSafely = async ({
+  model,
+  operation,
+  options,
+  content,
+}: {
+  model: DMMF.Model
+  operation: string
+  options: GeneratorOptions
+  content: string
+}) => {
+  const fileName = operation === 'index' ? 'index' : `${model.name}${operation}`
+  const filePath = path.join(
+    options.generator.output?.value!,
+    `${model.name}/${fileName}.ts`,
+  )
+  console.log('filePath :>> ', filePath)
+  await fs.mkdir(path.dirname(filePath), {
+    recursive: true,
+  })
+
+  await fs.writeFile(filePath, await formatFile(content))
+}

package/CHANGELOG.md

@@ -1,14 +0,0 @@
-# [1.1.0](https://github.com/multipliedtwice/prisma-generator-express/compare/v1.0.0...v1.1.0) (2024-05-15)
-
-
-### Features
-
-* **generator:** add MIT License and README file for Prisma Generator Express ([6c99565](https://github.com/multipliedtwice/prisma-generator-express/commit/6c995652c53946e0f3f303f0495fcfe4e7b96e48))
-* **generator:** update package.json description to provide a more specific description of the Prisma generator for Express CRUD API ([7b99050](https://github.com/multipliedtwice/prisma-generator-express/commit/7b99050d2089490082b6c6b7f5174f8572172779))
-
-# 1.0.0 (2024-05-15)
-
-
-### Bug Fixes
-
-* **generator:** update minimum required Node.js version to 20.0 in engines field ([1b4e7b2](https://github.com/multipliedtwice/prisma-generator-express/commit/1b4e7b2a8e29cc8a9710cc6393ada81b01631de3))