galbe 0.7.0 → 0.8.0

package/docs/context.md

@@ -11,7 +11,7 @@ A context has the following properties:
 
 **request**
 
-An instance of the [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object created by th server.
+An instance of the [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object created by the server.
 
 **headers**
 
@@ -112,3 +112,7 @@ galbe.get(
 $ curl http://localhost:3000/example
 bar
 ```
+
+**remoteAddress**
+
+An instance of the [SocketAdress](https://github.com/oven-sh/bun/blob/fe62a614046948ebba260bed87db96287e67921f/packages/bun-types/bun.d.ts#L2600-L2613) representing the remote address of the client.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "galbe",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "Fast, lightweight and highly customizable JavaScript web framework based on Bun",
   "author": "Pierre Caillaud M (https://github.com/pierre-cm)",
   "type": "module",

package/src/routes.ts

@@ -35,6 +35,9 @@ class GalbeProxy {
     this.#g = g
     this.#cb = cb
   }
+  get server() {
+    return this.#g.server
+  }
   async get(...args: any[]) {
     //@ts-ignore
     const route = this.#g.get(...args) as Route

package/src/server.ts

@@ -28,7 +28,7 @@ export default async (galbe: Galbe, port?: number, hostname?: string) => {
     galbe.config.basePath = `/${galbe?.config?.basePath}`
   let pluginsCb = setupPluginCallbacks(galbe)
 
-  return Bun.serve({
+  const server = Bun.serve({
     port: port || galbe.config?.port || 3000,
     hostname: hostname || galbe.config?.hostname || 'localhost',
     tls: galbe.config?.tls,
@@ -37,6 +37,7 @@ export default async (galbe: Galbe, port?: number, hostname?: string) => {
       if (!METHODS.includes(req.method)) return new Response('', { status: 501 })
       const context = {
         request: req,
+        remoteAddress: server.requestIP(req),
         set: { headers: {} },
         state: {}
       } as MakeOptional<Context, 'headers' | 'params' | 'query' | 'body'>
@@ -128,12 +129,12 @@ export default async (galbe: Galbe, port?: number, hostname?: string) => {
               if (nextCalled) console.error('Hook already called - ignored')
               else {
                 nextCalled = true
-                await callChain[idx + 1].call()
+                return await callChain[idx + 1].call()
               }
             }
             let r = await hook(context as Context, next)
             if (r) return r
-            if (!nextCalled && !handlerCalled) await next()
+            if (!nextCalled && !handlerCalled) return await next()
           }
         }))
         callChain.push({
@@ -199,4 +200,5 @@ export default async (galbe: Galbe, port?: number, hostname?: string) => {
       })
     }
   })
+  return server
 }

package/src/types.ts

@@ -1,4 +1,4 @@
-import type { ServeOptions, TLSOptions, TLSServeOptions } from 'bun'
+import type { ServeOptions, SocketAddress, TLSOptions, TLSServeOptions } from 'bun'
 import type {
   STAny,
   STArray,
@@ -8,6 +8,7 @@ import type {
   STJson,
   STLiteral,
   STMultipartForm,
+  STNull,
   STNumber,
   STObject,
   STOptional,
@@ -48,6 +49,7 @@ export type STResponseValue =
   | STUnion
   | STStream
   | STAny
+  | STNull
 export type STResponse = Record<number, STResponseValue>
 
 export type MaybeArray<T> = T | T[]
@@ -162,6 +164,7 @@ export type Context<
   query: Static<STObject<Exclude<S['query'], undefined>>>
   body: M extends 'get' | 'options' | 'head' ? null : StaticBody<Exclude<S['body'], undefined>>
   request: Request
+  remoteAddress: SocketAddress | null
   route?: Route
   state: Record<string, any>
   set: {
@@ -171,7 +174,7 @@ export type Context<
     status?: number
   }
 }
-export type Next = () => void | Promise<void>
+export type Next = () => void | Promise<any>
 export type Hook<M extends Method = Method, Path extends string = string, S extends RequestSchema = RequestSchema> = (
   ctx: Context<M, Path, S>,
   next: Next