@moostjs/event-http 0.2.31 → 0.2.33

package/dist/index.cjs

@@ -416,7 +416,7 @@ const CookieHook = (name) => moost.Resolve((metas, level) => {
  * Hook to the Response Cookie Attributes
  * @decorator
  * @param name - cookie name
- * @paramType TCookieHook
+ * @paramType TCookieAttributes
  */
 const CookieAttrsHook = (name) => moost.Resolve((metas, level) => {
     const hook = eventHttp.useSetCookie(name);
@@ -526,6 +526,15 @@ function Method() {
 function Req() {
     return moost.Resolve(() => eventHttp.useRequest().rawRequest, 'request');
 }
+/**
+ * Get Raw Response Instance
+ * @decorator
+ * @param opts (optional) { passthrough: boolean }
+ * @paramType ServerResponse
+ */
+function Res(opts) {
+    return moost.Resolve(() => eventHttp.useResponse().rawResponse(opts), 'response');
+}
 /**
  * Get Request Unique Identificator (UUID)
  * @decorator
@@ -550,15 +559,6 @@ function Ip(opts) {
 function IpList() {
     return moost.Resolve(() => eventHttp.useRequest().getIpList(), 'ipList');
 }
-/**
- * Get Raw Response Object
- * @decorator
- * @param options - passthrough options
- * @paramType string
- */
-function Res(options) {
-    return moost.Resolve(() => eventHttp.useResponse().rawResponse(options), 'response');
-}
 /**
  * Get Parsed Request Body
  * @decorator
@@ -590,6 +590,43 @@ const setHeaderInterceptor = (name, value, opts) => {
     fn.priority = moost.TInterceptorPriority.AFTER_ALL;
     return fn;
 };
+/**
+ * Set Header for Request Handler
+ *
+ * ```ts
+ * import { Get, SetHeader } from '@moostjs/event-http';
+ * import { Controller } from 'moost';
+ *
+ * @Controller()
+ * export class ExampleController {
+ *   @Get('test')
+ *   // setting header for request handler
+ *   @SetHeader('x-server', 'my-server')
+ *   testHandler() {
+ *     return '...'
+ *   }
+ * }
+ * ```
+ *
+ * ```ts
+ * import { Get, SetHeader } from '@moostjs/event-http';
+ * import { Controller } from 'moost';
+ *
+ * @Controller()
+ * export class ExampleController {
+ *   @Get('test')
+ *   // setting header only if status = 400
+ *   @SetHeader('content-type', 'text/plain', { status: 400 })
+ *   testHandler() {
+ *     return '...'
+ *   }
+ * }
+ * ```
+ *
+ * @param name  name of header
+ * @param value value for header
+ * @param options options { status?: number, force?: boolean }
+ */
 function SetHeader(...args) {
     return moost.Intercept(setHeaderInterceptor(...args));
 }
@@ -605,8 +642,61 @@ const setCookieInterceptor = (name, value, attrs) => {
     fn.priority = moost.TInterceptorPriority.AFTER_ALL;
     return fn;
 };
+/**
+ * Set Cookie for Request Handler
+ * ```ts
+ * import { Get, SetCookie } from '@moostjs/event-http';
+ * import { Controller } from 'moost';
+ *
+ * @Controller()
+ * export class ExampleController {
+ *   @Get('test')
+ *   // setting 'my-cookie' = 'value' with maxAge of 10 minutes
+ *   @SetCookie('my-cookie', 'value', { maxAge: '10m' })
+ *   testHandler() {
+ *     return '...'
+ *   }
+ * }
+ * ```
+ *
+ * @param name  name of cookie
+ * @param value value for cookie
+ * @param attrs cookie attributes
+ */
 function SetCookie(...args) {
     return moost.Intercept(setCookieInterceptor(...args));
+}
+const setStatusInterceptor = (code, opts) => {
+    return moost.defineInterceptorFn((before, after) => {
+        const status = eventHttp.useStatus();
+        after(() => {
+            if (!status.isDefined || (opts === null || opts === void 0 ? void 0 : opts.force)) {
+                status.value = code;
+            }
+        });
+    });
+};
+/**
+ * Set Response Status for Request Handler
+ *
+ * ```ts
+ * import { Get, SetStatus } from '@moostjs/event-http';
+ * import { Controller } from 'moost';
+ *
+ * @Controller()
+ * export class ExampleController {
+ *   @Get('test')
+ *   @SetStatus(201)
+ *   testHandler() {
+ *     return '...'
+ *   }
+ * }
+ * ```
+ * @param code number
+ * @param opts optional { force?: boolean }
+ */
+function SetStatus(...args) {
+    return moost.Intercept(setStatusInterceptor(...args));
 }
 
 function httpValidatePipe(opts) {
@@ -620,6 +710,14 @@ function httpValidatePipe(opts) {
         } }, opts[0]));
 }
 
+Object.defineProperty(exports, 'HttpError', {
+    enumerable: true,
+    get: function () { return eventHttp.HttpError; }
+});
+Object.defineProperty(exports, 'useHttpContext', {
+    enumerable: true,
+    get: function () { return eventHttp.useHttpContext; }
+});
 exports.All = All;
 exports.Authorization = Authorization;
 exports.Body = Body;
@@ -645,6 +743,7 @@ exports.ReqId = ReqId;
 exports.Res = Res;
 exports.SetCookie = SetCookie;
 exports.SetHeader = SetHeader;
+exports.SetStatus = SetStatus;
 exports.StatusHook = StatusHook;
 exports.Url = Url;
 exports.httpValidatePipe = httpValidatePipe;

package/dist/index.d.ts

@@ -1,10 +1,13 @@
 /// <reference types="node" />
 
+import { HttpError } from '@wooksjs/event-http';
 import { IncomingMessage } from 'http';
 import { Moost } from 'moost';
 import { ServerResponse } from 'http';
 import { TConsoleBase } from '@prostojs/logger';
+import { TCookieAttributes as TCookieAttributes_2 } from '@wooksjs/event-http';
 import { TCookieAttributesInput } from '@wooksjs/event-http';
+import { THook } from '@wooksjs/event-core';
 import { TInterceptorFn } from 'moost';
 import { TMoostAdapter } from 'moost';
 import { TMoostAdapterOptions } from 'moost';
@@ -12,6 +15,7 @@ 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';
@@ -46,7 +50,7 @@ export declare function Cookie(name: string): ParameterDecorator & PropertyDecor
  * Hook to the Response Cookie Attributes
  * @decorator
  * @param name - cookie name
- * @paramType TCookieHook
+ * @paramType TCookieAttributes
  */
 export declare const CookieAttrsHook: (name: string) => ParameterDecorator & PropertyDecorator;
 
@@ -78,6 +82,8 @@ export declare function Header(name: string): ParameterDecorator & PropertyDecor
  */
 export declare const HeaderHook: (name: string) => ParameterDecorator & PropertyDecorator;
 
+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>;
@@ -189,19 +195,77 @@ export declare function Req(): ParameterDecorator & PropertyDecorator;
 export declare function ReqId(): ParameterDecorator & PropertyDecorator;
 
 /**
- * Get Raw Response Object
+ * Get Raw Response Instance
  * @decorator
- * @param options - passthrough options
- * @paramType string
+ * @param opts (optional) { passthrough: boolean }
+ * @paramType ServerResponse
  */
-export declare function Res(options?: {
+export declare function Res(opts?: {
     passthrough: boolean;
 }): ParameterDecorator & PropertyDecorator;
 
+/**
+ * Set Cookie for Request Handler
+ * ```ts
+ * import { Get, SetCookie } from '@moostjs/event-http';
+ * import { Controller } from 'moost';
+ *
+ * @Controller()
+ * export class ExampleController {
+ *   @Get('test')
+ *   // setting 'my-cookie' = 'value' with maxAge of 10 minutes
+ *   @SetCookie('my-cookie', 'value', { maxAge: '10m' })
+ *   testHandler() {
+ *     return '...'
+ *   }
+ * }
+ * ```
+ *
+ * @param name  name of cookie
+ * @param value value for cookie
+ * @param attrs cookie attributes
+ */
 export declare function SetCookie(...args: Parameters<typeof setCookieInterceptor>): ClassDecorator & MethodDecorator;
 
 declare const setCookieInterceptor: (...args: Parameters<ReturnType<typeof useSetCookies>['setCookie']>) => TInterceptorFn;
 
+/**
+ * Set Header for Request Handler
+ *
+ * ```ts
+ * import { Get, SetHeader } from '@moostjs/event-http';
+ * import { Controller } from 'moost';
+ *
+ * @Controller()
+ * export class ExampleController {
+ *   @Get('test')
+ *   // setting header for request handler
+ *   @SetHeader('x-server', 'my-server')
+ *   testHandler() {
+ *     return '...'
+ *   }
+ * }
+ * ```
+ *
+ * ```ts
+ * import { Get, SetHeader } from '@moostjs/event-http';
+ * import { Controller } from 'moost';
+ *
+ * @Controller()
+ * export class ExampleController {
+ *   @Get('test')
+ *   // setting header only if status = 400
+ *   @SetHeader('content-type', 'text/plain', { status: 400 })
+ *   testHandler() {
+ *     return '...'
+ *   }
+ * }
+ * ```
+ *
+ * @param name  name of header
+ * @param value value for header
+ * @param options options { status?: number, force?: boolean }
+ */
 export declare function SetHeader(...args: Parameters<typeof setHeaderInterceptor>): ClassDecorator & MethodDecorator;
 
 declare const setHeaderInterceptor: (name: string, value: string, opts?: {
@@ -209,6 +273,31 @@ declare const setHeaderInterceptor: (name: string, value: string, opts?: {
     status?: number;
 }) => TInterceptorFn;
 
+/**
+ * Set Response Status for Request Handler
+ *
+ * ```ts
+ * import { Get, SetStatus } from '@moostjs/event-http';
+ * import { Controller } from 'moost';
+ *
+ * @Controller()
+ * export class ExampleController {
+ *   @Get('test')
+ *   @SetStatus(201)
+ *   testHandler() {
+ *     return '...'
+ *   }
+ * }
+ * ```
+ * @param code number
+ * @param opts optional { force?: boolean }
+ */
+export declare function SetStatus(...args: Parameters<typeof setStatusInterceptor>): ClassDecorator & MethodDecorator;
+
+declare const setStatusInterceptor: (code: number, opts?: {
+    force?: boolean;
+}) => TInterceptorFn;
+
 /**
  * Hook to the Response Status
  * @decorator
@@ -216,16 +305,24 @@ declare const setHeaderInterceptor: (name: string, value: string, opts?: {
  */
 export declare const StatusHook: () => ParameterDecorator & PropertyDecorator;
 
+export declare type TCookieAttributes = Partial<TCookieAttributes_2>;
+
 export { TCookieAttributesInput }
 
+export declare type TCookieHook = THook & Partial<THook<TCookieAttributes, 'attrs'>>;
+
 declare interface TEmpty {
 }
 
+export declare type THeaderHook = THook;
+
 export declare interface THttpHandlerMeta {
     method: string;
     path: string;
 }
 
+export declare type TStatusHook = THook<number>;
+
 /**
  * Get Requested URL
  * @decorator
@@ -233,4 +330,6 @@ export declare interface THttpHandlerMeta {
  */
 export declare function Url(): ParameterDecorator & PropertyDecorator;
 
+export { useHttpContext }
+
 export { }

package/dist/index.mjs

@@ -1,5 +1,6 @@
 import { WooksHttp, createHttpApp, useRequest, HttpError, useHttpContext, useHeaders, EHttpStatusCode, WooksURLSearchParams, useStatus, useSetHeader, useSetCookie, useAuthorization, useCookies, useSearchParams, useResponse, useSetCookies } from '@wooksjs/event-http';
-import { defineMoostEventHandler, getMoostMate, Resolve, Intercept, TInterceptorPriority, validatePipe } from 'moost';
+export { HttpError, useHttpContext } from '@wooksjs/event-http';
+import { defineMoostEventHandler, getMoostMate, Resolve, Intercept, TInterceptorPriority, defineInterceptorFn, validatePipe } from 'moost';
 import { createProvideRegistry } from '@prostojs/infact';
 import { Server } from 'http';
 import { Server as Server$1 } from 'https';
@@ -414,7 +415,7 @@ const CookieHook = (name) => Resolve((metas, level) => {
  * Hook to the Response Cookie Attributes
  * @decorator
  * @param name - cookie name
- * @paramType TCookieHook
+ * @paramType TCookieAttributes
  */
 const CookieAttrsHook = (name) => Resolve((metas, level) => {
     const hook = useSetCookie(name);
@@ -524,6 +525,15 @@ function Method() {
 function Req() {
     return Resolve(() => useRequest().rawRequest, 'request');
 }
+/**
+ * Get Raw Response Instance
+ * @decorator
+ * @param opts (optional) { passthrough: boolean }
+ * @paramType ServerResponse
+ */
+function Res(opts) {
+    return Resolve(() => useResponse().rawResponse(opts), 'response');
+}
 /**
  * Get Request Unique Identificator (UUID)
  * @decorator
@@ -548,15 +558,6 @@ function Ip(opts) {
 function IpList() {
     return Resolve(() => useRequest().getIpList(), 'ipList');
 }
-/**
- * Get Raw Response Object
- * @decorator
- * @param options - passthrough options
- * @paramType string
- */
-function Res(options) {
-    return Resolve(() => useResponse().rawResponse(options), 'response');
-}
 /**
  * Get Parsed Request Body
  * @decorator
@@ -588,6 +589,43 @@ const setHeaderInterceptor = (name, value, opts) => {
     fn.priority = TInterceptorPriority.AFTER_ALL;
     return fn;
 };
+/**
+ * Set Header for Request Handler
+ *
+ * ```ts
+ * import { Get, SetHeader } from '@moostjs/event-http';
+ * import { Controller } from 'moost';
+ *
+ * @Controller()
+ * export class ExampleController {
+ *   @Get('test')
+ *   // setting header for request handler
+ *   @SetHeader('x-server', 'my-server')
+ *   testHandler() {
+ *     return '...'
+ *   }
+ * }
+ * ```
+ *
+ * ```ts
+ * import { Get, SetHeader } from '@moostjs/event-http';
+ * import { Controller } from 'moost';
+ *
+ * @Controller()
+ * export class ExampleController {
+ *   @Get('test')
+ *   // setting header only if status = 400
+ *   @SetHeader('content-type', 'text/plain', { status: 400 })
+ *   testHandler() {
+ *     return '...'
+ *   }
+ * }
+ * ```
+ *
+ * @param name  name of header
+ * @param value value for header
+ * @param options options { status?: number, force?: boolean }
+ */
 function SetHeader(...args) {
     return Intercept(setHeaderInterceptor(...args));
 }
@@ -603,8 +641,61 @@ const setCookieInterceptor = (name, value, attrs) => {
     fn.priority = TInterceptorPriority.AFTER_ALL;
     return fn;
 };
+/**
+ * Set Cookie for Request Handler
+ * ```ts
+ * import { Get, SetCookie } from '@moostjs/event-http';
+ * import { Controller } from 'moost';
+ *
+ * @Controller()
+ * export class ExampleController {
+ *   @Get('test')
+ *   // setting 'my-cookie' = 'value' with maxAge of 10 minutes
+ *   @SetCookie('my-cookie', 'value', { maxAge: '10m' })
+ *   testHandler() {
+ *     return '...'
+ *   }
+ * }
+ * ```
+ *
+ * @param name  name of cookie
+ * @param value value for cookie
+ * @param attrs cookie attributes
+ */
 function SetCookie(...args) {
     return Intercept(setCookieInterceptor(...args));
+}
+const setStatusInterceptor = (code, opts) => {
+    return defineInterceptorFn((before, after) => {
+        const status = useStatus();
+        after(() => {
+            if (!status.isDefined || (opts === null || opts === void 0 ? void 0 : opts.force)) {
+                status.value = code;
+            }
+        });
+    });
+};
+/**
+ * Set Response Status for Request Handler
+ *
+ * ```ts
+ * import { Get, SetStatus } from '@moostjs/event-http';
+ * import { Controller } from 'moost';
+ *
+ * @Controller()
+ * export class ExampleController {
+ *   @Get('test')
+ *   @SetStatus(201)
+ *   testHandler() {
+ *     return '...'
+ *   }
+ * }
+ * ```
+ * @param code number
+ * @param opts optional { force?: boolean }
+ */
+function SetStatus(...args) {
+    return Intercept(setStatusInterceptor(...args));
 }
 
 function httpValidatePipe(opts) {
@@ -618,4 +709,4 @@ function httpValidatePipe(opts) {
         } }, 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, 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, httpValidatePipe };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@moostjs/event-http",
-  "version": "0.2.31",
+  "version": "0.2.33",
   "description": "@moostjs/event-http",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",
@@ -29,9 +29,9 @@
   "homepage": "https://github.com/moostjs/moostjs/tree/main/packages/event-http#readme",
   "peerDependencies": {},
   "dependencies": {
-    "moost": "0.2.31",
-    "@wooksjs/event-core": "^0.3.2",
-    "@wooksjs/event-http": "^0.3.2",
+    "moost": "0.2.33",
+    "@wooksjs/event-core": "^0.3.3",
+    "@wooksjs/event-http": "^0.3.3",
     "@prostojs/infact": "^0.1.11",
     "@prostojs/router": "^0.1.0"
   }