Enums can now be required again, as they don't need an explicit default value anymore.

If no default value exists, the first enum value will be used.
Fixes #333

Author: ciscoheat

CHANGELOG.md

@@ -9,7 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
-- Array data was set to `undefined` when `dataType: 'json'` was set.
+- Enums can now be required again, as they don't need an explicit default value anymore. If no default value exists, the first enum value will be used.
+- Empty arrays were set to `undefined` for `dataType: 'json'`.
 
 ## [2.0.0] - 2024-02-11
 

src/lib/jsonSchema/schemaDefaults.ts

@@ -108,10 +108,9 @@ function _defaultValues(schema: JSONSchema, isOptional: boolean, path: string[])
 		return objectDefaults;
 	}
 
-	// Enums
+	// Enums, return the first value so it can be a required field
 	if (schema.enum) {
-		throw new SchemaError('Enums must have a default value in the schema.', path);
-		//return schema.enum[0];
+		return schema.enum[0];
 	}
 
 	// Basic type

src/routes/(v1)/test/+page.server.ts

@@ -34,7 +34,7 @@ export const _dataTypeForm = z.object({
 	date: z.date().optional().default(new Date()),
 	coercedNumber: z.coerce.number().default(0).optional(),
 	coercedDate: z.coerce.date().optional(),
-	nativeEnumInt: z.nativeEnum(Fruits).default(Fruits.Apple),
+	nativeEnumInt: z.nativeEnum(Fruits),
 	nativeEnumString: z.nativeEnum({ GRAY: 'GRAY', GREEN: 'GREEN' }).default('GREEN'),
 	nativeEnumString2: z.nativeEnum(FruitsStr).default(FruitsStr.Banana)
 });

src/tests/JSONSchema.test.ts

@@ -123,7 +123,7 @@ describe('Default values', () => {
 		});
 	});
 
-	it('should map default values for enums to the first enum value', () => {
+	it('should use the default value for enums if set', () => {
 		enum Fruits {
 			Apple = 2,
 			Banana = 3
@@ -136,7 +136,6 @@ describe('Default values', () => {
 
 		const schema = {
 			type: 'object',
-			required: ['nativeEnumInt', 'nativeEnumString', 'nativeEnumString2'],
 			properties: {
 				nativeEnumInt: {
 					type: 'number',
@@ -163,6 +162,43 @@ describe('Default values', () => {
 		});
 	});
 
+	it('should map default values for enums to the first enum value', () => {
+		enum Fruits {
+			Apple = 2,
+			Banana = 3
+		}
+
+		enum FruitsStr {
+			Apple = 'Apple',
+			Banana = 'Banana'
+		}
+
+		const schema = {
+			type: 'object',
+			required: ['nativeEnumInt', 'nativeEnumString', 'nativeEnumString2'],
+			properties: {
+				nativeEnumInt: {
+					type: 'number',
+					enum: Object.keys(Fruits).map(parseInt)
+				},
+				nativeEnumString: {
+					type: 'string',
+					enum: ['GRAY', 'GREEN']
+				},
+				nativeEnumString2: {
+					type: 'string',
+					enum: Object.values(FruitsStr)
+				}
+			}
+		} satisfies JSONSchema7;
+
+		expect(defaultValues(schema)).toEqual({
+			nativeEnumInt: 2,
+			nativeEnumString: 'GRAY',
+			nativeEnumString2: 'Apple'
+		});
+	});
+
 	it('should handle native Date through the unix-time format', () => {
 		const date = new Date();
 		const schema = {

src/tests/superValidate.test.ts

@@ -21,20 +21,7 @@ import { zod, zodToJSONSchema } from '$lib/adapters/zod.js';
 import { z } from 'zod';
 
 import { valibot } from '$lib/adapters/valibot.js';
-import {
-	object,
-	string,
-	email,
-	minLength,
-	array,
-	integer,
-	number,
-	minValue,
-	date,
-	optional,
-	regex,
-	transform
-} from 'valibot';
+import * as v from 'valibot';
 
 //import { ajv } from '$lib/adapters/ajv.js';
 //import type { JSONSchema } from '$lib/jsonSchema/index.js';
@@ -204,13 +191,13 @@ describe('Arktype', () => {
 /////////////////////////////////////////////////////////////////////
 
 describe('Valibot', () => {
-	const schema = object({
-		name: optional(string(), 'Unknown'),
-		email: string([email()]),
-		tags: array(string([minLength(2)]), [minLength(3)]),
-		score: number([integer(), minValue(0)]),
-		date: optional(date()),
-		nospace: optional(string([regex(nospacePattern)]))
+	const schema = v.object({
+		name: v.optional(v.string(), 'Unknown'),
+		email: v.string([v.email()]),
+		tags: v.array(v.string([v.minLength(2)]), [v.minLength(3)]),
+		score: v.number([v.integer(), v.minValue(0)]),
+		date: v.optional(v.date()),
+		nospace: v.optional(v.string([v.regex(nospacePattern)]))
 	});
 
 	describe('Introspection', () => {
@@ -220,6 +207,26 @@ describe('Valibot', () => {
 	describe('Defaults', () => {
 		schemaTest(valibot(schema, { defaults }), undefined, 'simple');
 	});
+
+	it('should produce a required enum if no default', () => {
+		const schema = v.object({
+			enum: v.picklist(['a', 'b', 'c']),
+			enumDef: v.optional(v.picklist(['a', 'b', 'c']), 'b')
+		});
+
+		const adapter = valibot(schema);
+		expect(adapter.jsonSchema.required).toEqual(['enum']);
+		expect(adapter.defaults).toEqual({
+			enum: 'a',
+			enumDef: 'b'
+		});
+
+		// Change defaults
+		adapter.defaults.enum = '' as 'a';
+
+		const a2 = valibot(schema);
+		expect(a2.defaults.enum).toBe('');
+	});
 });
 
 /////////////////////////////////////////////////////////////////////
@@ -343,6 +350,30 @@ describe('Zod', () => {
 		num;
 	});
 
+	it('should produce a required enum if no default', () => {
+		enum Fruits {
+			Apple = 7,
+			Banana = 8
+		}
+
+		const schema = z.object({
+			nativeEnumInt: z.nativeEnum(Fruits),
+			nativeEnumString: z.nativeEnum({ GRAY: 'GRAY', GREEN: 'GREEN' }).default('GREEN'),
+			enum: z.enum(['a', 'b', 'c']),
+			// eslint-disable-next-line @typescript-eslint/no-explicit-any
+			enumDef: z.enum(['a', 'b', 'c']).default('' as any)
+		});
+
+		const adapter = zod(schema);
+		expect(adapter.jsonSchema.required).toEqual(['nativeEnumInt', 'enum', 'enumDef']);
+		expect(adapter.defaults).toEqual({
+			nativeEnumInt: Fruits.Apple,
+			nativeEnumString: 'GREEN',
+			enum: 'a',
+			enumDef: ''
+		});
+	});
+
 	schemaTest(zod(schema));
 });
 
@@ -377,8 +408,8 @@ describe('Schema In/Out transformations', () => {
 	});
 
 	it('does not fully work with Valibot', async () => {
-		const schema = object({
-			len: transform(string(), (s) => s.length)
+		const schema = v.object({
+			len: v.transform(v.string(), (s) => s.length)
 		});
 
 		// @ts-expect-error Using schema Out type as In - Not allowed