@odatnurd/cf-requests 0.1.0 → 0.1.2

package/README.md

@@ -56,9 +56,6 @@ fields declared by the schema are present.
 
 
 ```js
-/******************************************************************************/
-
-
 import { validate, success, routeHandler } from '#lib/common';
 
 import * as testSchema from '#schemas/test';
@@ -79,7 +76,6 @@ export const $post = routeHandler(
     return success(ctx, 'request body validated', body);
   },
 );
-
 ```
 
 ## Methods
@@ -88,11 +84,13 @@ export const $post = routeHandler(
 export function success(ctx, message, result, status) {}
 ```
 
-Indicate a successful return in JSON with the given `HTTP` status code:
+Indicate a successful return in JSON with the given `HTTP` status code; the
+status code is used to construct the JSON as well as the response:
 
 ```js
 {
     "success": true,
+    status,
     message,
     data: result
 }
@@ -140,27 +138,6 @@ On success, the data is placed in the context. If the data does not pass the
 validation of the schema, the `fail()` method is invoked on it with a status of
 `422` to signify the issue directly.
 
-Execute a fetch operation on the provided database, using the data in `sqlargs`
-to create the statement(s) to be executed, and return the result(s) of the
-query after logging statistics such as the rows read and written, which will be
-annotated with the action string provided to give context to the operation.
-
-The provided `sqlargs` is a variable length list of arguments that consists of
-strings to be compiled to SQL, previously compiled statements, and/or arrays of
-values to bind to statements.
-
-For the purposes of binding, arrays will bind to the most recently seen
-statement, allowing you to compile one statement and bind it multiple times if
-desired.
-
-When more than one statement is provided, all statements will be executed as a
-batch operation, which implicitly runs as a transaction.
-
-The return value is the direct result of executing the query or queries given
-in `sqlargs`; this is either a (potentially empty) array of result rows, or an
-array of such arrays (if a batch). As with `dbRawQuery`, the `meta` is stripped
-from the results, providing you just the actual query result.
-
 ---
 
 ```js
@@ -184,6 +161,10 @@ export const $post = [
   body(async (ctx) => {
     const body = ctx.req.valid('json');
 
+    if (body.key1 != 69) {
+      throw new Error('key is not nice');
+    }
+
     return success(ctx, 'code test worked', body);
   }),
 ];

package/lib/handlers.js

@@ -16,7 +16,7 @@ export const success = (ctx, message, result, status) => {
   result ??= [];
 
   ctx.status(status);
-  return ctx.json({ success: true, message, data: result });
+  return ctx.json({ success: true, status, message, data: result });
 }
 
 
@@ -31,7 +31,7 @@ export const fail = (ctx, message, status, result) => {
   status ??= 400;
 
   ctx.status(status);
-  return ctx.json({ success: false, message, data: result });
+  return ctx.json({ success: false, status, message, data: result });
 }
 
 

package/package.json

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