@nano-app/backend 0.12.0 → 0.12.2

package/README.md

@@ -34,7 +34,7 @@ createNanoApp({ port: 3000 });
 import { createRoute } from '@nano-app/backend';
 
 export default createRoute({
-  GET: async () => ({ success: true, result: { status: 'ok' } }),
+  GET: async () => ({ result: { status: 'ok' } }),
 });
 ```
 
@@ -53,16 +53,17 @@ Each `*.route.ts` under `mainPlugin.routesDir` default-exports an object with th
 ```ts
 export default createRoute({
   expression: '/:id',                                  // → /users/:id
-  GET:    async req => ({ success: true, result: { id: req.params.id } }),
-  DELETE: async req => ({ success: true, message: 'Deleted' }),
+  GET:    async req => ({ result: { id: req.params.id } }),
+  DELETE: async req => ({ message: 'Deleted' }),
 });
 ```
 
-Each handler receives `(req, params)` and returns an `ApiResponse`. `params` holds the plugin's `options`, `db` (the Prisma client when a database is enabled, see [Database](#database)) and `onBeforeResult` (see [Callbacks](#callbacks)):
+Each handler receives `(req, params)` and returns an `ApiResponse` without `success`: its `status` is the HTTP status (`200` by default) and the framework sets `success` to `status < 400`. `params` holds the plugin's `options`, `db` (the Prisma client when a database is enabled, see [Database](#database)) and `onBeforeResult` (see [Callbacks](#callbacks)):
 
 ```ts
 type ApiResponse<T> = {
-  success?: boolean;   // true → HTTP 200, any other value → HTTP 400
+  status?: number;     // HTTP status, 200 by default; not sent in the body
+  success?: boolean;   // set by the framework: status < 400
   result?: T;
   message?: string;
   warning?: boolean;
@@ -88,6 +89,8 @@ Every option is optional.
 
 `packages` accepts `morgan`, `cors`, `helmet`, `compression`, `rateLimit`, `express` (`express.json` options), `urlencoded` and `betterAuth` (off by default: see [Better Auth](#better-auth)). The merge is **per section**: passing one key keeps the others; pass `false` to disable one.
 
+`morgan` logs `:timestamp | :method :path :status` by default: `:path` is the path without its query string, so tokens sent there stay out of the logs. Set `format` with `:url` to log the full URL.
+
 ```ts
 createNanoApp({
   settings: { 'trust proxy': 1 },
@@ -135,7 +138,7 @@ import { createRoute } from '@nano-app/backend';
 import type { PrismaClient } from '../../.nano-app/prisma-clients/app/generated/client';
 
 export default createRoute<PrismaClient>({
-  GET: async (_req, { db }) => ({ success: true, result: await db!.user.findMany() }),
+  GET: async (_req, { db }) => ({ result: await db!.user.findMany() }),
 });
 ```
 
@@ -220,7 +223,7 @@ export default createPlugin((options?: { basePath?: string }) => ({
 import { createRoute } from '@nano-app/backend';
 
 export default createRoute({
-  GET: async () => ({ success: true, result: { ok: true } }),
+  GET: async () => ({ result: { ok: true } }),
 });
 ```
 
@@ -261,7 +264,7 @@ The endpoints of one plugin have no guaranteed order: one route's `onInit` must
 
 Everything is mounted on one Express application, in this order: base middlewares → `before` plugins → your routes → `after` plugins → 404 → error handler.
 
-A plugin with a database follows the same rules, with its client in `.nano-app/prisma-clients/<name>`: a plugin of yours points `database.schemaPath` at its schema and you apply it with Prisma. Two plugins with the same name and a database fail at startup. If that folder holds the client of another schema from an earlier start, the startup warns and replaces it. An official plugin of `@nano-app/plugins` needs nothing from you: at startup nano-app applies its migrations to its own `nano_*` schema. See [PLUGINS.md](https://github.com/Nano-Nathan/nano-app/blob/main/PLUGINS.md).
+A plugin with a database follows the same rules, with its client in `.nano-app/prisma-clients/<name>`: a plugin of yours points `database.schemaPath` at its schema and you apply it with Prisma. Two plugins with the same name and a database fail at startup. If that folder holds the client of another schema from an earlier start, the startup warns and replaces it. An official plugin of `@nano-app/plugins` needs nothing from you: at startup nano-app applies its migrations to its own `nano_*` schema. See [`@nano-app/plugins`](https://github.com/Nano-Nathan/nano-app/blob/main/plugins/README.md#database).
 
 ## Errors
 

package/build/index.d.ts

@@ -7,6 +7,7 @@ import { BetterAuthOptions } from "better-auth";
 //#region ../core/types/api.d.ts
 /** API response */
 type ApiResponse<T = any> = {
+  status?: number;
   success?: boolean;
   result?: T;
   message?: string;

package/build/index.js

@@ -191,7 +191,12 @@ var Endpoint = class {
 				...oRequestParams,
 				onBeforeResult
 			})).then((oResponse) => {
-				oRes.status(oResponse.success ? 200 : 400).json(oResponse);
+				const { status, ...oBody } = oResponse;
+				const iStatus = status ?? 200;
+				oRes.status(iStatus).json({
+					...oBody,
+					success: iStatus < 400
+				});
 			}).catch(fnNext);
 		};
 	}
@@ -439,8 +444,11 @@ const INITIAL_CONFIG = {
 	/** Initial middlewares */
 	packages: {
 		morgan: {
-			tokens: { timestamp: () => Formatter.logDate() },
-			format: ":timestamp | :method :url :status"
+			tokens: {
+				timestamp: () => Formatter.logDate(),
+				path: (oReq) => oReq.path
+			},
+			format: ":timestamp | :method :path :status"
 		},
 		cors: { methods: [
 			"GET",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nano-app/backend",
-  "version": "0.12.0",
+  "version": "0.12.2",
   "description": "Express server with file-convention routes, plugins and an optional PostgreSQL layer",
   "type": "module",
   "main": "build/index.js",
@@ -45,7 +45,7 @@
   "dependencies": {
     "compression": "^1.8.2",
     "cors": "^2.8.6",
-    "dotenv": "^18.0.8",
+    "dotenv": "^18.0.9",
     "express": "^5.3.0",
     "express-rate-limit": "^8.7.1",
     "glob": "^13.0.6",