message and setError throws if the status option is below 400.

Support for passthrough on a schema.

Author: ciscoheat

CHANGELOG.md

@@ -12,10 +12,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - For type safety, you cannot send `null` or `undefined` to `superForm` anymore. Use `superValidate`, or pass a complete data object to `superForm`. Default values can be added with the `defaultValues` function.
 - The `valid` option is removed from `message`, any status >= 400 will return a fail.
 
+### Changed
+
+- `message/setMessage` and `setError` will now throw an error if the status option is below 400.
+
 ### Added
 
 - Arrays and objects in the schema can now have errors! They can be found at `field._errors` in the `$errors` store.
 - `validate` will now validate the whole form when it's called with no arguments.
+- Support for `passthrough()` on a schema, `superValidate` will allow extra keys in that case.
 
 ## [1.0.0-rc.2]
 
@@ -36,7 +41,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Errors can now be added to arrays and objects in the schema.
 - Added a `posted` store, a boolean which is false if the form hasn't been posted during its current lifetime.
 - `reset` now has an additional `data` option that can be used to re-populate the form with data, and `id` to set a different form id.
 - `intProxy`, `numberProxy`, `dateProxy` and `stringProxy` now have an `empty` option, so empty values can be set to `null` or `undefined`.

src/index.test.ts

@@ -979,3 +979,55 @@ describe('Schema errors with arrays and objects', () => {
     expect(form.errors.tags?.[0]).toBeUndefined();
   });
 });
+
+test('Passthrough validation', async () => {
+  const schema = z.object({
+    name: z.string().min(2)
+  });
+
+  const data = {
+    name: 'test',
+    extra: 'field'
+  };
+
+  const form = await superValidate(data, schema.passthrough());
+  assert(form.valid === true);
+  expect(form.data).toStrictEqual({
+    name: 'test',
+    extra: 'field'
+  });
+
+  const failedData = {
+    name: '',
+    extra2: 'field2'
+  };
+
+  const form2 = await superValidate(failedData, schema.passthrough());
+  assert(form2.valid === false);
+  expect(form2.data).toStrictEqual({
+    name: '',
+    extra2: 'field2'
+  });
+
+  const data3 = {
+    name: 'test',
+    extra: 'field'
+  };
+
+  const form3 = await superValidate(data3, schema);
+  assert(form3.valid === true);
+  expect(form3.data).toStrictEqual({
+    name: 'test'
+  });
+
+  const failedData2 = {
+    name: '',
+    extra2: 'field2'
+  };
+
+  const form4 = await superValidate(failedData2, schema);
+  assert(form4.valid === false);
+  expect(form4.data).toStrictEqual({
+    name: ''
+  });
+});

src/lib/superValidate.ts

@@ -43,16 +43,26 @@ import { mapErrors } from './errors.js';
 
 export { defaultValues } from './schemaEntity.js';
 
+/**
+ * Sends a message with a form, with an optional HTTP status code that will set
+ * form.valid to false if status >= 400. A status lower than 400 cannot be sent.
+ */
 export function message<T extends ZodValidation<AnyZodObject>, M>(
   form: SuperValidated<T, M>,
   message: M,
   options?: {
     status?: number;
   }
 ) {
-  form.message = message;
-  if (options?.status && options.status >= 400) form.valid = false;
+  if (options?.status) {
+    if (options.status >= 400) form.valid = false;
+    else
+      throw new SuperFormError(
+        'Cannot set a form message status lower than 400.'
+      );
+  }
 
+  form.message = message;
   return !form.valid ? fail(options?.status ?? 400, { form }) : { form };
 }
 
@@ -68,6 +78,10 @@ export function setError<T extends ZodValidation<AnyZodObject>>(
     status: 400
   }
 ) {
+  if (options.status && options.status < 400) {
+    throw new SuperFormError('Cannot set an error status lower than 400.');
+  }
+
   const errArr = Array.isArray(error) ? error : [error];
 
   if (!form.errors) form.errors = {};
@@ -328,7 +342,12 @@ function validateResult<T extends AnyZodObject, M>(
       constraints: entityInfo.constraints
     };
   } else {
-    const { opts: options, schemaKeys, entityInfo } = schemaData;
+    const {
+      opts: options,
+      schemaKeys,
+      entityInfo,
+      unwrappedSchema
+    } = schemaData;
 
     if (!result) {
       throw new SuperFormError(
@@ -343,19 +362,27 @@ function validateResult<T extends AnyZodObject, M>(
           ? mapErrors<T>(result.error.format(), entityInfo.errorShape)
           : {};
 
+      // passthrough, strip, strict
+      const zodKeyStatus = unwrappedSchema._def.unknownKeys;
+
+      const data =
+        zodKeyStatus == 'passthrough'
+          ? { ...clone(entityInfo.defaultEntity), ...partialData }
+          : Object.fromEntries(
+              schemaKeys.map((key) => [
+                key,
+                key in partialData
+                  ? partialData[key]
+                  : clone(entityInfo.defaultEntity[key])
+              ])
+            );
+
       return {
         id,
         valid: false,
         posted,
         errors,
-        data: Object.fromEntries(
-          schemaKeys.map((key) => [
-            key,
-            key in partialData
-              ? partialData[key]
-              : clone(entityInfo.defaultEntity[key])
-          ])
-        ),
+        data,
         constraints: entityInfo.constraints
       };
     } else {
@@ -522,61 +549,6 @@ export async function superValidate<
   return validateResult<UnwrapEffects<T>, M>(parsed, schemaData, result);
 }
 
-export function actionResult<
-  T extends Record<string, unknown> | App.Error | string,
-  Type extends T extends string
-    ? 'redirect' | 'error'
-    : 'success' | 'failure' | 'error'
->(
-  type: Type,
-  data?: T,
-  options?:
-    | number
-    | {
-        status?: number;
-        message?: Type extends 'redirect' ? App.PageData['flash'] : never;
-      }
-) {
-  const status =
-    options && typeof options !== 'number' ? options.status : options;
-
-  const result = <T extends { status: number }>(struct: T) => {
-    return json(
-      { type, ...struct },
-      {
-        status: struct.status,
-        headers:
-          typeof options === 'object' && options.message
-            ? {
-                'Set-Cookie': `flash=${encodeURIComponent(
-                  JSON.stringify(options.message)
-                )}; Path=/; Max-Age=120`
-              }
-            : undefined
-      }
-    );
-  };
-
-  if (type == 'error') {
-    return result({
-      status: status || 500,
-      error: typeof data === 'string' ? { message: data } : data
-    });
-  } else if (type == 'redirect') {
-    return result({
-      status: status || 303,
-      location: data
-    });
-  } else if (type == 'failure') {
-    return result({
-      status: status || 400,
-      data: stringify(data)
-    });
-  } else {
-    return result({ status: status || 200, data: stringify(data) });
-  }
-}
-
 ////////////////////////////////////////////////////////////////////
 
 export function superValidateSync<
@@ -647,3 +619,60 @@ export function superValidateSync<
 
   return validateResult<UnwrapEffects<T>, M>(parsed, schemaData, result);
 }
+
+///////////////////////////////////////////////////////////////////////////////
+
+export function actionResult<
+  T extends Record<string, unknown> | App.Error | string,
+  Type extends T extends string
+    ? 'redirect' | 'error'
+    : 'success' | 'failure' | 'error'
+>(
+  type: Type,
+  data?: T,
+  options?:
+    | number
+    | {
+        status?: number;
+        message?: Type extends 'redirect' ? App.PageData['flash'] : never;
+      }
+) {
+  const status =
+    options && typeof options !== 'number' ? options.status : options;
+
+  const result = <T extends { status: number }>(struct: T) => {
+    return json(
+      { type, ...struct },
+      {
+        status: struct.status,
+        headers:
+          typeof options === 'object' && options.message
+            ? {
+                'Set-Cookie': `flash=${encodeURIComponent(
+                  JSON.stringify(options.message)
+                )}; Path=/; Max-Age=120`
+              }
+            : undefined
+      }
+    );
+  };
+
+  if (type == 'error') {
+    return result({
+      status: status || 500,
+      error: typeof data === 'string' ? { message: data } : data
+    });
+  } else if (type == 'redirect') {
+    return result({
+      status: status || 303,
+      location: data
+    });
+  } else if (type == 'failure') {
+    return result({
+      status: status || 400,
+      data: stringify(data)
+    });
+  } else {
+    return result({ status: status || 200, data: stringify(data) });
+  }
+}