Merge pull request #69 from CarterGrimmeisen/feat/config-import

feat: Attempted alternative to code injection via a global utility file

package.json

@@ -46,6 +46,7 @@
 		"@types/fs-extra": "^9.0.11",
 		"@typescript-eslint/eslint-plugin": "^5.7.0",
 		"@typescript-eslint/parser": "^5.7.0",
+		"decimal.js": "^10.3.1",
 		"eslint": "^7.17.0",
 		"eslint-config-react-app": "^6.0.0",
 		"eslint-plugin-prettier": "^4.0.0",

src/docs.ts

@@ -16,9 +16,25 @@ export const getJSDocs = (docString?: string) => {
 	return lines
 }
 
-export const computeModifiers = (docString: string) => {
-	return docString
+export const getZodDocElements = (docString: string) =>
+	docString
 		.split('\n')
 		.filter((line) => line.trimStart().startsWith('@zod'))
-		.map((line) => line.trim().split('@zod.').slice(-1)[0])
+		.flatMap((line) =>
+			Array.from(line.matchAll(/\.([^().]+\(.*?\))/g), (m) =>
+				m.slice(1)
+			).flat()
+		)
+
+export const computeCustomSchema = (docString: string) => {
+	return getZodDocElements(docString)
+		.find((modifier) => modifier.startsWith('custom('))
+		?.slice(7)
+		.slice(0, -1)
+}
+
+export const computeModifiers = (docString: string) => {
+	return getZodDocElements(docString).filter(
+		(each) => !each.startsWith('custom(')
+	)
 }

src/index.ts

@@ -23,6 +23,7 @@ const configSchema = z.object({
 		}),
 	modelSuffix: z.string().default('Model'),
 	modelCase: z.enum(['PascalCase', 'camelCase']).default('PascalCase'),
+	imports: z.string().optional(),
 })
 
 generatorHandler({
@@ -51,7 +52,8 @@ generatorHandler({
 				'Incorrect config provided. Please check the values you provided and try again.'
 			)
 
-		const { relationModel, modelSuffix, modelCase } = parsedConfig.data
+		const { relationModel, modelSuffix, modelCase, imports } =
+			parsedConfig.data
 
 		const formatModelName = (name: string, prefix = '') => {
 			if (modelCase === 'camelCase') {
@@ -140,6 +142,17 @@ generatorHandler({
 				})
 			}
 
+			if (imports) {
+				sourceFile.addImportDeclaration({
+					kind: StructureKind.ImportDeclaration,
+					moduleSpecifier: path.relative(
+						outputPath,
+						path.resolve(path.dirname(options.schemaPath), imports)
+					),
+					namespaceImport: 'imports',
+				})
+			}
+
 			sourceFile.addStatements((writer) =>
 				writeArray(writer, getJSDocs(model.documentation))
 			)

src/types.ts

@@ -1,5 +1,5 @@
 import type { DMMF } from '@prisma/generator-helper'
-import { computeModifiers } from './docs'
+import { computeCustomSchema, computeModifiers } from './docs'
 
 export const getZodConstructor = (
 	field: DMMF.Field,
@@ -48,6 +48,7 @@ export const getZodConstructor = (
 
 	if (field.isList) extraModifiers.push('array()')
 	if (field.documentation) {
+		zodType = computeCustomSchema(field.documentation) ?? zodType
 		extraModifiers.push(...computeModifiers(field.documentation))
 	}
 	if (!field.isRequired) extraModifiers.push('nullable()')

test/docs.test.ts

@@ -3,15 +3,20 @@ import { computeModifiers, getJSDocs } from '../src/docs'
 describe('docs Package', () => {
 	test('computeModifiers', () => {
 		const modifiers = computeModifiers(`
-			@zod.email()
+			@zod.email().optional()
 			@zod.url()
 			@zod.uuid()
 			Banana
 			@example something something
     `)
 
-		expect(modifiers.length).toBe(3)
-		expect(modifiers).toStrictEqual(['email()', 'url()', 'uuid()'])
+		expect(modifiers.length).toBe(4)
+		expect(modifiers).toStrictEqual([
+			'email()',
+			'optional()',
+			'url()',
+			'uuid()',
+		])
 	})
 
 	test('getJSDocs', () => {

test/functional/config-import/expected/document.ts

@@ -0,0 +1,12 @@
+import * as z from "zod"
+import * as imports from "../prisma/zod-utils"
+
+export const DocumentModel = z.object({
+  id: z.string(),
+  filename: z.string(),
+  author: z.string(),
+  contents: z.string(),
+  size: imports.decimalSchema,
+  created: z.date(),
+  updated: z.date(),
+})

test/functional/config-import/expected/index.ts

@@ -0,0 +1 @@
+export * from "./document";

test/functional/config-import/prisma/schema.prisma

@@ -0,0 +1,26 @@
+datasource db {
+  provider = "postgresql"
+  url      = env("DATABASE_URL")
+}
+
+generator client {
+  provider = "prisma-client-js"
+  output   = ".client"
+}
+
+generator zod {
+  provider = "../../../bin/cli.js"
+  output   = "../actual/"
+  imports  = "./zod-utils"
+}
+
+model Document {
+  id       String  @id @default(cuid())
+  filename String  @unique
+  author   String
+  contents String
+  size     Decimal /// @zod.custom(imports.decimalSchema)
+
+  created DateTime @default(now())
+  updated DateTime @default(now())
+}

test/functional/config-import/prisma/zod-utils.ts

@@ -0,0 +1,6 @@
+import { z } from 'zod'
+import { Decimal } from 'decimal.js'
+
+export const decimalSchema = z
+	.union([z.string(), z.number()])
+	.transform((value) => new Decimal(value))

test/functional/driver.test.ts

@@ -67,4 +67,5 @@ describe('Functional Tests', () => {
 	test.concurrent('relationModel = false', ftForDir('relation-false'))
 	test.concurrent('Imports', ftForDir('imports'))
 	test.concurrent('JSON', ftForDir('json'))
+	test.concurrent('Config Import', ftForDir('config-import'))
 })

yarn.lock

@@ -2370,6 +2370,11 @@ decamelize@^1.2.0:
   resolved "https://registry.npmjs.org/decamelize/-/decamelize-1.2.0.tgz"
   integrity sha1-9lNNFRSCabIDUue+4m9QH5oZEpA=
 
+decimal.js@^10.3.1:
+  version "10.3.1"
+  resolved "https://registry.yarnpkg.com/decimal.js/-/decimal.js-10.3.1.tgz#d8c3a444a9c6774ba60ca6ad7261c3a94fd5e783"
+  integrity sha512-V0pfhfr8suzyPGOx3nmq4aHqabehUZn6Ch9kyFpV79TGDTWFmHqUqXdabR7QHqxzrYolF4+tVmJhUG4OURg5dQ==
+
 decode-uri-component@^0.2.0:
   version "0.2.0"
   resolved "https://registry.npmjs.org/decode-uri-component/-/decode-uri-component-0.2.0.tgz"