@wooksjs/express-adapter 0.2.0 → 0.2.1

package/README.md

@@ -3,7 +3,7 @@
 **!!! This is work-in-progress library, breaking changes are expected !!!**
 
 <p align="center">
-<img src="./docs/icon.png" height="156px"><br>
+<img src="./docs/wooks-logo.png" height="156px"><br>
 <a  href="https://github.com/wooksjs/express-adapter/blob/main/LICENSE">
     <img src="https://img.shields.io/badge/License-MIT-green?style=for-the-badge" />
 </a>
@@ -17,6 +17,10 @@ Want to use [@wooksjs/event-http](https://www.npmjs.com/package/@wooksjs/event-h
 
 ## Usage
 
+There are two options to use express with wooks
+
+### 1. Adapter for express API:
+This one will modify express `get`, `post`, ..., methods. Take this one if you want to keep using express app API.
 ```ts
 import express from 'express'
 import { applyExpressAdapter } from '@wooksjs/express-adapter'
@@ -44,3 +48,34 @@ app.get('/error', () => {
 
 app.listen(3000, () => console.log('listening 3000'))
 ```
+
+### 2. Adapter for WooksHttp API:
+This one does not modify anything. It just applies express middleware and reroutes requests through wooks. Use this one if you want to use wooks app API (compatible with [@moostjs/event-http](https://www.npmjs.com/package/@moostjs/event-http))
+
+```ts
+import express from 'express'
+import { WooksExpress } from '@wooksjs/express-adapter'
+import { useBody } from '@wooksjs/http-body'
+import { HttpError } from '@wooksjs/event-http'
+import { useRouteParams } from '@wooksjs/event-core'
+
+const expressApp = Express()
+
+const wooksApp = new WooksExpress(expressApp, { raise404: true })
+
+wooksApp.get('/test/:param', () => {
+    const { get } = useRouteParams()
+    return { message: 'it works', param: get('param') }
+})
+
+wooksApp.post('/post', () => {
+    const { parseBody } = useBody()
+    return parseBody()
+})
+
+wooksApp.get('/error', () => {
+    throw new HttpError(400, 'test error')
+})
+
+wooksApp.listen(3000, () => console.log('listening 3000'))
+```

package/dist/index.cjs

@@ -47,4 +47,47 @@ function wooksContext(req, res, next) {
   next();
 }
 
+class WooksExpress extends eventHttp.WooksHttp {
+  constructor(expressApp, opts) {
+    super();
+    this.expressApp = expressApp;
+    this.opts = opts;
+    expressApp.use(this.getServerCb());
+  }
+  async listen(...args) {
+    const server = this.server = this.expressApp.listen(...args);
+    return new Promise((resolve, reject) => {
+      server.once("listening", resolve);
+      server.once("error", reject);
+    });
+  }
+  getServerCb() {
+    return async (req, res, next) => {
+      const { restoreCtx, clearCtx } = eventHttp.createHttpContext({ req, res });
+      const handlers = this.wooks.lookup(req.method, req.url);
+      if (handlers) {
+        try {
+          await this.processHandlers(handlers);
+        } catch (e) {
+          console.error("Internal error, please report: ", e);
+          if (e.stack) {
+            console.warn(e.stack);
+          }
+          restoreCtx();
+          this.respond(e);
+          clearCtx();
+        }
+      } else {
+        if (this.opts?.raise404) {
+          this.respond(new eventHttp.HttpError(404));
+          clearCtx();
+        } else if (next) {
+          next();
+        }
+      }
+    };
+  }
+}
+
+exports.WooksExpress = WooksExpress;
 exports.applyExpressAdapter = applyExpressAdapter;

package/dist/index.d.ts

@@ -1,5 +1,19 @@
-import { Express } from 'express';
+import Express$1, { Express } from 'express';
+import { WooksHttp } from '@wooksjs/event-http';
+import { Server, IncomingMessage, ServerResponse } from 'http';
 
 declare function applyExpressAdapter(app: Express): void;
 
-export { applyExpressAdapter };
+declare class WooksExpress extends WooksHttp {
+    protected expressApp: Express$1.Application;
+    protected opts?: {
+        raise404?: boolean | undefined;
+    } | undefined;
+    constructor(expressApp: Express$1.Application, opts?: {
+        raise404?: boolean | undefined;
+    } | undefined);
+    listen(...args: Parameters<Server['listen']>): Promise<unknown>;
+    getServerCb(): (req: IncomingMessage, res: ServerResponse, next?: Express$1.NextFunction) => Promise<void>;
+}
+
+export { WooksExpress, applyExpressAdapter };

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { createWooksResponder, createHttpContext, useHttpContext } from '@wooksjs/event-http';
+import { createWooksResponder, createHttpContext, useHttpContext, WooksHttp, HttpError } from '@wooksjs/event-http';
 
 const methods = [
   "get",
@@ -45,4 +45,46 @@ function wooksContext(req, res, next) {
   next();
 }
 
-export { applyExpressAdapter };
+class WooksExpress extends WooksHttp {
+  constructor(expressApp, opts) {
+    super();
+    this.expressApp = expressApp;
+    this.opts = opts;
+    expressApp.use(this.getServerCb());
+  }
+  async listen(...args) {
+    const server = this.server = this.expressApp.listen(...args);
+    return new Promise((resolve, reject) => {
+      server.once("listening", resolve);
+      server.once("error", reject);
+    });
+  }
+  getServerCb() {
+    return async (req, res, next) => {
+      const { restoreCtx, clearCtx } = createHttpContext({ req, res });
+      const handlers = this.wooks.lookup(req.method, req.url);
+      if (handlers) {
+        try {
+          await this.processHandlers(handlers);
+        } catch (e) {
+          console.error("Internal error, please report: ", e);
+          if (e.stack) {
+            console.warn(e.stack);
+          }
+          restoreCtx();
+          this.respond(e);
+          clearCtx();
+        }
+      } else {
+        if (this.opts?.raise404) {
+          this.respond(new HttpError(404));
+          clearCtx();
+        } else if (next) {
+          next();
+        }
+      }
+    };
+  }
+}
+
+export { WooksExpress, applyExpressAdapter };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wooksjs/express-adapter",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Express Adapter for Wooks Composables",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",