@moostjs/event-http 0.2.33 → 0.2.34

package/README.md

@@ -1,7 +1,5 @@
 # @moostjs/event-http
 
-**!!! This is work-in-progress library, breaking changes are expected !!!**
-
 <p align="center">
 <img src="../../moost-logo.png" width="450px"><br>
 <a  href="https://github.com/moostjs/moostjs/blob/main/LICENSE">
@@ -9,31 +7,51 @@
 </a>
 </p>
 
-`event-http` is a moostjs wrapper of [@wooksjs/event-http](https://github.com/wooksjs/wooksjs/tree/main/packages/event-http) with corresponding decorators for composable functions.
-
-## Quick Start
-
-```ts
-import { MoostHttp, Get } from '@moostjs/event-http'
-import { Moost, Param } from 'moost'
-
-class MyServer extends Moost {
-    @Get('test/:name')
-    test(@Param('name') name: string) {
-        return { message: `Hello ${name}!` }
-    }
-}
-
-const app = new MyServer()
-const http = new MoostHttp()
-app.adapter(http).listen(3000, () => {
-    app.getLogger('MyApp').log('Up on port 3000')
-})
-app.init()
-// curl http://localhost:3000/test/World
-// {"message":"Hello World!"}
+Welcome to `@moostjs/event-http`, a Moostjs library that serves as a wrapper for [@wooksjs/event-http](https://github.com/wooksjs/wooksjs/tree/main/packages/event-http). This package provides decorators for composing functions, thereby enhancing the simplicity and efficiency of your Moost application.
+
+**Note:** As `@moostjs/event-http` is under active development, breaking changes can be expected.
+
+## Overview
+
+The `@moostjs/event-http` module plays a crucial role in making Moost apps receptive to HTTP events. By employing it in your project, you can create handlers for HTTP events in a declarative, structured manner.
+
+## Getting Started
+
+Starting a new Moost HTTP project is quite simple. All you need to do is run the following command:
+
+```bash
+npm create moost -- --http
 ```
 
-## Install
+You can also provide a name for your project:
+
+```bash
+npm create moost my-web-app -- --http
+```
+
+This command will initiate a setup tool that will guide you through the project initialization process. It will prompt you to make certain choices such as:
+
+- Whether you want to integrate eslint and prettier.
+- Which bundler you prefer to use: esbuild or rollup.
+
+## [Official Documentation](https://moost.org/webapp/)
+
+## Contributing
+
+We are excited to welcome contributors who are passionate about improving Moostjs. No matter your level of experience, your unique perspective and skills can make valuable contributions to our growing community.
+
+Here are some basic steps to get you started:
+
+1. **Fork the Repo:** Navigate to [moostjs](https://github.com/moostjs/moostjs) and fork the repository to your own GitHub account.
+
+2. **Clone the Repo:** Clone the forked repository to your local machine.
+
+3. **Create a Branch:** Make a new branch for your feature or bug fix.
+
+4. **Make your Changes:** Implement your feature or fix the bug and commit the changes to your branch.
+
+5. **Make a Pull Request:** Navigate back to your forked repo and press the "New pull request" button.
+
+Don't hesitate to ask for help if you need it. We believe in fostering a friendly and respectful environment for all contributors.
 
-`npm install moost @moostjs/event-http`
+Thank you for your interest in Moostjs. We look forward to building something amazing together!

package/dist/index.cjs

@@ -125,7 +125,7 @@ class MoostHttp {
                 : typeof opts.method === 'string'
                     ? opts.method
                     : '';
-            const targetPath = `${opts.prefix || ''}/${path}`.replace(/\/\/+/g, '/');
+            const targetPath = `${opts.prefix || ''}/${path}`.replace(/\/\/+/g, '/') + `${path.endsWith('//') ? '/' : ''}`; // explicit double slash "//" -> force url to end with slash
             if (!fn) {
                 fn = moost.defineMoostEventHandler({
                     contextType: CONTEXT_TYPE,
@@ -143,7 +143,8 @@ class MoostHttp {
                     },
                 });
             }
-            const { getPath: pathBuilder } = this.httpApp.on(handler.method, targetPath, fn);
+            const routerBinding = this.httpApp.on(handler.method, targetPath, fn);
+            const { getPath: pathBuilder } = routerBinding;
             const methodMeta = moost.getMoostMate().read(opts.fakeInstance, opts.method) ||
                 {};
             const id = (methodMeta.id || opts.method);
@@ -162,6 +163,10 @@ class MoostHttp {
                 }
             }
             opts.logHandler(`${''}(${handler.method})${''}${targetPath}`);
+            const args = routerBinding.getArgs();
+            const params = {};
+            args.forEach(a => params[a] = `{${a}}`);
+            opts.register(handler, routerBinding.getPath(params), args);
         }
     }
 }
@@ -491,16 +496,18 @@ function Cookie(name) {
  * @paramType string | object
  */
 function Query(name) {
-    return moost.Resolve(() => {
+    const isItem = !!name;
+    const _name = isItem ? name : 'Query';
+    return moost.getMoostMate().apply(moost.getMoostMate().decorate('paramSource', isItem ? 'QUERY_ITEM' : 'QUERY'), moost.getMoostMate().decorate('paramName', _name), moost.Resolve(() => {
         const { jsonSearchParams, urlSearchParams } = eventHttp.useSearchParams();
-        if (name) {
+        if (isItem) {
             const p = urlSearchParams();
             const value = p.get(name);
-            return (value === '' && p.has(name)) || value;
+            return value === null ? undefined : value;
         }
         const json = jsonSearchParams();
-        return Object.keys(json).length ? json : null;
-    }, name || 'Query');
+        return Object.keys(json).length ? json : undefined;
+    }, _name));
 }
 /**
  * Get Requested URL
@@ -565,7 +572,7 @@ function IpList() {
  * @paramType object | string | unknown
  */
 function Body() {
-    return moost.Resolve(() => useBody().parseBody(), 'body');
+    return moost.getMoostMate().apply(moost.getMoostMate().decorate('paramSource', 'BODY'), moost.Resolve(() => useBody().parseBody(), 'body'));
 }
 /**
  * Get Raw Request Body Buffer
@@ -699,17 +706,6 @@ function SetStatus(...args) {
     return moost.Intercept(setStatusInterceptor(...args));
 }
 
-function httpValidatePipe(opts) {
-    return moost.validatePipe(Object.assign({ errorCb: (message, details) => {
-            throw new eventHttp.HttpError(400, {
-                statusCode: 400,
-                message,
-                error: 'Validation Error',
-                details,
-            });
-        } }, opts[0]));
-}
-
 Object.defineProperty(exports, 'HttpError', {
     enumerable: true,
     get: function () { return eventHttp.HttpError; }
@@ -746,4 +742,3 @@ exports.SetHeader = SetHeader;
 exports.SetStatus = SetStatus;
 exports.StatusHook = StatusHook;
 exports.Url = Url;
-exports.httpValidatePipe = httpValidatePipe;

package/dist/index.d.ts

@@ -11,13 +11,11 @@ import { THook } from '@wooksjs/event-core';
 import { TInterceptorFn } from 'moost';
 import { TMoostAdapter } from 'moost';
 import { TMoostAdapterOptions } from 'moost';
-import { TPipeFn } from 'moost';
 import { TProstoRouterPathBuilder } from '@prostojs/router';
 import { TProvideRegistry } from '@prostojs/infact';
 import { TWooksHttpOptions } from '@wooksjs/event-http';
 import { useHttpContext } from '@wooksjs/event-http';
 import { useSetCookies } from '@wooksjs/event-http';
-import { validatePipe } from 'moost';
 import { WooksHttp } from '@wooksjs/event-http';
 
 export declare const All: (path?: string) => MethodDecorator;
@@ -35,7 +33,7 @@ export declare function Authorization(name: 'username' | 'password' | 'bearer' |
  * @decorator
  * @paramType object | string | unknown
  */
-declare function Body_2(): ParameterDecorator & PropertyDecorator;
+declare function Body_2(): MethodDecorator & ClassDecorator & ParameterDecorator & PropertyDecorator;
 export { Body_2 as Body }
 
 /**
@@ -86,8 +84,6 @@ export { HttpError }
 
 export declare function HttpMethod(method: '*' | 'GET' | 'PUT' | 'POST' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS', path?: string): MethodDecorator;
 
-export declare function httpValidatePipe(opts: Parameters<typeof validatePipe>): TPipeFn<TEmpty>;
-
 /**
  * Get Request IP Address
  * @decorator
@@ -156,7 +152,7 @@ export declare class MoostHttp implements TMoostAdapter<THttpHandlerMeta> {
     onInit(moost: Moost): void;
     getProvideRegistry(): TProvideRegistry;
     getLogger(): TConsoleBase;
-    bindHandler<T extends object = object>(opts: TMoostAdapterOptions<THttpHandlerMeta, T>): void | Promise<void>;
+    bindHandler<T extends object = object>(opts: TMoostAdapterOptions<THttpHandlerMeta, T>): void;
 }
 
 export declare const Patch: (path?: string) => MethodDecorator;
@@ -311,9 +307,6 @@ export { TCookieAttributesInput }
 
 export declare type TCookieHook = THook & Partial<THook<TCookieAttributes, 'attrs'>>;
 
-declare interface TEmpty {
-}
-
 export declare type THeaderHook = THook;
 
 export declare interface THttpHandlerMeta {

package/dist/index.mjs

@@ -1,6 +1,6 @@
 import { WooksHttp, createHttpApp, useRequest, HttpError, useHttpContext, useHeaders, EHttpStatusCode, WooksURLSearchParams, useStatus, useSetHeader, useSetCookie, useAuthorization, useCookies, useSearchParams, useResponse, useSetCookies } from '@wooksjs/event-http';
 export { HttpError, useHttpContext } from '@wooksjs/event-http';
-import { defineMoostEventHandler, getMoostMate, Resolve, Intercept, TInterceptorPriority, defineInterceptorFn, validatePipe } from 'moost';
+import { defineMoostEventHandler, getMoostMate, Resolve, Intercept, TInterceptorPriority, defineInterceptorFn } from 'moost';
 import { createProvideRegistry } from '@prostojs/infact';
 import { Server } from 'http';
 import { Server as Server$1 } from 'https';
@@ -124,7 +124,7 @@ class MoostHttp {
                 : typeof opts.method === 'string'
                     ? opts.method
                     : '';
-            const targetPath = `${opts.prefix || ''}/${path}`.replace(/\/\/+/g, '/');
+            const targetPath = `${opts.prefix || ''}/${path}`.replace(/\/\/+/g, '/') + `${path.endsWith('//') ? '/' : ''}`; // explicit double slash "//" -> force url to end with slash
             if (!fn) {
                 fn = defineMoostEventHandler({
                     contextType: CONTEXT_TYPE,
@@ -142,7 +142,8 @@ class MoostHttp {
                     },
                 });
             }
-            const { getPath: pathBuilder } = this.httpApp.on(handler.method, targetPath, fn);
+            const routerBinding = this.httpApp.on(handler.method, targetPath, fn);
+            const { getPath: pathBuilder } = routerBinding;
             const methodMeta = getMoostMate().read(opts.fakeInstance, opts.method) ||
                 {};
             const id = (methodMeta.id || opts.method);
@@ -161,6 +162,10 @@ class MoostHttp {
                 }
             }
             opts.logHandler(`${''}(${handler.method})${''}${targetPath}`);
+            const args = routerBinding.getArgs();
+            const params = {};
+            args.forEach(a => params[a] = `{${a}}`);
+            opts.register(handler, routerBinding.getPath(params), args);
         }
     }
 }
@@ -490,16 +495,18 @@ function Cookie(name) {
  * @paramType string | object
  */
 function Query(name) {
-    return Resolve(() => {
+    const isItem = !!name;
+    const _name = isItem ? name : 'Query';
+    return getMoostMate().apply(getMoostMate().decorate('paramSource', isItem ? 'QUERY_ITEM' : 'QUERY'), getMoostMate().decorate('paramName', _name), Resolve(() => {
         const { jsonSearchParams, urlSearchParams } = useSearchParams();
-        if (name) {
+        if (isItem) {
             const p = urlSearchParams();
             const value = p.get(name);
-            return (value === '' && p.has(name)) || value;
+            return value === null ? undefined : value;
         }
         const json = jsonSearchParams();
-        return Object.keys(json).length ? json : null;
-    }, name || 'Query');
+        return Object.keys(json).length ? json : undefined;
+    }, _name));
 }
 /**
  * Get Requested URL
@@ -564,7 +571,7 @@ function IpList() {
  * @paramType object | string | unknown
  */
 function Body() {
-    return Resolve(() => useBody().parseBody(), 'body');
+    return getMoostMate().apply(getMoostMate().decorate('paramSource', 'BODY'), Resolve(() => useBody().parseBody(), 'body'));
 }
 /**
  * Get Raw Request Body Buffer
@@ -698,15 +705,4 @@ function SetStatus(...args) {
     return Intercept(setStatusInterceptor(...args));
 }
 
-function httpValidatePipe(opts) {
-    return validatePipe(Object.assign({ errorCb: (message, details) => {
-            throw new HttpError(400, {
-                statusCode: 400,
-                message,
-                error: 'Validation Error',
-                details,
-            });
-        } }, opts[0]));
-}
-
-export { All, Authorization, Body, Cookie, CookieAttrsHook, CookieHook, Delete, Get, Header, HeaderHook, HttpMethod, Ip, IpList, Method, MoostHttp, Patch, Post, Put, Query, RawBody, Req, ReqId, Res, SetCookie, SetHeader, SetStatus, StatusHook, Url, httpValidatePipe };
+export { All, Authorization, Body, Cookie, CookieAttrsHook, CookieHook, Delete, Get, Header, HeaderHook, HttpMethod, Ip, IpList, Method, MoostHttp, Patch, Post, Put, Query, RawBody, Req, ReqId, Res, SetCookie, SetHeader, SetStatus, StatusHook, Url };

package/package.json

@@ -1,10 +1,18 @@
 {
   "name": "@moostjs/event-http",
-  "version": "0.2.33",
+  "version": "0.2.34",
   "description": "@moostjs/event-http",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs",
+      "types": "./dist/index.d.ts"
+    }
+  },
   "files": [
     "dist"
   ],
@@ -29,10 +37,10 @@
   "homepage": "https://github.com/moostjs/moostjs/tree/main/packages/event-http#readme",
   "peerDependencies": {},
   "dependencies": {
-    "moost": "0.2.33",
-    "@wooksjs/event-core": "^0.3.3",
-    "@wooksjs/event-http": "^0.3.3",
-    "@prostojs/infact": "^0.1.11",
+    "moost": "0.2.34",
+    "@wooksjs/event-core": "^0.3.11",
+    "@wooksjs/event-http": "^0.3.11",
+    "@prostojs/infact": "^0.1.13",
     "@prostojs/router": "^0.1.0"
   }
 }