prisma-generator-express 1.54.0 → 1.55.0

package/src/generators/generateUnifiedScalarUI.ts

@@ -1,5 +1,5 @@
 import { DMMF } from '@prisma/generator-helper'
-import { Target } from '../constants'
+import { Target, WriteStrategy } from '../constants'
 import { ImportStyle } from '../utils/resolveImportStyle'
 import { importExt } from '../utils/importExt'
 
@@ -51,7 +51,7 @@ function generateExpressDocsExport(modelName: string): string {
         MODEL_FIELDS as unknown as Parameters<typeof buildModelOpenApi>[1],
         MODEL_ENUMS as unknown as Parameters<typeof buildModelOpenApi>[2],
         config,
-        { format: 'yaml' }
+        { format: 'yaml', writeStrategy: WRITE_STRATEGY }
       )
       return res.type('application/yaml').send(yaml as string)
     }
@@ -61,7 +61,7 @@ function generateExpressDocsExport(modelName: string): string {
       MODEL_FIELDS as unknown as Parameters<typeof buildModelOpenApi>[1],
       MODEL_ENUMS as unknown as Parameters<typeof buildModelOpenApi>[2],
       config,
-      { format: 'json' }
+      { format: 'json', writeStrategy: WRITE_STRATEGY }
     )
 
     if (ui === 'json') return res.json(spec)
@@ -72,7 +72,7 @@ function generateExpressDocsExport(modelName: string): string {
       return res.type('html').send(renderScalar('${modelName}', spec, pageTitle, config.scalarCdnUrl))
     }
 
-    const html = renderDocs('${modelName}', config, MODEL_CONTEXT)
+    const html = renderDocs('${modelName}', config, MODEL_CONTEXT, WRITE_STRATEGY)
     return res.type('html').send(html)
   }
 }`
@@ -102,7 +102,7 @@ function generateFastifyDocsExport(modelName: string): string {
         MODEL_FIELDS as unknown as Parameters<typeof buildModelOpenApi>[1],
         MODEL_ENUMS as unknown as Parameters<typeof buildModelOpenApi>[2],
         config,
-        { format: 'yaml' }
+        { format: 'yaml', writeStrategy: WRITE_STRATEGY }
       )
       reply.type('application/yaml').send(yaml as string); return
     }
@@ -112,7 +112,7 @@ function generateFastifyDocsExport(modelName: string): string {
       MODEL_FIELDS as unknown as Parameters<typeof buildModelOpenApi>[1],
       MODEL_ENUMS as unknown as Parameters<typeof buildModelOpenApi>[2],
       config,
-      { format: 'json' }
+      { format: 'json', writeStrategy: WRITE_STRATEGY }
     )
 
     if (ui === 'json') { reply.send(spec); return }
@@ -123,7 +123,7 @@ function generateFastifyDocsExport(modelName: string): string {
       reply.type('text/html').send(renderScalar('${modelName}', spec, pageTitle, config.scalarCdnUrl)); return
     }
 
-    const html = renderDocs('${modelName}', config, MODEL_CONTEXT)
+    const html = renderDocs('${modelName}', config, MODEL_CONTEXT, WRITE_STRATEGY)
     reply.type('text/html').send(html)
   }
 }`
@@ -152,7 +152,7 @@ function generateHonoDocsExport(modelName: string): string {
         MODEL_FIELDS as unknown as Parameters<typeof buildModelOpenApi>[1],
         MODEL_ENUMS as unknown as Parameters<typeof buildModelOpenApi>[2],
         config,
-        { format: 'yaml' }
+        { format: 'yaml', writeStrategy: WRITE_STRATEGY }
       ) as string
       return c.body(yaml, 200, { 'Content-Type': 'application/yaml' })
     }
@@ -162,7 +162,7 @@ function generateHonoDocsExport(modelName: string): string {
       MODEL_FIELDS as unknown as Parameters<typeof buildModelOpenApi>[1],
       MODEL_ENUMS as unknown as Parameters<typeof buildModelOpenApi>[2],
       config,
-      { format: 'json' }
+      { format: 'json', writeStrategy: WRITE_STRATEGY }
     )
 
     if (ui === 'json') return c.json(spec as Record<string, unknown>)
@@ -173,7 +173,7 @@ function generateHonoDocsExport(modelName: string): string {
       return c.html(renderScalar('${modelName}', spec, pageTitle, config.scalarCdnUrl))
     }
 
-    const html = renderDocs('${modelName}', config, MODEL_CONTEXT)
+    const html = renderDocs('${modelName}', config, MODEL_CONTEXT, WRITE_STRATEGY)
     return c.html(html)
   }
 }`
@@ -184,8 +184,9 @@ export function generateScalarUIHandler(options: {
   enums: DMMF.DatamodelEnum[]
   target?: Target
   importStyle: ImportStyle
+  writeStrategy: WriteStrategy
 }): string {
-  const { model, enums } = options
+  const { model, enums, writeStrategy } = options
   const target = options.target || 'express'
   const ext = importExt(options.importStyle)
   const modelName = model.name
@@ -260,6 +261,7 @@ export function generateScalarUIHandler(options: {
 
   return `${frameworkImport}
 import { buildModelOpenApi } from '../buildModelOpenApi${ext}'
+import type { WriteStrategy } from '../routeConfig${ext}'
 import {
   renderDocs,
   renderScalar,
@@ -273,6 +275,8 @@ import {
   type DocsModelContext,
 } from '../docsRenderer${ext}'
 
+const WRITE_STRATEGY: WriteStrategy = '${writeStrategy}'
+
 export const MODEL_FIELDS: FieldMeta[] = ${JSON.stringify(fieldsMeta, null, 2)}
 
 export const MODEL_ENUMS: EnumMeta[] = ${JSON.stringify(enumsMeta, null, 2)}

package/src/index.ts

@@ -25,7 +25,7 @@ import {
 import { writeFileSafely } from './utils/writeFileSafely'
 import { copyFiles } from './utils/copyFiles'
 import { resolveImportStyle, ImportStyle } from './utils/resolveImportStyle'
-import { GENERATOR_NAME, Target } from './constants'
+import { GENERATOR_NAME, Target, WriteStrategy } from './constants'
 
 const GENERATOR_OFF_RE = /\bgenerator off\b/
 
@@ -34,8 +34,25 @@ function getTarget(options: GeneratorOptions): Target {
     (options.generator.config as Record<string, unknown>).target ?? 'express',
   ).toLowerCase()
   if (raw === 'express' || raw === 'fastify' || raw === 'hono') return raw
+  throw new Error(`Invalid target "${raw}". Expected "express", "fastify", or "hono".`)
+}
+
+function getWriteStrategy(options: GeneratorOptions): WriteStrategy {
+  const raw = String(
+    (options.generator.config as Record<string, unknown>).writeStrategy ?? 'regular',
+  )
+  const lower = raw.toLowerCase()
+  if (lower === 'regular') return 'regular'
+  if (lower === 'throwonnonreturning') return 'throwOnNonReturning'
+  if (lower === 'throwonregular') {
+    console.warn(
+      '[prisma-generator-express] writeStrategy="throwOnRegular" is deprecated. Use "throwOnNonReturning" instead.',
+    )
+    return 'throwOnNonReturning'
+  }
+  if (lower === 'forcereturn') return 'forceReturn'
   throw new Error(
-    `Invalid target "${raw}". Expected "express", "fastify", or "hono".`,
+    `Invalid writeStrategy "${raw}". Expected "regular", "throwOnNonReturning", or "forceReturn".`,
   )
 }
 
@@ -54,6 +71,7 @@ generatorHandler({
 
   async onGenerate(options: GeneratorOptions) {
     const target = getTarget(options)
+    const writeStrategy = getWriteStrategy(options)
     const hasExplicitOutput =
       !!options.generator.output?.fromEnvVar ||
       (options.generator.config as Record<string, unknown>).output !== undefined
@@ -70,6 +88,7 @@ generatorHandler({
     console.log(`  Target: ${target}`)
     console.log(`  Output: ${options.generator.output?.value}`)
     console.log(`  Import style: ${importStyle}`)
+    console.log(`  Write strategy: ${writeStrategy}`)
 
     if (options.dmmf.datamodel.models.length > 0) {
       validateClientGeneratorPresent(options)
@@ -91,10 +110,7 @@ generatorHandler({
     const allModels = options.dmmf.datamodel.models as DMMF.Model[]
 
     for (const model of options.dmmf.datamodel.models) {
-      if (
-        model.documentation &&
-        GENERATOR_OFF_RE.test(model.documentation)
-      ) {
+      if (model.documentation && GENERATOR_OFF_RE.test(model.documentation)) {
         console.log(`  Skipping: ${model.name} (generator off)`)
         continue
       }
@@ -103,7 +119,7 @@ generatorHandler({
       const guardShapesImport = getGuardShapesImport(options, model.name)
 
       await writeFileSafely({
-        content: generateModelCore({ model: model as DMMF.Model, importStyle }),
+        content: generateModelCore({ model: model as DMMF.Model, importStyle, writeStrategy }),
         options,
         model: model as DMMF.Model,
         operation: 'Core',
@@ -123,6 +139,7 @@ generatorHandler({
               enums: options.dmmf.datamodel.enums as DMMF.DatamodelEnum[],
               guardShapesImport,
               importStyle,
+              writeStrategy,
             })
           : target === 'hono'
             ? generateHonoRouterFunction({
@@ -130,12 +147,14 @@ generatorHandler({
                 enums: options.dmmf.datamodel.enums as DMMF.DatamodelEnum[],
                 guardShapesImport,
                 importStyle,
+                writeStrategy,
               })
             : generateRouterFunction({
                 model: model as DMMF.Model,
                 enums: options.dmmf.datamodel.enums as DMMF.DatamodelEnum[],
                 guardShapesImport,
                 importStyle,
+                writeStrategy,
               })
 
       await writeFileSafely({
@@ -151,6 +170,7 @@ generatorHandler({
           enums: options.dmmf.datamodel.enums as DMMF.DatamodelEnum[],
           target,
           importStyle,
+          writeStrategy,
         }),
         options,
         model: model as DMMF.Model,