@odatnurd/cf-requests 0.1.10 → 0.1.11

package/README.md

@@ -233,11 +233,12 @@ status code is used to construct the JSON as well as the response object:
 `status` is option and defaults to `200` if not provided.
 
 If the `verify()` function was used to set a schema, then this function will
-validate that the `result` you provide matches the schema, and will also
-optionally mask it, if `verify()` was given a mask function.
+validate that the **entire returned body, including `result`** you provide
+matches the schema, and will also optionally mask it, if `verify()` was given
+a mask function.
 
-When using `verify()`, if the data in `result` does not conform to the schema,
-a `SchemaError` exception will be thrown. This is automatically handled by
+When using `verify()`, if the result body does not conform to the schema, a
+`SchemaError` exception will be thrown. This is automatically handled by
 `body()`, and will result in a `fail()` response instead of a `success()`.
 
 ---
@@ -300,8 +301,12 @@ export function verify({ validate, mask? }) {}
 ```
 
 This function registers the provided validation/masking pair for the current
-route. This causes `success` to validate (and optionally mask) the data payload
-that you give it before finalizing the request and sending the data out.
+route. This causes `success` to validate (and optionally mask) the resulting
+message body before finalizing the request and sending the data out.
+
+> ℹ️ The schema is run over the **entire returned body, not just the`result`**,
+> so in practice the schema needs to match what the `success()` function uses
+> as the final result.
 
 The parameter should be an object that contains a `validate` and an (optional)
 `mask` member:

package/lib/handlers.js

@@ -64,13 +64,16 @@ export const success = async (ctx, message, result, status) => {
   status ??= 200;
   result ??= [];
 
+  // Construct the body that we will be returning back.
+  let body = { success: true, status, message, data: result };
+
   // See if there is a validator attached to this; if so, we have more work to
   // do; if not, we can skip.
   const validator = ctx.get('__cf_requests_response_validator');
   if (validator !== undefined) {
     // Try to validate; if this does not return true, then the data is not valid
     // and we should throw an error.
-    const valid = validator.validate(result);
+    const valid = validator.validate(body);
     if (valid !== true) {
       throw new SchemaError('response data failed schema validation', 500, valid);
     }
@@ -78,12 +81,12 @@ export const success = async (ctx, message, result, status) => {
     // If there is a mask function, then use it to set up the value of the
     // result.
     if (typeof validator.mask === 'function') {
-      result = validator.mask(result);
+      body = validator.mask(body);
     }
   }
 
   ctx.status(status);
-  return ctx.json({ success: true, status, message, data: result });
+  return ctx.json(body);
 }
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@odatnurd/cf-requests",
-  "version": "0.1.10",
+  "version": "0.1.11",
   "description": "Simple Cloudflare Hono request wrapper",
   "author": "OdatNurd (https://odatnurd.net)",
   "homepage": "https://github.com/OdatNurd/cf-requests",