@ttoss/http-server 0.1.16 → 0.3.0

package/README.md

@@ -1,6 +1,6 @@
 # @ttoss/http-server
 
-HTTP server for Node.js for ttoss ecosystem.
+Lightweight HTTP server built on [Koa](https://koajs.com/) for the ttoss ecosystem.
 
 ## Installation
 
@@ -8,7 +8,7 @@ HTTP server for Node.js for ttoss ecosystem.
 pnpm add @ttoss/http-server
 ```
 
-## Usage
+## Quick Start
 
 ```typescript
 import { App, Router, bodyParser, cors } from '@ttoss/http-server';
@@ -16,29 +16,98 @@ import { App, Router, bodyParser, cors } from '@ttoss/http-server';
 const app = new App();
 
 app.use(cors());
-
 app.use(bodyParser());
 
-const route = new Router();
+const router = new Router();
 
-route.get('/health', (ctx) => {
-  ctx.body = 'OK';
+router.get('/health', (ctx) => {
+  ctx.body = { status: 'ok' };
 });
 
-app.use(route.routes());
-
+app.use(router.routes());
 app.use(router.allowedMethods());
 
 app.listen(3000, () => {
-  console.log('Server is running on port 3000');
+  console.log('Server running on http://localhost:3000');
+});
+```
+
+### Health Check Endpoint
+
+Add a health check endpoint with a single line:
+
+```typescript
+import { App, addHealthCheck } from '@ttoss/http-server';
+
+const app = new App();
+
+addHealthCheck({ app });
+// or with custom path: addHealthCheck({ app, path: '/healthz' });
+
+app.listen(3000);
+// GET /health returns { status: 'ok' }
+```
+
+## Core Features
+
+### Route Parameters
+
+```typescript
+router.get('/users/:id', (ctx) => {
+  const { id } = ctx.params;
+  ctx.body = { userId: id };
+});
+```
+
+### Request Body Parsing
+
+JSON and form-urlencoded data are automatically parsed when using `bodyParser()`:
+
+```typescript
+router.post('/users', (ctx) => {
+  const userData = ctx.request.body;
+  ctx.body = { created: userData };
+});
+```
+
+### File Uploads
+
+```typescript
+import { multer } from '@ttoss/http-server';
+import type { MulterFile } from '@ttoss/http-server';
+
+const upload = multer();
+
+router.post('/upload', upload.single('file'), (ctx) => {
+  const file = ctx.file as MulterFile | undefined;
+  ctx.body = {
+    filename: file?.originalname,
+    size: file?.size,
+  };
+});
+```
+
+### Error Handling
+
+```typescript
+app.use(async (ctx, next) => {
+  try {
+    await next();
+  } catch (error) {
+    ctx.status = error.status || 500;
+    ctx.body = { error: error.message };
+  }
 });
 ```
 
-## API
+## API Reference
 
-Some methods are re-exports from other libraries:
+All exports are re-exported from established Koa ecosystem packages:
 
-- `App` - [Koa application](https://github.com/koajs/koa)
-- `Router` - [Koa router](https://github.com/koajs/router)
-- `bodyParser` - [Koa body parser](https://github.com/koajs/bodyparser)
-- `cors` - [Koa CORS](https://github.com/koajs/cors)
+- **`App`** - [Koa application](https://github.com/koajs/koa)
+- **`Router`** - [Koa router](https://github.com/koajs/router) for routing
+- **`bodyParser`** - [Koa body parser](https://github.com/koajs/bodyparser) for JSON/form parsing
+- **`cors`** - [Koa CORS](https://github.com/koajs/cors) for cross-origin requests
+- **`multer`** - [Koa multer](https://github.com/koajs/multer) for file uploads
+- **`addHealthCheck({ app, path? })`** - Adds a health endpoint (defaults to `/health`) returning `{ status: 'ok' }`
+- **`MulterFile`** (type) - File type for uploaded files

package/dist/esm/index.js

@@ -1,9 +1,30 @@
 /** Powered by @ttoss/config. https://ttoss.dev/docs/modules/packages/config/ */
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", {
+  value,
+  configurable: true
+});
 
 // src/index.ts
 import { bodyParser } from "@koa/bodyparser";
-import App from "koa";
-import Router from "@koa/router";
 import cors from "@koa/cors";
 import multer from "@koa/multer";
-export { App, Router, bodyParser, cors, multer };
+import Router2 from "@koa/router";
+import App from "koa";
+
+// src/addHealthCheck.ts
+import Router from "@koa/router";
+var addHealthCheck = /* @__PURE__ */__name(({
+  app,
+  path = "/health"
+}) => {
+  const router = new Router();
+  router.get(path, ctx => {
+    ctx.body = {
+      status: "ok"
+    };
+  });
+  app.use(router.routes());
+  app.use(router.allowedMethods());
+}, "addHealthCheck");
+export { App, Router2 as Router, addHealthCheck, bodyParser, cors, multer };

package/dist/index.d.ts

@@ -1,5 +1,41 @@
 export { bodyParser } from '@koa/bodyparser';
-export { default as App } from 'koa';
-export { default as Router } from '@koa/router';
 export { default as cors } from '@koa/cors';
-export { default as multer } from '@koa/multer';
+export { File as MulterFile, default as multer } from '@koa/multer';
+export { default as Router } from '@koa/router';
+import App from 'koa';
+export { default as App } from 'koa';
+
+interface AddHealthCheckOptions {
+    /**
+     * The Koa application instance to attach the health check to.
+     */
+    app: App;
+    /**
+     * The path for the health endpoint.
+     * @default '/health'
+     */
+    path?: string;
+}
+/**
+ * Adds a health check endpoint to the Koa application.
+ *
+ * @example
+ * ```typescript
+ * import { App, addHealthCheck } from '@ttoss/http-server';
+ *
+ * const app = new App();
+ * addHealthCheck({ app });
+ *
+ * app.listen(3000);
+ * // GET /health returns { status: 'ok' }
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Custom path
+ * addHealthCheck({ app, path: '/health' });
+ * ```
+ */
+declare const addHealthCheck: ({ app, path, }: AddHealthCheckOptions) => void;
+
+export { type AddHealthCheckOptions, addHealthCheck };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ttoss/http-server",
-  "version": "0.1.16",
+  "version": "0.3.0",
   "description": "HTTP Server for ttoss environment",
   "license": "MIT",
   "author": "ttoss",
@@ -24,20 +24,20 @@
   ],
   "sideEffects": false,
   "dependencies": {
-    "@koa/bodyparser": "^5.1.1",
+    "@koa/bodyparser": "^6.0.0",
     "@koa/cors": "^5.0.0",
-    "@koa/multer": "^3.0.2",
-    "@koa/router": "^13.1.0",
-    "koa": "^2.15.3",
-    "multer": "1.4.5-lts.1"
+    "@koa/multer": "^4.0.0",
+    "@koa/router": "^15.1.1",
+    "koa": "^3.1.1",
+    "multer": "2.0.2"
   },
   "devDependencies": {
-    "@types/koa": "^2.15.0",
-    "@types/koa__cors": "^5.0.0",
-    "@types/koa__multer": "^2.0.7",
-    "@types/koa__router": "^12.0.4",
+    "@types/koa": "^3.0.1",
+    "@types/koa__cors": "^5.0.1",
+    "@types/koa__multer": "^2.0.8",
+    "@types/koa__router": "^12.0.5",
     "jest": "^30.2.0",
-    "supertest": "^7.0.0",
+    "supertest": "^7.1.4",
     "tsup": "^8.5.1",
     "@ttoss/config": "^1.35.12"
   },