Merge pull request #78 from sebastianwessel/literal-type

Handle backticked fields

Author: sebastianwessel

src/genSchema/generateZodSchemaCode.test.ts

@@ -1,5 +1,5 @@
 import { generateZodSchemaCode } from './generateZodSchemaCode.js'
-import { getDetailsFromDefinition } from './getDetailsFromDefinition.js'
+import { type FieldDetail, getDetailsFromDefinition } from './getDetailsFromDefinition.js'
 
 describe('generateZodSchemaCode', () => {
 	describe('basic schema', () => {
@@ -25,6 +25,51 @@ describe('generateZodSchemaCode', () => {
 		})
 	})
 
+	describe('Backticked and special field name handling', () => {
+		it('strips backticks from simple field names', () => {
+			const fields: FieldDetail[] = [
+				{ name: '`type`', table: 'test', zodString: 'z.string()', skip: false },
+				{ name: '`value`', table: 'test', zodString: 'z.number()', skip: false },
+			]
+			const result = generateZodSchemaCode(fields, 'testSchema')
+			expect(result).toEqualIgnoringWhitespace(`
+                const testSchema = z.object({
+                    type: z.string(),
+                    value: z.number()
+                })
+            `)
+		})
+
+		it('strips backticks and quotes field names containing hyphens', () => {
+			const fields: FieldDetail[] = [
+				{ name: '`max-value`', table: 'test', zodString: 'z.number()', skip: false },
+				{ name: '`field-with-hyphen`', table: 'test', zodString: 'z.string()', skip: false },
+			]
+			const result = generateZodSchemaCode(fields, 'testSchema')
+			expect(result).toEqualIgnoringWhitespace(`
+                const testSchema = z.object({
+                    "max-value": z.number(),
+                    "field-with-hyphen": z.string()
+                })
+            `)
+		})
+
+		it('strips backticks from field names that are JavaScript reserved words and quotes them', () => {
+			const fields: FieldDetail[] = [
+				{ name: '`default`', table: 'test', zodString: 'z.string()', skip: false },
+				{ name: '`const`', table: 'test', zodString: 'z.number()', skip: false },
+			]
+			const result = generateZodSchemaCode(fields, 'testSchema')
+			// Assuming your sanitizeJSKey or equivalent quotes reserved words
+			expect(result).toEqualIgnoringWhitespace(`
+                const testSchema = z.object({
+                    default: z.string(),
+                    const: z.number()
+                })
+            `)
+		})
+	})
+
 	describe('object schema', () => {
 		it('returns schema for simple object', () => {
 			const definition = `

src/genSchema/generateZodSchemaCode.ts

@@ -13,7 +13,18 @@ export const generateZodSchemaCode = (fields: FieldDetail[], schemaName: string)
 	// biome-ignore lint/suspicious/noExplicitAny: <explanation>
 	const buildSchema = (fieldMap: { [key: string]: any }, fields: FieldDetail[]) => {
 		for (const field of fields) {
-			const parts = field.name.split('.').map(part => part.replace('[*]', ''))
+			const parts = field.name.split('.').map(originalPart => {
+				const part = originalPart.replace('[*]', '')
+
+				if (part.startsWith('`') && part.endsWith('`')) {
+					if (part.includes('-')) {
+						return part.replace(/`/g, '"')
+					}
+					return part.replace(/`/g, '')
+				}
+				return part
+			})
+
 			let current = fieldMap
 
 			// Todo - handle default values