@ttoss/http-server 0.3.2 → 0.4.0

package/README.md

@@ -11,7 +11,7 @@ pnpm add @ttoss/http-server
 ## Quick Start
 
 ```typescript
-import { App, Router, bodyParser, cors } from '@ttoss/http-server';
+import { App, Router, bodyParser, cors, serve } from '@ttoss/http-server';
 
 const app = new App();
 
@@ -50,6 +50,57 @@ app.listen(3000);
 
 ## Core Features
 
+### Static File Serving
+
+Serve static files from a directory using the `serve` middleware:
+
+```typescript
+import { App, serve } from '@ttoss/http-server';
+
+const app = new App();
+
+// Serve files from the 'public' directory
+app.use(serve('./public'));
+
+app.listen(3000);
+// Files in ./public are now accessible at http://localhost:3000
+```
+
+**Advanced Options:**
+
+```typescript
+// With custom options
+app.use(
+  serve('./public', {
+    maxage: 3600000, // Cache files for 1 hour (in milliseconds)
+    index: 'index.html', // Default file to serve for directories
+    hidden: false, // Don't serve hidden files
+    gzip: true, // Enable gzip compression
+  })
+);
+```
+
+**Combining with Routes:**
+
+```typescript
+import { App, Router, serve } from '@ttoss/http-server';
+
+const app = new App();
+const router = new Router();
+
+// Define API routes first
+router.get('/api/users', (ctx) => {
+  ctx.body = [{ id: 1, name: 'John' }];
+});
+
+app.use(router.routes());
+
+// Static files are served after API routes
+app.use(serve('./public'));
+
+app.listen(3000);
+```
+
 ### Route Parameters
 
 ```typescript
@@ -109,5 +160,6 @@ All exports are re-exported from established Koa ecosystem packages:
 - **`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
+- **`serve`** - [Koa static](https://github.com/koajs/static) for serving static files
 - **`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

@@ -11,6 +11,7 @@ import cors from "@koa/cors";
 import multer from "@koa/multer";
 import Router2 from "@koa/router";
 import App from "koa";
+import serve from "koa-static";
 
 // src/addHealthCheck.ts
 import Router from "@koa/router";
@@ -30,4 +31,4 @@ var addHealthCheck = /* @__PURE__ */__name(({
 
 // src/index.ts
 export * from "@koa/router";
-export { App, Router2 as Router, addHealthCheck, bodyParser, cors, multer };
+export { App, Router2 as Router, addHealthCheck, bodyParser, cors, multer, serve };

package/dist/index.d.cts

@@ -5,6 +5,7 @@ export * from '@koa/router';
 export { default as Router } from '@koa/router';
 import App from 'koa';
 export { default as App } from 'koa';
+export { default as serve } from 'koa-static';
 
 interface AddHealthCheckOptions {
     /**

package/dist/index.d.ts

@@ -5,6 +5,7 @@ export * from '@koa/router';
 export { default as Router } from '@koa/router';
 import App from 'koa';
 export { default as App } from 'koa';
+export { default as serve } from 'koa-static';
 
 interface AddHealthCheckOptions {
     /**

package/dist/index.js

@@ -48,7 +48,8 @@ __export(index_exports, {
   addHealthCheck: () => addHealthCheck,
   bodyParser: () => import_bodyparser.bodyParser,
   cors: () => import_cors.default,
-  multer: () => import_multer.default
+  multer: () => import_multer.default,
+  serve: () => import_koa_static.default
 });
 module.exports = __toCommonJS(index_exports);
 var import_bodyparser = require("@koa/bodyparser");
@@ -56,6 +57,7 @@ var import_cors = __toESM(require("@koa/cors"), 1);
 var import_multer = __toESM(require("@koa/multer"), 1);
 var import_router2 = __toESM(require("@koa/router"), 1);
 var import_koa = __toESM(require("koa"), 1);
+var import_koa_static = __toESM(require("koa-static"), 1);
 
 // src/addHealthCheck.ts
 var import_router = __toESM(require("@koa/router"), 1);
@@ -83,5 +85,6 @@ __reExport(index_exports, require("@koa/router"), module.exports);
   bodyParser,
   cors,
   multer,
+  serve,
   ...require("@koa/router")
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ttoss/http-server",
-  "version": "0.3.2",
+  "version": "0.4.0",
   "description": "HTTP Server for ttoss environment",
   "license": "MIT",
   "author": "ttoss",
@@ -30,6 +30,7 @@
     "@koa/multer": "^4.0.0",
     "@koa/router": "^15.1.1",
     "koa": "^3.1.1",
+    "koa-static": "^5.0.0",
     "multer": "2.0.2"
   },
   "devDependencies": {
@@ -37,6 +38,7 @@
     "@types/koa__cors": "^5.0.1",
     "@types/koa__multer": "^2.0.8",
     "@types/koa__router": "^12.0.5",
+    "@types/koa-static": "^4.0.4",
     "jest": "^30.2.0",
     "supertest": "^7.1.4",
     "tsup": "^8.5.1",