TODO cleanup

Author: ciscoheat

CHANGELOG.md

@@ -7,15 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 TODO:
 
-- superValidateSync cannot use superValidate anymore since TypeSchema is async.
-- Remove fields options for setting tainted
 - Default options should follow SvelteKit: resetForm: true and taintedMessage: false (only error behavior is kept)
 
 ## [Unreleased]
 
 ### Removed
 
 - superForm.fields
+- `fields` options for setting tainted.
 
 ### Changed
 

src/lib/client/superForm.ts

@@ -357,8 +357,6 @@ export function superForm<
 		if (options.validationMethod == 'onblur' && event.type == 'input') return;
 		if (options.validationMethod == 'oninput' && event.type == 'blur') return;
 
-		// TODO: What to do with a programmatic change event?
-
 		const result = await Form_validate();
 
 		if (result.valid) {
@@ -379,9 +377,11 @@ export function superForm<
 		//console.log('Form__displayNewErrors', errors); //debug
 
 		const { type, immediate, multiple, paths } = event;
-		//const isProgrammaticEvent = !type;
 		const previous = Data.errors;
 
+		// TODO: What to do with a programmatic change event?
+		//const isProgrammaticEvent = !type;
+
 		const output: Record<string, unknown> = {};
 		const validity = new Map<string, { el: HTMLElement; message: string }>();
 
@@ -563,9 +563,7 @@ export function superForm<
 
 	let NextChange: ChangeEvent | null = null;
 
-	function NextChange_addValidationEvent(event: ChangeEvent) {
-		// TODO: What to do with more than one path (programmically updated)
-
+	function NextChange_setHtmlEvent(event: ChangeEvent) {
 		NextChange = event;
 		// Wait for on:input to provide additional information
 		setTimeout(() => Form_clientValidation(NextChange), 0);
@@ -676,7 +674,7 @@ export function superForm<
 			}
 		}
 
-		NextChange_addValidationEvent({ paths });
+		NextChange_setHtmlEvent({ paths });
 	}
 
 	/**
@@ -685,6 +683,7 @@ export function superForm<
 	 * @param newClean
 	 */
 	function Tainted_set(tainted: TaintedFields<T> | undefined, newClean: T | undefined) {
+		// TODO: Is it better to set tainted values to undefined instead of just overwriting?
 		Tainted.state.set(tainted);
 		if (newClean) Tainted.clean = newClean;
 	}
@@ -971,7 +970,7 @@ export function superForm<
 
 			let lastInputChange: ChangeEvent['paths'] | undefined;
 
-			// TODO: Debounce?
+			// TODO: Debounce option?
 			async function onInput(e: Event) {
 				const info = inputInfo(e.target);
 				// Need to wait for immediate updates due to some timing issue

src/lib/errors.ts

@@ -3,7 +3,6 @@ import type { ValidationIssue } from '@decs/typeschema';
 import { pathExists, setPaths, traversePath, traversePaths } from './traversal.js';
 import { SuperFormError, type ValidationErrors } from './index.js';
 import { mergePath } from './stringPath.js';
-import type { FormOptions } from './client/index.js';
 
 export function mapErrors(errors: ValidationIssue[], shape: SchemaShape) {
 	//console.log('===', errors.length, 'errors', shape);
@@ -91,88 +90,6 @@ export function updateErrors<T extends Record<string, unknown>>(
 	return Previous;
 }
 
-/*
-
-		console.log('Checking new error', error.path, error.value);
-
-		const isObjectError = error.path[error.path.length - 1] == '_errors';
-		let previousError = pathExists(Previous, error.path);
-
-		if (!previousError) {
-			// An object error should be displayed on blur if no error exists
-			if (event != 'blur') return;
-
-			if (isObjectError) {
-				setPaths(Previous, [error.path], error.value);
-				return;
-			}
-
-			setPaths(Previous, [error.path], undefined);
-			previousError = pathExists(Previous, error.path)!;
-		}
-
-		switch (method) {
-			case undefined:
-			case 'auto':
-				if (previousError.key in previousError.parent) {
-					console.log('Error key existed, setting', previousError.path);
-					previousError.set(error.value);
-					break;
-				} else if (
-					isObjectError ||
-					(event == 'blur' &&
-						error.value &&
-						LastChanges.map((c) => c.join()).includes(error.path.join()))
-				) {
-					previousError.set(error.value);
-				}
-
-				break;
-
-			/*
-			case 'onblur':
-				if (event == 'blur') previousError.set(data.value);
-				break;
-
-			case 'oninput':
-				if (event == 'input') previousError.set(data.value);
-				break;
-
-			case 'submit-only':
-				if (event == 'submit') previousError.set(data.value);
-				break;
-			*/
-//path?.set(data.value);
-
-/*
-export function clearErrors<T extends Record<string, unknown>>(
-	Errors: Writable<ValidationErrors<T>>,
-	options: {
-		undefinePath: (string | number | symbol)[] | null;
-		clearFormLevelErrors: boolean;
-	}
-) {
-	Errors.update(($errors) => {
-		traversePaths($errors, (pathData) => {
-			if (
-				pathData.path.length == 1 &&
-				pathData.path[0] == '_errors' &&
-				!options.clearFormLevelErrors
-			) {
-				return;
-			}
-			if (Array.isArray(pathData.value)) {
-				return pathData.set(undefined);
-			}
-		});
-
-		if (options.undefinePath) setPaths($errors, [options.undefinePath], undefined);
-
-		return $errors;
-	});
-}
-*/
-
 export function flattenErrors(errors: ValidationErrors<Record<string, unknown>>) {
 	return _flattenErrors(errors, []);
 }

src/lib/formData.ts

@@ -265,20 +265,4 @@ function parseFormDataEntry(key: string, value: string, info: SchemaInfo): unkno
 		default:
 			throw new SuperFormError('Unsupported schema type for FormData: ' + type);
 	}
-
-	// TODO: Enum parsing
-	/*
-	} else if (type == 'NativeEnum') {
-		const zodEnum = zodType as ZodNativeEnum<EnumLike>;
-
-		if (value !== null && value in zodEnum.enum) {
-			const enumValue = zodEnum.enum[value];
-			if (typeof enumValue === 'number') return enumValue;
-			else if (enumValue in zodEnum.enum) return zodEnum.enum[enumValue];
-		} else if (value !== null && Object.values(zodEnum.enum).includes(value)) {
-			return value;
-		}
-		return undefined;
-	} 
-	*/
 }

src/lib/index.ts

@@ -71,7 +71,6 @@ export type TaintedFields<T extends Record<string, unknown>> = SuperStructArray<
 
 // Cannot be a SuperStruct due to Property having to be passed on.
 // Deep recursive problem fixed thanks to https://www.angularfix.com/2022/01/why-am-i-getting-instantiation-is.html
-// TODO: Parameter for validator function must be optional
 export type Validators<T extends Record<string, unknown>> = Partial<{
 	// eslint-disable-next-line @typescript-eslint/no-explicit-any
 	[Property in keyof T]: T extends any

src/lib/traversal.ts

@@ -16,7 +16,7 @@ function setPath<T extends object>(parent: T, key: keyof T, value: any) {
 	return 'skip' as const;
 }
 
-export function isInvalidPath(originalPath: (string | number | symbol)[], pathData: PathData) {
+function isInvalidPath(originalPath: (string | number | symbol)[], pathData: PathData) {
 	return (
 		pathData.value !== undefined &&
 		typeof pathData.value !== 'object' &&
@@ -68,7 +68,7 @@ export function traversePath<T extends object>(
 			: parent[key];
 
 		if (value === undefined) return undefined;
-		else parent = value as T; // TODO: Handle non-object values
+		else parent = value as T;
 
 		path.push(realPath[path.length]);
 	}

src/routes/(v1)/tests/issue-176/+page.svelte

@@ -20,7 +20,6 @@
 					setError(form, 'email', 'Suspicious email address.');
 				} else if (form.valid) {
 					setMessage(form, 'Valid data!');
-					// TODO: Do something with the validated data
 				}
 			},
 			onError({ result, message }) {

src/routes/(v1)/tests/reset-component/Form.svelte

@@ -25,7 +25,6 @@
 		onUpdate({ form }) {
 			if (form.valid) {
 				console.log('form is valid', form.data);
-				// TODO: Do something with the validated form.data
 			}
 		}
 	});

src/tests/JSONSchema.test.ts

@@ -117,7 +117,6 @@ describe('Default values', () => {
 		} satisfies JSONSchema7;
 
 		expect(defaultValues(schema)).toEqual({
-			// TODO: Default value for an array with an item that has a default value?
 			numberArray: []
 		});
 	});