prisma-generator-express 1.1.0 → 1.3.0

package/src/generator.ts

@@ -0,0 +1,174 @@
+import { generatorHandler, GeneratorOptions } from '@prisma/generator-helper'
+import { logger } from '@prisma/sdk'
+import { GENERATOR_NAME } from './constants'
+import { writeFileSafely } from './utils/writeFileSafely'
+import { generateFindUniqueFunction } from './helpers/generateFindUnique'
+import { generateImportPrismaStatement } from './helpers/generateImportPrismaStatement'
+import { generateFindManyFunction } from './helpers/generateFindMany'
+import { generateFindFirstFunction } from './helpers/generateFindFirst'
+import { generateCreateFunction } from './helpers/generateCreate'
+import { generateRouterFunction } from './helpers/generateRouteFile'
+import { generateCreateManyFunction } from './helpers/generateCreateMany'
+import { generateUpdateFunction } from './helpers/generateUpdate'
+import { generateUpdateManyFunction } from './helpers/generateUpdateMany'
+import { generateUpsertFunction } from './helpers/generateUpsert'
+import { generateDeleteFunction } from './helpers/generateDelete'
+import { generateDeleteManyFunction } from './helpers/generateDeleteMany'
+import { generateAggregateFunction } from './helpers/generateAggregate'
+import { generateCountFunction } from './helpers/generateCount'
+import { generateGroupByFunction } from './helpers/generateGroupBy'
+
+const { version } = require('../package.json')
+
+generatorHandler({
+  onManifest() {
+    logger.info(`${GENERATOR_NAME}:Registered`)
+    return {
+      version,
+      defaultOutput: '../generated',
+      prettyName: GENERATOR_NAME,
+    }
+  },
+  onGenerate: async (options: GeneratorOptions) => {
+    const prismaImportStatement = generateImportPrismaStatement(options)
+
+    options.dmmf.datamodel.models.forEach(async (model) => {
+      await writeFileSafely({
+        content: generateFindUniqueFunction({
+          model,
+          prismaImportStatement,
+        }),
+        options,
+        model,
+        operation: 'FindUnique',
+      })
+
+      await writeFileSafely({
+        content: generateFindFirstFunction({
+          model,
+          prismaImportStatement,
+        }),
+        options,
+        model,
+        operation: 'FindFirst',
+      })
+
+      await writeFileSafely({
+        content: generateFindManyFunction({
+          model,
+          prismaImportStatement,
+        }),
+        options,
+        model,
+        operation: 'FindMany',
+      })
+
+      await writeFileSafely({
+        content: generateCreateFunction({
+          model,
+          prismaImportStatement,
+        }),
+        options,
+        model,
+        operation: 'Create',
+      })
+
+      await writeFileSafely({
+        content: generateCreateManyFunction({
+          model,
+          prismaImportStatement,
+        }),
+        options,
+        model,
+        operation: 'CreateMany',
+      })
+
+      await writeFileSafely({
+        content: generateUpdateFunction({
+          model,
+          prismaImportStatement,
+        }),
+        options,
+        model,
+        operation: 'Update',
+      })
+
+      await writeFileSafely({
+        content: generateUpdateManyFunction({
+          model,
+          prismaImportStatement,
+        }),
+        options,
+        model,
+        operation: 'UpdateMany',
+      })
+
+      await writeFileSafely({
+        content: generateUpsertFunction({
+          model,
+          prismaImportStatement,
+        }),
+        options,
+        model,
+        operation: 'Upsert',
+      })
+
+      await writeFileSafely({
+        content: generateDeleteFunction({
+          model,
+          prismaImportStatement,
+        }),
+        options,
+        model,
+        operation: 'Delete',
+      })
+
+      await writeFileSafely({
+        content: generateDeleteManyFunction({
+          model,
+          prismaImportStatement,
+        }),
+        options,
+        model,
+        operation: 'DeleteMany',
+      })
+
+      await writeFileSafely({
+        content: generateAggregateFunction({
+          model,
+          prismaImportStatement,
+        }),
+        options,
+        model,
+        operation: 'Aggregate',
+      })
+
+      await writeFileSafely({
+        content: generateCountFunction({
+          model,
+          prismaImportStatement,
+        }),
+        options,
+        model,
+        operation: 'Count',
+      })
+
+      await writeFileSafely({
+        content: generateGroupByFunction({
+          model,
+          prismaImportStatement,
+        }),
+        options,
+        model,
+        operation: 'GroupBy',
+      })
+
+      await writeFileSafely({
+        content: generateRouterFunction({ model }),
+        options,
+        model,
+        operation: 'index',
+      })
+    })
+  },
+})

package/src/helpers/generateAggregate.ts

@@ -0,0 +1,60 @@
+import { DMMF } from '@prisma/generator-helper'
+import { capitalize, lowercaseFirstLetter } from '../utils/strings'
+
+/**
+ * Generates an Express middleware function that handles aggregation 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 generateAggregateFunction = (options: {
+  model: DMMF.Model
+  prismaImportStatement: string
+}): string => {
+  const { model, prismaImportStatement } = options
+  const modelName = model.name
+  const functionName = `${modelName}Aggregate`
+  const argsTypeName = `Prisma.${capitalize(modelName)}AggregateArgs`
+
+  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 AggregateRequest extends Request {
+  prisma: PrismaClient;
+  query: Partial<${argsTypeName}> & ParsedQs;
+  outputValidation?: ZodTypeAny;
+  omitOutputValidation?: boolean;
+}
+
+export type AggregateMiddleware = RequestHandler<ParamsDictionary, any, Partial<${argsTypeName}>, Record<string, any>>;
+
+export async function ${functionName}(req: AggregateRequest, res: Response, next: NextFunction) {
+  try {
+    if (!req.outputValidation && !req.omitOutputValidation) {
+      throw new Error('Output validation schema or omission flag must be provided.');
+    }
+
+    const result = await req.prisma.${lowercaseFirstLetter(modelName)}.aggregate(req.query as ${argsTypeName});
+
+    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 aggregation request:', error);
+    res.status(500).json({ error: error.message });
+    next(error);
+  }
+}`
+}

package/src/helpers/generateCount.ts

@@ -0,0 +1,60 @@
+import { DMMF } from '@prisma/generator-helper'
+import { lowercaseFirstLetter } from '../utils/strings'
+
+/**
+ * Generates an Express middleware function that handles count 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 generateCountFunction = (options: {
+  model: DMMF.Model
+  prismaImportStatement: string
+}): string => {
+  const { model, prismaImportStatement } = options
+  const modelName = model.name
+  const functionName = `${modelName}Count`
+  const argsTypeName = `Prisma.${modelName}CountArgs`
+
+  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 CountRequest extends Request {
+  prisma: PrismaClient;
+  query: Partial<${argsTypeName}> & ParsedQs;
+  outputValidation?: ZodTypeAny;
+  omitOutputValidation?: boolean;
+}
+
+export type CountMiddleware = RequestHandler<ParamsDictionary, any, {}, ParsedQs>;
+
+export async function ${functionName}(req: CountRequest, res: Response, next: NextFunction) {
+  try {
+    if (!req.outputValidation && !req.omitOutputValidation) {
+      throw new Error('Output validation schema or omission flag must be provided.');
+    }
+
+    const result = await req.prisma.${lowercaseFirstLetter(modelName)}.count(req.query as ${argsTypeName});
+
+    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 count request:', error);
+    res.status(500).json({ error: error.message });
+    next(error);
+  }
+}`
+}

package/src/helpers/generateCreate.ts

@@ -0,0 +1,58 @@
+import { DMMF } from '@prisma/generator-helper'
+import { lowercaseFirstLetter } from '../utils/strings'
+/**
+ * Generates an Express middleware function that handles creation of 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 generateCreateFunction = (options: {
+  model: DMMF.Model
+  prismaImportStatement: string
+}): string => {
+  const { model, prismaImportStatement } = options
+  const modelName = model.name
+  const functionName = `${modelName}Create`
+  const argsTypeName = `Prisma.${modelName}CreateArgs`
+
+  return `
+${prismaImportStatement}
+import { Request, Response, NextFunction } from 'express';
+import { RequestHandler, ParamsDictionary } from 'express-serve-static-core'
+import { ZodTypeAny } from 'zod';
+
+interface CreateRequest extends Request {
+  prisma: PrismaClient;
+  body: ${argsTypeName};
+  outputValidation?: ZodTypeAny;
+  omitOutputValidation?: boolean;
+}
+
+export type CreateMiddleware = RequestHandler<ParamsDictionary, any, ${argsTypeName}, Record<string, any>>
+
+export async function ${functionName}(req: CreateRequest, 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)}.create(req.body);
+    if (!req.omitOutputValidation && req.outputValidation) {
+      const validationResult = req.outputValidation.safeParse(data);
+      if (validationResult.success) {
+        res.status(201).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(201).json(data);
+    }
+  } catch (error) {
+    console.error('Error in handling create request:', error);
+    res.status(500).json({ error: error.message });
+    next(error);
+  }
+}`
+}

package/src/helpers/generateCreateMany.ts

@@ -0,0 +1,58 @@
+import { DMMF } from '@prisma/generator-helper'
+import { lowercaseFirstLetter } from '../utils/strings'
+/**
+ * Generates an Express middleware function that handles the creation of 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 generateCreateManyFunction = (options: {
+  model: DMMF.Model
+  prismaImportStatement: string
+}): string => {
+  const { model, prismaImportStatement } = options
+  const modelName = model.name
+  const functionName = `${modelName}CreateMany`
+  const argsTypeName = `Prisma.${modelName}CreateManyArgs`
+
+  return `
+${prismaImportStatement}
+import { Request, Response, NextFunction } from 'express';
+import { RequestHandler, ParamsDictionary } from 'express-serve-static-core';
+import { ZodTypeAny } from 'zod';
+
+interface CreateManyRequest extends Request {
+  prisma: PrismaClient;
+  body: ${argsTypeName};
+  outputValidation?: ZodTypeAny;
+  omitOutputValidation?: boolean;
+}
+
+export type CreateManyMiddleware = RequestHandler<ParamsDictionary, any, ${argsTypeName}, Record<string, any>>
+
+export async function ${functionName}(req: CreateManyRequest, 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)}.createMany(req.body);
+    if (!req.omitOutputValidation && req.outputValidation) {
+      const validationResult = req.outputValidation.safeParse(data);
+      if (validationResult.success) {
+        res.status(201).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(201).json(data);
+    }
+  } catch (error) {
+    console.error('Error in handling createMany request:', error);
+    res.status(500).json({ error: error.message });
+    next(error);
+  }
+}`
+}

package/src/helpers/generateDelete.ts

@@ -0,0 +1,60 @@
+import { DMMF } from '@prisma/generator-helper'
+import { lowercaseFirstLetter } from '../utils/strings'
+/**
+ * Generates an Express middleware function that handles deleting 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 generateDeleteFunction = (options: {
+  model: DMMF.Model
+  prismaImportStatement: string
+}): string => {
+  const { model, prismaImportStatement } = options
+  const modelName = model.name
+  const functionName = `${modelName}Delete`
+  const argsTypeName = `Prisma.${modelName}DeleteArgs`
+
+  return `
+${prismaImportStatement}
+import { Request, Response, NextFunction } from 'express';
+import { RequestHandler, ParamsDictionary } from 'express-serve-static-core';
+import { ZodTypeAny } from 'zod';
+
+interface DeleteRequest extends Request {
+  prisma: PrismaClient;
+  body: ${argsTypeName};
+  outputValidation?: ZodTypeAny;
+  omitOutputValidation?: boolean;
+}
+
+export type DeleteMiddleware = RequestHandler<ParamsDictionary, any, ${argsTypeName}, Record<string, any>>
+
+export async function ${functionName}(req: DeleteRequest, 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)}.delete(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 delete request:', error);
+    res.status(500).json({ error: error.message });
+    next(error);
+  }
+}`
+}

package/src/helpers/generateDeleteMany.ts

@@ -0,0 +1,58 @@
+import { DMMF } from '@prisma/generator-helper'
+import { lowercaseFirstLetter } from '../utils/strings'
+/**
+ * Generates an Express middleware function that handles batch deleting 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 generateDeleteManyFunction = (options: {
+  model: DMMF.Model
+  prismaImportStatement: string
+}): string => {
+  const { model, prismaImportStatement } = options
+  const modelName = model.name
+  const functionName = `${modelName}DeleteMany`
+  const argsTypeName = `Prisma.${modelName}DeleteManyArgs`
+
+  return `
+${prismaImportStatement}
+import { Request, Response, NextFunction } from 'express';
+import { RequestHandler, ParamsDictionary } from 'express-serve-static-core';
+import { ZodTypeAny } from 'zod';
+
+interface DeleteManyRequest extends Request {
+  prisma: PrismaClient;
+  body: ${argsTypeName};
+  outputValidation?: ZodTypeAny;
+  omitOutputValidation?: boolean;
+}
+
+export type DeleteManyMiddleware = RequestHandler<ParamsDictionary, any, Prisma.${modelName}DeleteManyArgs, Record<string, any>>;
+
+export async function ${functionName}(req: DeleteManyRequest, res: Response, next: NextFunction) {
+  try {
+    if (!req.outputValidation && !req.omitOutputValidation) {
+      throw new Error('Output validation schema or omission flag must be provided.');
+    }
+
+    const result = await req.prisma.${lowercaseFirstLetter(modelName)}.deleteMany(req.body);
+
+    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 batch delete request:', error);
+    res.status(500).json({ error: error.message });
+    next(error);
+  }
+}`
+}

package/src/helpers/generateFindFirst.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 generateFindFirstFunction = (options: {
+  model: DMMF.Model
+  prismaImportStatement: string
+}): string => {
+  const { model, prismaImportStatement } = options
+  const modelName = model.name
+  const functionName = `${modelName}FindFirst`
+  const queryTypeName = `Prisma.${modelName}FindFirstArgs`
+
+  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 FindFirstRequest extends Request {
+  prisma: PrismaClient;
+  query: ${queryTypeName} & ParsedQs;
+  outputValidation?: ZodTypeAny;
+  omitOutputValidation?: boolean;
+  passToNext?: boolean;
+  locals: {
+    data?: ${modelName} | null
+  }
+}
+export type FindFirstMiddleware = RequestHandler<ParamsDictionary, any, any, ${queryTypeName} & ParsedQs, Record<string, any>>
+
+export async function ${functionName}(req: FindFirstRequest, 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)}.findFirst(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/generateFindMany.ts

@@ -0,0 +1,68 @@
+import { DMMF } from '@prisma/generator-helper'
+import { lowercaseFirstLetter } from '../utils/strings'
+/**
+ * Generates an Express middleware function that handles multiple record retrieval with optional output validation using 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 generateFindManyFunction = (options: {
+  model: DMMF.Model
+  prismaImportStatement: string
+}): string => {
+  const { model, prismaImportStatement } = options
+  const modelName = model.name
+  const functionName = `${modelName}FindMany`
+  const queryTypeName = `Prisma.${modelName}FindManyArgs`
+
+  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 FindManyRequest extends Request {
+  prisma: PrismaClient;
+  query: ${queryTypeName} & ParsedQs;
+  outputValidation?: ZodTypeAny;
+  omitOutputValidation?: boolean;
+  passToNext?: boolean;
+  locals: {
+    data?: ${modelName}[]
+  }
+}
+export type FindManyMiddleware = RequestHandler<ParamsDictionary, any, any, ${queryTypeName} & ParsedQs, Record<string, any>>
+
+export async function ${functionName}(req: FindManyRequest, 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)}.findMany(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);
+  }
+}`
+}