fix custom validation, add jsdoc annotations

Author: brendanbond

src/process/validation/rules/validateCustom.ts

@@ -16,7 +16,7 @@ export const shouldValidate = (context: ValidationContext) => {
 };
 
 export const validateCustomSync: RuleFnSync = (context: ValidationContext) => {
-  const { component, index, instance } = context;
+  const { component, index, instance, value, data, row, submission } = context;
   const customValidation = component.validate?.custom;
   try {
     if (!shouldValidate(context) || !customValidation) {
@@ -25,9 +25,16 @@ export const validateCustomSync: RuleFnSync = (context: ValidationContext) => {
 
     const validationContext: any = instance?.evalContext ? instance.evalContext() : context;
 
+    // We have to augment some of the evalContext values here if the evalContext comes from the instance
     const isValid = evaluate(customValidation, validationContext, 'valid', true, (context) => {
+      context.component = component;
+      context.data = data;
+      context.row = row;
       context.rowIndex = typeof index === 'number' ? index : validationContext.rowIndex;
+      context.instance = instance;
       context.valid = true;
+      context.input = value;
+      context.submission = submission;
     });
 
     if (isValid === null || isValid === true) {

src/utils/utils.ts

@@ -109,6 +109,16 @@ type EvaluatorContext = {
 };
 export type EvaluatorFn = (context: EvaluatorContext) => any;
 
+/**
+ * A convenience function that wraps Evaluator.evaluate and normalizes context values
+ * @param evaluation - The code string to evaluate
+ * @param context - The processor context
+ * @param ret - The return value
+ * @param interpolate - Whether or not to interpolate the code string before evaluating
+ * @param evalContextFn - A callback to mutate the context value after it has been normalized
+ * @param options - Options to pass to the Evaluator
+ * @returns {*} - Returns the result of the evaluation
+ */
 export function evaluate(
   evaluation: string,
   context: EvaluatorContext,