1.5.2

- `soft` versions can now also return the parsed value if there was one returned but it did not pass the validation. This is useful when you want to show the user the parsed value in the form after a validation error.
auth70 · Apr 3, 2024 · 2362e60 · 2362e60
1 parent dd57258
commit 2362e60
Show file tree

Hide file tree

Showing 5 changed files with 136 additions and 61 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.5.2 (2024-04-03)
+
+- `soft` versions can now also return the parsed value if there was one returned but it did not pass the validation. This is useful when you want to show the user the parsed value in the form after a validation error.
+
 ## 1.5.1 (2024-04-03)
 
 - Added missing export for `BodyguardFormConfig` interface

diff --git a/README.md b/README.md
@@ -317,7 +317,7 @@ Below are the methods and types available in the Bodyguard class.
 - `maxFilenameLength?`: `number` - Maximum allowed length of a filename in the body. Default: `255`
 - `allowedContentTypes?`: `string[]` - Allowed content types for file uploads. Default: `undefined`
 
-#### `BodyguardResult<T> = BodyguardSuccess<T> | BodyguardError`
+#### `BodyguardResult<T> = BodyguardSuccess<T> | BodyguardError<T>`
 
 - `success`: `boolean` - Whether the parsing was successful.
 - `error?`: `Error` - The error that occurred, if any.
@@ -328,10 +328,11 @@ Below are the methods and types available in the Bodyguard class.
 - `success`: `true`
 - `value`: `T`
 
-#### `BodyguardError`
+#### `BodyguardError<T>`
 
 - `success`: `false`
 - `error`: `Error`
+- `value?`: `T`
 
 #### `BodyguardValidator<T = JSONLike> = (obj: JSONLike) => T`
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@auth70/bodyguard",
-  "version": "1.5.1",
+  "version": "1.5.2",
   "description": "Fetch API compatible streaming JSON and form data body parser and guard",
   "keywords": [
     "request",

diff --git a/src/index.ts b/src/index.ts
@@ -109,6 +109,37 @@ export class Bodyguard {
         }
     }
 
+    private async formInternal<
+        K extends JSONLike = JSONLike
+    > (
+        input: Request | Response,
+        config?: Partial<BodyguardFormConfig>,
+    ): Promise<K> {
+        if(!input.body) throw new Error(ERRORS.BODY_NOT_AVAILABLE);
+        const instanceConfig = this.constructConfig(config || {});
+
+        const contentType = input.headers.get("content-type");
+        if (!contentType || contentType === '') throw new Error(ERRORS.NO_CONTENT_TYPE);
+
+        const bodyType = contentType === "application/x-www-form-urlencoded" ? "params" : "formdata";
+
+        let boundary = "";
+        if(contentType.includes("boundary")) {
+            const match = contentType.match(/boundary=(.*)/);
+            if (!match || !match[1]) {
+                throw new Error(ERRORS.INVALID_CONTENT_TYPE);
+            }
+            boundary = match[1];
+        }
+
+        if(bodyType === "formdata" && !boundary) throw new Error(ERRORS.INVALID_CONTENT_TYPE);
+
+        const parser = bodyType === "params" ? new URLParamsParser(instanceConfig) : new FormDataParser(instanceConfig as BodyguardFormConfig, boundary);
+        const ret = await parser.parse(input.body);
+
+        return ret as K;
+    }
+
     /**
      * Attempts to parse a form from a Request or Response. Returns the parsed object in case of success and 
      * an error object in case of failure.
@@ -126,10 +157,24 @@ export class Bodyguard {
         config?: Partial<BodyguardFormConfig>
     ): Promise<BodyguardResult<K>> {
         try {
-            const res = await this.form(input, validator, config);
-            return {
-                success: true,
-                value: res as K
+            const ret = await this.formInternal(input, config);
+            try {
+                if(validator) {
+                    return {
+                        success: true,
+                        value: await Promise.resolve(validator(ret)) as K
+                    }
+                }
+                return {
+                    success: true,
+                    value: ret as K
+                }
+            } catch(err) {
+                return {
+                    success: false,
+                    error: err,
+                    value: ret as K
+                }
             }
         } catch(e: any) {
             return {
@@ -144,6 +189,7 @@ export class Bodyguard {
      * @param {Request | Response} input - Request or Response to parse the form from.
      * @param {BodyguardValidator} validator - Optional validator to validate the parsed form against.
      * @param {Partial<BodyguardFormConfig>} config - Optional configuration to override the default configuration.
+     * @param {boolean} soft - Whether to throw an error or return an error object in case of failure.
      * @return {Promise<K>} - Parsed form from the Request or Response.
      * @throws {Error} - If content-type is not present or is invalid, or the form data is invalid, it throws an error.
      */
@@ -153,36 +199,27 @@ export class Bodyguard {
     > (
         input: Request | Response,
         validator?: T,
-        config?: Partial<BodyguardFormConfig>
+        config?: Partial<BodyguardFormConfig>,
+        soft?: boolean
     ): Promise<K> {
-        if(!input.body) throw new Error(ERRORS.BODY_NOT_AVAILABLE);
-        const instanceConfig = this.constructConfig(config || {});
-
-        const contentType = input.headers.get("content-type");
-        if (!contentType || contentType === '') throw new Error(ERRORS.NO_CONTENT_TYPE);
-
-        const bodyType = contentType === "application/x-www-form-urlencoded" ? "params" : "formdata";
-
-        let boundary = "";
-        if(contentType.includes("boundary")) {
-            const match = contentType.match(/boundary=(.*)/);
-            if (!match || !match[1]) {
-                throw new Error(ERRORS.INVALID_CONTENT_TYPE);
-            }
-            boundary = match[1];
-        }
-
-        if(bodyType === "formdata" && !boundary) throw new Error(ERRORS.INVALID_CONTENT_TYPE);
-
-        const parser = bodyType === "params" ? new URLParamsParser(instanceConfig) : new FormDataParser(instanceConfig as BodyguardFormConfig, boundary);
-        const ret = await parser.parse(input.body);
-
+        const ret = await this.formInternal(input, config);
         if(validator) {
             return await Promise.resolve(validator(ret)) as K;
         }
-
         return ret as K;
+    }
 
+    private async jsonInternal<
+        K extends JSONLike = JSONLike
+    > (
+        input: Request | Response,
+        config?: Partial<BodyguardConfig>
+    ): Promise<K> {
+        if(!input.body) throw new Error(ERRORS.BODY_NOT_AVAILABLE);
+        const instanceConfig = this.constructConfig(config || {});
+        const parser = new JSONParser(instanceConfig);
+        const ret = await parser.parse(input.body);
+        return ret as K;
     }
 
     /**
@@ -202,10 +239,24 @@ export class Bodyguard {
         config?: Partial<BodyguardConfig>
     ): Promise<BodyguardResult<K>> {
         try {
-            const res = await this.json(input, validator, config);
-            return {
-                success: true,
-                value: res as K
+            const ret = await this.jsonInternal(input, config);
+            try {
+                if(validator) {
+                    return {
+                        success: true,
+                        value: await Promise.resolve(validator(ret)) as K
+                    }
+                }
+                return {
+                    success: true,
+                    value: ret as K
+                }
+            } catch(err) {
+                return {
+                    success: false,
+                    error: err,
+                    value: ret as K
+                }
             }
         } catch(e: any) {
             return {
@@ -231,17 +282,23 @@ export class Bodyguard {
         validator?: T,
         config?: Partial<BodyguardConfig>
     ): Promise<K> {
-
-        if(!input.body) throw new Error(ERRORS.BODY_NOT_AVAILABLE);
-        const instanceConfig = this.constructConfig(config || {});
-
-        const parser = new JSONParser(instanceConfig);
-        const ret = await parser.parse(input.body);
-
+        const ret = await this.jsonInternal(input, config);
         if(validator) {
             return await Promise.resolve(validator(ret)) as K;
         }
+        return ret as K;
+    }
 
+    private async textInternal<
+        K extends JSONLike = JSONLike
+    > (
+        input: Request | Response,
+        config?: Partial<BodyguardConfig>
+    ): Promise<K> {
+        if(!input.body) throw new Error(ERRORS.BODY_NOT_AVAILABLE);
+        const instanceConfig = this.constructConfig(config || {});
+        const parser = new TextParser(instanceConfig);
+        const ret = await parser.parse(input.body);
         return ret as K;
     }
 
@@ -262,10 +319,24 @@ export class Bodyguard {
         config?: Partial<BodyguardConfig>
     ): Promise<BodyguardResult<K>> {
         try {
-            const res = await this.text(input, validator, config);
-            return {
-                success: true,
-                value: res as K
+            const ret = await this.textInternal(input, config);
+            try {
+                if(validator) {
+                    return {
+                        success: true,
+                        value: await Promise.resolve(validator(ret)) as K
+                    }
+                }
+                return {
+                    success: true,
+                    value: ret as K
+                }
+            } catch(err) {
+                return {
+                    success: false,
+                    error: err,
+                    value: ret as K
+                }
             }
         } catch(e: any) {
             return {
@@ -291,10 +362,7 @@ export class Bodyguard {
         validator?: T,
         config?: Partial<BodyguardConfig>
     ): Promise<K> {
-        if(!input.body) throw new Error(ERRORS.BODY_NOT_AVAILABLE);
-        const instanceConfig = this.constructConfig(config || {});
-        const parser = new TextParser(instanceConfig);
-        const ret = await parser.parse(input.body);
+        const ret = await this.textInternal(input, config);
         if(validator) {
             return await Promise.resolve(validator(ret)) as K;
         }

diff --git a/src/lib.ts b/src/lib.ts
@@ -58,27 +58,29 @@ export interface BodyguardFormConfig extends BodyguardConfig {
     allowedContentTypes: string[] | undefined;
 }
 
-export type BodyguardError = {
+export type JSONLike =
+    | { [property: string]: JSONLike }
+    | readonly JSONLike[]
+    | string
+    | number
+    | boolean
+    | File
+    | null;
+
+export type BodyguardError<T = JSONLike> = {
     success: false;
     /** The error message */
     error: unknown;
+    /** The value that was being processed. May be undefined if the error occurred before the value was processed. */
+    value?: T;
 };
 
 export type BodyguardSuccess<T = JSONLike> = {
     success: true;
     value: T;
 };
 
-export type JSONLike =
-    | { [property: string]: JSONLike }
-    | readonly JSONLike[]
-    | string
-    | number
-    | boolean
-    | File
-    | null;
-
-export type BodyguardResult<SuccessType = JSONLike> = BodyguardSuccess<SuccessType> | BodyguardError;
+export type BodyguardResult<T = JSONLike> = BodyguardSuccess<T> | BodyguardError<T>;
 
 /*
  * Utility functions