tspace-spear 1.2.1-beta.1 → 1.2.2

package/README.md

@@ -111,6 +111,8 @@ const app = new Spear()
 
 ### Response
 ```js
+import { Spear } from "tspace-spear";
+
 const app = new Spear()
 .get('/' , () => {
   return { 
@@ -119,14 +121,29 @@ const app = new Spear()
 })
 .response((results, statusCode) => {
 
-  if(typeof results === 'string') return results
-  
-  /// ...
-  return {
-      success : statusCode < 400,
-      ...results,
-      statusCode
-  }
+    if (typeof results === 'string') return results
+
+    if (Array.isArray(results)) {
+        return {
+          success: statusCode < 400,
+          data: results,
+          statusCode
+        }
+    }
+
+    if (typeof results === 'object' && results !== null) {
+        return {
+          success: statusCode < 400,
+          ...results,
+          statusCode
+        }
+    }
+
+    return {
+        success: statusCode < 400,
+        data: results,
+        statusCode
+    }
 })
 .listen(3000 , () => console.log(`Server is now listening http://localhost:3000`))
 // http://localhost:3000 => { success: true , message : 'Hello World' , statusCode: 200 }
@@ -135,15 +152,28 @@ const app = new Spear()
 
 ### Catch
 ```js
+import { Spear } from "tspace-spear";
+import { z } from "zod";
 const app = new Spear()
 .get('/' , () => {
   throw new Error('Catching failed')
 })
-.catch((err : Error , { res } : T.Context) => {
+.catch((err, { res } : T.Context) => {
+
+  if(err instanceof z.ZodError) {
+      return res
+      .status(422)
+      .json({
+          success    : false,
+          message: "Validation failed",
+          issues    : err?.issues,
+          statusCode : 422
+      });
+  }
 
   return res
-    .status(500)
-    .json({
+  .status(500)
+  .json({
       success    : false,
       message    : err?.message,
       statusCode : 500

package/dist/lib/core/decorators/context.d.ts

@@ -0,0 +1,91 @@
+/**
+ * Extract specific fields from `ctx.body`.
+ *
+ * This decorator filters the request body and keeps only the
+ * specified keys. The filtered result replaces `ctx.body`
+ * before the controller method is executed.
+ *
+ * @example
+ * ```ts
+ * @Body('email', 'password')
+ * async login(ctx: T.Context) {
+ *   // ctx.body = { email: "...", password: "..." }
+ * }
+ * ```
+ *
+ * @param {...string} bodyParms - Body field names to extract.
+ * @returns {MethodDecorator}
+ */
+export declare const Body: (...bodyParms: string[]) => Function;
+/**
+ * Extract specific uploaded files from `ctx.files`.
+ *
+ * Filters uploaded files and keeps only the specified
+ * file field names before executing the controller method.
+ *
+ * @example
+ * ```ts
+ * \@Files('avatar', 'resume')
+ * async upload(ctx: T.Context) {
+ *   // ctx.files = { avatar: File, resume: File }
+ * }
+ * ```
+ *
+ * @param {...string} filesParms - File field names to extract.
+ * @returns {MethodDecorator}
+ */
+export declare const Files: (...filesParms: string[]) => Function;
+/**
+ * Extract specific route parameters from `ctx.params`.
+ *
+ * Filters route parameters and keeps only the specified
+ * parameter names.
+ *
+ * @example
+ * ```ts
+ * \@Params('id')
+ * async getUser(ctx: T.Context) {
+ *   // ctx.params = { id: "123" }
+ * }
+ * ```
+ *
+ * @param {...string} paramsData - Route parameter names to extract.
+ * @returns {MethodDecorator}
+ */
+export declare const Params: (...paramsData: string[]) => Function;
+/**
+ * Extract specific query parameters from `ctx.query`.
+ *
+ * Filters query parameters and keeps only the specified
+ * query keys.
+ *
+ * @example
+ * ```ts
+ * \@Query('page', 'limit')
+ * async listUsers(ctx: T.Context) {
+ *   // ctx.query = { page: "1", limit: "10" }
+ * }
+ * ```
+ *
+ * @param {...string} queryParms - Query parameter names to extract.
+ * @returns {MethodDecorator}
+ */
+export declare const Query: (...queryParms: string[]) => Function;
+/**
+ * Extract specific cookies from `ctx.cookies`.
+ *
+ * Filters cookies and keeps only the specified cookie keys
+ * before executing the controller method.
+ *
+ * @example
+ * ```ts
+ * \@Cookies('token')
+ * async profile(ctx: T.Context) {
+ *   // ctx.cookies = { token: "..." }
+ * }
+ * ```
+ *
+ * @param {...string} cookiesParms - Cookie names to extract.
+ * @returns {MethodDecorator}
+ */
+export declare const Cookies: (...cookiesParms: string[]) => Function;

package/dist/lib/core/decorators/context.js

@@ -1,6 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Cookies = exports.Query = exports.Params = exports.Files = exports.Body = void 0;
+/**
+ * Extract specific fields from `ctx.body`.
+ *
+ * This decorator filters the request body and keeps only the
+ * specified keys. The filtered result replaces `ctx.body`
+ * before the controller method is executed.
+ *
+ * @example
+ * ```ts
+ * @Body('email', 'password')
+ * async login(ctx: T.Context) {
+ *   // ctx.body = { email: "...", password: "..." }
+ * }
+ * ```
+ *
+ * @param {...string} bodyParms - Body field names to extract.
+ * @returns {MethodDecorator}
+ */
 const Body = (...bodyParms) => {
     return function (target, key, descriptor) {
         const originalMethod = descriptor.value;
@@ -14,6 +32,23 @@ const Body = (...bodyParms) => {
     };
 };
 exports.Body = Body;
+/**
+ * Extract specific uploaded files from `ctx.files`.
+ *
+ * Filters uploaded files and keeps only the specified
+ * file field names before executing the controller method.
+ *
+ * @example
+ * ```ts
+ * \@Files('avatar', 'resume')
+ * async upload(ctx: T.Context) {
+ *   // ctx.files = { avatar: File, resume: File }
+ * }
+ * ```
+ *
+ * @param {...string} filesParms - File field names to extract.
+ * @returns {MethodDecorator}
+ */
 const Files = (...filesParms) => {
     return function (target, key, descriptor) {
         const originalMethod = descriptor.value;
@@ -27,6 +62,23 @@ const Files = (...filesParms) => {
     };
 };
 exports.Files = Files;
+/**
+ * Extract specific route parameters from `ctx.params`.
+ *
+ * Filters route parameters and keeps only the specified
+ * parameter names.
+ *
+ * @example
+ * ```ts
+ * \@Params('id')
+ * async getUser(ctx: T.Context) {
+ *   // ctx.params = { id: "123" }
+ * }
+ * ```
+ *
+ * @param {...string} paramsData - Route parameter names to extract.
+ * @returns {MethodDecorator}
+ */
 const Params = (...paramsData) => {
     return function (target, key, descriptor) {
         const originalMethod = descriptor.value;
@@ -40,6 +92,23 @@ const Params = (...paramsData) => {
     };
 };
 exports.Params = Params;
+/**
+ * Extract specific query parameters from `ctx.query`.
+ *
+ * Filters query parameters and keeps only the specified
+ * query keys.
+ *
+ * @example
+ * ```ts
+ * \@Query('page', 'limit')
+ * async listUsers(ctx: T.Context) {
+ *   // ctx.query = { page: "1", limit: "10" }
+ * }
+ * ```
+ *
+ * @param {...string} queryParms - Query parameter names to extract.
+ * @returns {MethodDecorator}
+ */
 const Query = (...queryParms) => {
     return function (target, key, descriptor) {
         const originalMethod = descriptor.value;
@@ -53,6 +122,23 @@ const Query = (...queryParms) => {
     };
 };
 exports.Query = Query;
+/**
+ * Extract specific cookies from `ctx.cookies`.
+ *
+ * Filters cookies and keeps only the specified cookie keys
+ * before executing the controller method.
+ *
+ * @example
+ * ```ts
+ * \@Cookies('token')
+ * async profile(ctx: T.Context) {
+ *   // ctx.cookies = { token: "..." }
+ * }
+ * ```
+ *
+ * @param {...string} cookiesParms - Cookie names to extract.
+ * @returns {MethodDecorator}
+ */
 const Cookies = (...cookiesParms) => {
     return function (target, key, descriptor) {
         const originalMethod = descriptor.value;

package/dist/lib/core/decorators/context.js.map

@@ -1 +1 @@
-{"version":3,"file":"context.js","sourceRoot":"","sources":["../../../../src/lib/core/decorators/context.ts"],"names":[],"mappings":";;;AAEO,MAAM,IAAI,GAAG,CAAC,GAAG,SAAoB,EAAE,EAAE;IAC5C,OAAO,UAAS,MAAW,EAAE,GAAW,EAAE,UAA8B;QACpE,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,KAAK,WAAU,GAAe,EAAG,IAAoB;YACpE,MAAM,CAAC,GAAG,GAAG,EAAE,IAAI,IAAI,EAAE,CAAA;YACzB,MAAM,IAAI,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAA;YACnG,GAAG,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAA;YAE/C,OAAO,MAAM,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAG,IAAI,CAAC,CAAC;QACvD,CAAC,CAAC;QAEF,OAAO,UAAU,CAAC;IACtB,CAAC,CAAC;AACN,CAAC,CAAA;AAdY,QAAA,IAAI,QAchB;AAEM,MAAM,KAAK,GAAG,CAAC,GAAG,UAAqB,EAAE,EAAE;IAC9C,OAAO,UAAS,MAAW,EAAE,GAAW,EAAE,UAA8B;QACpE,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,KAAK,WAAU,GAAe,EAAG,IAAoB;YACpE,MAAM,CAAC,GAAG,GAAG,EAAE,KAAK,IAAI,EAAE,CAAA;YAC1B,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAA;YACrG,GAAG,CAAC,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAA;YAElD,OAAO,MAAM,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAG,IAAI,CAAC,CAAC;QACvD,CAAC,CAAC;QAEF,OAAO,UAAU,CAAC;IACtB,CAAC,CAAC;AACN,CAAC,CAAA;AAdY,QAAA,KAAK,SAcjB;AAEM,MAAM,MAAM,GAAG,CAAC,GAAG,UAAqB,EAAE,EAAE;IAC/C,OAAO,UAAS,MAAW,EAAE,GAAW,EAAE,UAA8B;QACpE,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,KAAK,WAAU,GAAe,EAAG,IAAoB;YACpE,MAAM,CAAC,GAAG,GAAG,EAAE,MAAM,IAAI,EAAE,CAAA;YAC3B,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAA;YACtG,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAA;YAErD,OAAO,MAAM,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAG,IAAI,CAAC,CAAC;QACvD,CAAC,CAAC;QAEF,OAAO,UAAU,CAAC;IACtB,CAAC,CAAC;AACN,CAAC,CAAA;AAdY,QAAA,MAAM,UAclB;AAEM,MAAM,KAAK,GAAG,CAAC,GAAG,UAAqB,EAAE,EAAE;IAC9C,OAAO,UAAS,MAAW,EAAE,GAAW,EAAE,UAA8B;QACpE,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,KAAK,WAAU,GAAe,EAAG,IAAoB;YACpE,MAAM,CAAC,GAAG,GAAG,EAAE,KAAK,IAAI,EAAE,CAAA;YAC1B,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAA;YACrG,GAAG,CAAC,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAA;YAElD,OAAO,MAAM,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAG,IAAI,CAAC,CAAC;QACvD,CAAC,CAAC;QAEF,OAAO,UAAU,CAAC;IACtB,CAAC,CAAC;AACN,CAAC,CAAA;AAdY,QAAA,KAAK,SAcjB;AAGM,MAAM,OAAO,GAAG,CAAC,GAAG,YAAuB,EAAE,EAAE;IAClD,OAAO,UAAS,MAAW,EAAE,GAAW,EAAE,UAA8B;QACpE,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,KAAK,WAAU,GAAe,EAAG,IAAoB;YACpE,MAAM,CAAC,GAAG,GAAG,EAAE,OAAO,IAAI,EAAE,CAAA;YAC5B,MAAM,OAAO,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAA;YACzG,GAAG,CAAC,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAA;YAExD,OAAO,MAAM,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAG,IAAI,CAAC,CAAC;QACvD,CAAC,CAAC;QAEF,OAAO,UAAU,CAAC;IACtB,CAAC,CAAC;AACN,CAAC,CAAA;AAdY,QAAA,OAAO,WAcnB"}
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../../../../src/lib/core/decorators/context.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;;;;;;;;GAiBG;AACI,MAAM,IAAI,GAAG,CAAC,GAAG,SAAmB,EAAY,EAAE;IACrD,OAAO,UAAU,MAAW,EAAE,GAAW,EAAE,UAA8B;QACrE,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,KAAK,WAAW,GAAc,EAAE,IAAoB;YACnE,MAAM,CAAC,GAAG,GAAG,EAAE,IAAI,IAAI,EAAE,CAAC;YAC1B,MAAM,IAAI,GAAG,SAAS,CAAC,MAAM,CACzB,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,EAChE,EAAE,CACL,CAAC;YAEF,GAAG,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;YAEhD,OAAO,MAAM,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;QACtD,CAAC,CAAC;QAEF,OAAO,UAAU,CAAC;IACtB,CAAC,CAAC;AACN,CAAC,CAAC;AAlBW,QAAA,IAAI,QAkBf;AAEF;;;;;;;;;;;;;;;;GAgBG;AACI,MAAM,KAAK,GAAG,CAAC,GAAG,UAAoB,EAAY,EAAE;IACvD,OAAO,UAAU,MAAW,EAAE,GAAW,EAAE,UAA8B;QACrE,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,KAAK,WAAW,GAAc,EAAE,IAAoB;YACnE,MAAM,CAAC,GAAG,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC;YAC3B,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,CAC3B,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,EAChE,EAAE,CACL,CAAC;YAEF,GAAG,CAAC,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;YAEnD,OAAO,MAAM,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;QACtD,CAAC,CAAC;QAEF,OAAO,UAAU,CAAC;IACtB,CAAC,CAAC;AACN,CAAC,CAAC;AAlBW,QAAA,KAAK,SAkBhB;AAEF;;;;;;;;;;;;;;;;GAgBG;AACI,MAAM,MAAM,GAAG,CAAC,GAAG,UAAoB,EAAY,EAAE;IACxD,OAAO,UAAU,MAAW,EAAE,GAAW,EAAE,UAA8B;QACrE,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,KAAK,WAAW,GAAc,EAAE,IAAoB;YACnE,MAAM,CAAC,GAAG,GAAG,EAAE,MAAM,IAAI,EAAE,CAAC;YAC5B,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAC5B,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,EAChE,EAAE,CACL,CAAC;YAEF,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;YAEtD,OAAO,MAAM,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;QACtD,CAAC,CAAC;QAEF,OAAO,UAAU,CAAC;IACtB,CAAC,CAAC;AACN,CAAC,CAAC;AAlBW,QAAA,MAAM,UAkBjB;AAEF;;;;;;;;;;;;;;;;GAgBG;AACI,MAAM,KAAK,GAAG,CAAC,GAAG,UAAoB,EAAY,EAAE;IACvD,OAAO,UAAU,MAAW,EAAE,GAAW,EAAE,UAA8B;QACrE,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,KAAK,WAAW,GAAc,EAAE,IAAoB;YACnE,MAAM,CAAC,GAAG,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC;YAC3B,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,CAC3B,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,EAChE,EAAE,CACL,CAAC;YAEF,GAAG,CAAC,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;YAEnD,OAAO,MAAM,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;QACtD,CAAC,CAAC;QAEF,OAAO,UAAU,CAAC;IACtB,CAAC,CAAC;AACN,CAAC,CAAC;AAlBW,QAAA,KAAK,SAkBhB;AAEF;;;;;;;;;;;;;;;;GAgBG;AACI,MAAM,OAAO,GAAG,CAAC,GAAG,YAAsB,EAAY,EAAE;IAC3D,OAAO,UAAU,MAAW,EAAE,GAAW,EAAE,UAA8B;QACrE,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,KAAK,WAAW,GAAc,EAAE,IAAoB;YACnE,MAAM,CAAC,GAAG,GAAG,EAAE,OAAO,IAAI,EAAE,CAAC;YAC7B,MAAM,OAAO,GAAG,YAAY,CAAC,MAAM,CAC/B,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,EAChE,EAAE,CACL,CAAC;YAEF,GAAG,CAAC,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;YAEzD,OAAO,MAAM,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;QACtD,CAAC,CAAC;QAEF,OAAO,UAAU,CAAC;IACtB,CAAC,CAAC;AACN,CAAC,CAAC;AAlBW,QAAA,OAAO,WAkBlB"}

package/dist/lib/core/decorators/controller.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Declares a class as a controller and assigns a base route path.
+ *
+ * The provided path will be used as the **base URL prefix**
+ * for all routes defined inside the controller. The path must
+ * start with `/`.
+ *
+ * This decorator stores the controller path using
+ * `Reflect.defineMetadata` under the key `"controllers"`.
+ * The framework can later read this metadata to register
+ * routes automatically.
+ *
+ * @example
+ * ```ts
+ * \@Controller('/users')
+ * class UserController {
+ *
+ *   async list(ctx: T.Context) {
+ *     return [{ id: 1, name: "John" }];
+ *   }
+ *
+ * }
+ * ```
+ *
+ * If a route handler defines `/profile`, the final route becomes:
+ *
+ * ```
+ * /users/profile
+ * ```
+ *
+ * @param {`/${string}`} path - Base route path for the controller.
+ * @returns {ClassDecorator}
+ */
+export declare const Controller: (path: `/${string}`) => ClassDecorator;

package/dist/lib/core/decorators/controller.js

@@ -1,6 +1,39 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Controller = void 0;
+/**
+ * Declares a class as a controller and assigns a base route path.
+ *
+ * The provided path will be used as the **base URL prefix**
+ * for all routes defined inside the controller. The path must
+ * start with `/`.
+ *
+ * This decorator stores the controller path using
+ * `Reflect.defineMetadata` under the key `"controllers"`.
+ * The framework can later read this metadata to register
+ * routes automatically.
+ *
+ * @example
+ * ```ts
+ * \@Controller('/users')
+ * class UserController {
+ *
+ *   async list(ctx: T.Context) {
+ *     return [{ id: 1, name: "John" }];
+ *   }
+ *
+ * }
+ * ```
+ *
+ * If a route handler defines `/profile`, the final route becomes:
+ *
+ * ```
+ * /users/profile
+ * ```
+ *
+ * @param {`/${string}`} path - Base route path for the controller.
+ * @returns {ClassDecorator}
+ */
 const Controller = (path) => {
     return (target) => {
         return Reflect.defineMetadata("controllers", path, target);

package/dist/lib/core/decorators/controller.js.map

@@ -1 +1 @@
-{"version":3,"file":"controller.js","sourceRoot":"","sources":["../../../../src/lib/core/decorators/controller.ts"],"names":[],"mappings":";;;AAAO,MAAM,UAAU,GAAG,CAAC,IAAkB,EAAkB,EAAE;IAC/D,OAAO,CAAC,MAAM,EAAE,EAAE;QAChB,OAAO,OAAO,CAAC,cAAc,CAAC,aAAa,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IAC7D,CAAC,CAAC;AACJ,CAAC,CAAA;AAJY,QAAA,UAAU,cAItB"}
+{"version":3,"file":"controller.js","sourceRoot":"","sources":["../../../../src/lib/core/decorators/controller.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACI,MAAM,UAAU,GAAG,CAAC,IAAkB,EAAkB,EAAE;IAC/D,OAAO,CAAC,MAAM,EAAE,EAAE;QAChB,OAAO,OAAO,CAAC,cAAc,CAAC,aAAa,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IAC7D,CAAC,CAAC;AACJ,CAAC,CAAA;AAJY,QAAA,UAAU,cAItB"}

package/dist/lib/core/decorators/headers.d.ts

@@ -0,0 +1,31 @@
+import { OutgoingHttpHeaders } from 'http';
+/**
+ * Sets the HTTP response headers and status code before the controller method executes.
+ *
+ * This decorator calls `res.writeHead()` on the underlying Node.js response object,
+ * allowing you to define the response **status code** and **headers** in advance.
+ *
+ * @example
+ * ```ts
+ * class UserController {
+ *
+ *   \@WriteHeader(200, { "Content-Type": "application/json" })
+ *   async profile(ctx: T.Context) {
+ *     return { id: 1, name: "John" };
+ *   }
+ *
+ * }
+ * ```
+ *
+ * Example response:
+ *
+ * ```
+ * HTTP/1.1 200 OK
+ * Content-Type: application/json
+ * ```
+ *
+ * @param {number} statusCode - HTTP status code to send with the response.
+ * @param {OutgoingHttpHeaders} contentType - Response headers to set.
+ * @returns {Function}
+ */
+export declare const WriteHeader: (statusCode: number, contentType: OutgoingHttpHeaders) => Function;

package/dist/lib/core/decorators/headers.js

@@ -1,6 +1,35 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WriteHeader = void 0;
+/**
+ * Sets the HTTP response headers and status code before the controller method executes.
+ *
+ * This decorator calls `res.writeHead()` on the underlying Node.js response object,
+ * allowing you to define the response **status code** and **headers** in advance.
+ *
+ * @example
+ * ```ts
+ * class UserController {
+ *
+ *   \@WriteHeader(200, { "Content-Type": "application/json" })
+ *   async profile(ctx: T.Context) {
+ *     return { id: 1, name: "John" };
+ *   }
+ *
+ * }
+ * ```
+ *
+ * Example response:
+ *
+ * ```
+ * HTTP/1.1 200 OK
+ * Content-Type: application/json
+ * ```
+ *
+ * @param {number} statusCode - HTTP status code to send with the response.
+ * @param {OutgoingHttpHeaders} contentType - Response headers to set.
+ * @returns {Function}
+ */
 const WriteHeader = (statusCode, contentType) => {
     return (target, key, descriptor) => {
         const originalMethod = descriptor.value;

package/dist/lib/core/decorators/headers.js.map

@@ -1 +1 @@
-{"version":3,"file":"headers.js","sourceRoot":"","sources":["../../../../src/lib/core/decorators/headers.ts"],"names":[],"mappings":";;;AAGO,MAAO,WAAW,GAAG,CAAC,UAAmB,EAAG,WAAiC,EAAE,EAAE;IACpF,OAAO,CAAC,MAAW,EAAE,GAAW,EAAE,UAA8B,EAAE,EAAE;QAChE,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,KAAK,WAAU,GAAe,EAAG,IAAoB;YACpE,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,CAAE,UAAU,EAAG,WAAW,CAAE,CAAC,CAAA;YAClD,OAAO,MAAM,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAG,IAAI,CAAC,CAAC;QACvD,CAAC,CAAC;QAEF,OAAO,UAAU,CAAC;IACtB,CAAC,CAAC;AACN,CAAC,CAAA;AAXa,QAAA,WAAW,eAWxB"}
+{"version":3,"file":"headers.js","sourceRoot":"","sources":["../../../../src/lib/core/decorators/headers.ts"],"names":[],"mappings":";;;AAGA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACI,MAAM,WAAW,GAAG,CAAC,UAAkB,EAAE,WAAgC,EAAY,EAAE;IAC5F,OAAO,CAAC,MAAW,EAAE,GAAW,EAAE,UAA8B,EAAE,EAAE;QAClE,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,KAAK,WAAW,GAAc,EAAE,IAAoB;YACrE,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC;YAChD,OAAO,MAAM,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;QACpD,CAAC,CAAC;QAEF,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC,CAAC;AAXW,QAAA,WAAW,eAWtB"}

package/dist/lib/core/decorators/index.d.ts

@@ -0,0 +1,9 @@
+import 'reflect-metadata';
+export * from './methods';
+export * from './headers';
+export * from './middleware';
+export * from './controller';
+export * from './headers';
+export * from './statusCode';
+export * from './context';
+export * from './swagger';

package/dist/lib/core/decorators/methods.d.ts

@@ -0,0 +1,82 @@
+/**
+ * Maps a controller method to an HTTP GET route.
+ *
+ * @example
+ * ```ts
+ * \@Get('/users')
+ * async list(ctx: T.Context) {
+ *   return [{ id: 1, name: "John" }];
+ * }
+ * ```
+ */
+export declare const Get: (path: `/${string}`) => (target: any, propertyKey: any) => void;
+/**
+ * Maps a controller method to an HTTP POST route.
+ *
+ * @example
+ * ```ts
+ * \@Post('/users')
+ * async create(ctx: T.Context) {
+ *   return { success: true };
+ * }
+ * ```
+ */
+export declare const Post: (path: `/${string}`) => (target: any, propertyKey: any) => void;
+/**
+ * Maps a controller method to an HTTP PUT route.
+ *
+ * Used for replacing a resource.
+ *
+ * @example
+ * ```ts
+ * \@Put('/users/:id')
+ * async update(ctx: T.Context) {}
+ * ```
+ */
+export declare const Put: (path: `/${string}`) => (target: any, propertyKey: any) => void;
+/**
+ * Maps a controller method to an HTTP PATCH route.
+ *
+ * Used for partially updating a resource.
+ *
+ * @example
+ * ```ts
+ * \@Patch('/users/:id')
+ * async patch(ctx: T.Context) {}
+ * ```
+ */
+export declare const Patch: (path: `/${string}`) => (target: any, propertyKey: any) => void;
+/**
+ * Maps a controller method to an HTTP DELETE route.
+ *
+ * @example
+ * ```ts
+ * \@Delete('/users/:id')
+ * async remove(ctx: T.Context) {}
+ * ```
+ */
+export declare const Delete: (path: `/${string}`) => (target: any, propertyKey: any) => void;
+/**
+ * Maps a controller method to an HTTP HEAD route.
+ *
+ * HEAD responses contain only headers and no response body.
+ *
+ * @example
+ * ```ts
+ * \@Head('/health')
+ * async health(ctx: T.Context) {}
+ * ```
+ */
+export declare const Head: (path: `/${string}`) => (target: any, propertyKey: any) => void;
+/**
+ * Maps a controller method to an HTTP OPTIONS route.
+ *
+ * Typically used for CORS preflight requests.
+ *
+ * @example
+ * ```ts
+ * \@Options('/users')
+ * async options(ctx: T.Context) {}
+ * ```
+ */
+export declare const Options: (path: `/${string}`) => (target: any, propertyKey: any) => void;

package/dist/lib/core/decorators/methods.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Delete = exports.Patch = exports.Put = exports.Post = exports.Get = void 0;
+exports.Options = exports.Head = exports.Delete = exports.Patch = exports.Put = exports.Post = exports.Get = void 0;
 const methodDecorator = (method) => {
     return (path) => {
         return (target, propertyKey) => {
@@ -17,9 +17,86 @@ const methodDecorator = (method) => {
         };
     };
 };
+/**
+ * Maps a controller method to an HTTP GET route.
+ *
+ * @example
+ * ```ts
+ * \@Get('/users')
+ * async list(ctx: T.Context) {
+ *   return [{ id: 1, name: "John" }];
+ * }
+ * ```
+ */
 exports.Get = methodDecorator('get');
+/**
+ * Maps a controller method to an HTTP POST route.
+ *
+ * @example
+ * ```ts
+ * \@Post('/users')
+ * async create(ctx: T.Context) {
+ *   return { success: true };
+ * }
+ * ```
+ */
 exports.Post = methodDecorator('post');
+/**
+ * Maps a controller method to an HTTP PUT route.
+ *
+ * Used for replacing a resource.
+ *
+ * @example
+ * ```ts
+ * \@Put('/users/:id')
+ * async update(ctx: T.Context) {}
+ * ```
+ */
 exports.Put = methodDecorator('put');
+/**
+ * Maps a controller method to an HTTP PATCH route.
+ *
+ * Used for partially updating a resource.
+ *
+ * @example
+ * ```ts
+ * \@Patch('/users/:id')
+ * async patch(ctx: T.Context) {}
+ * ```
+ */
 exports.Patch = methodDecorator('patch');
+/**
+ * Maps a controller method to an HTTP DELETE route.
+ *
+ * @example
+ * ```ts
+ * \@Delete('/users/:id')
+ * async remove(ctx: T.Context) {}
+ * ```
+ */
 exports.Delete = methodDecorator('delete');
+/**
+ * Maps a controller method to an HTTP HEAD route.
+ *
+ * HEAD responses contain only headers and no response body.
+ *
+ * @example
+ * ```ts
+ * \@Head('/health')
+ * async health(ctx: T.Context) {}
+ * ```
+ */
+exports.Head = methodDecorator('head');
+/**
+ * Maps a controller method to an HTTP OPTIONS route.
+ *
+ * Typically used for CORS preflight requests.
+ *
+ * @example
+ * ```ts
+ * \@Options('/users')
+ * async options(ctx: T.Context) {}
+ * ```
+ */
+exports.Options = methodDecorator('options');
 //# sourceMappingURL=methods.js.map

package/dist/lib/core/decorators/methods.js.map

@@ -1 +1 @@
-{"version":3,"file":"methods.js","sourceRoot":"","sources":["../../../../src/lib/core/decorators/methods.ts"],"names":[],"mappings":";;;AAEA,MAAM,eAAe,GAAG,CAAC,MAAgB,EAAE,EAAE;IAC3C,OAAO,CAAC,IAAkB,EAAE,EAAE;QAC5B,OAAO,CAAC,MAAU,EAAE,WAAe,EAAE,EAAE;YACrC,MAAM,UAAU,GAAG,MAAM,CAAC,WAAW,CAAC;YAEtC,MAAM,OAAO,GAAe,OAAO,CAAC,WAAW,CAAC,SAAS,EAAE,UAAU,CAAC;gBACpE,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,SAAS,EAAE,UAAU,CAAC;gBAC5C,CAAC,CAAC,EAAE,CAAC;YAEP,OAAO,CAAC,IAAI,CAAC;gBACX,MAAM;gBACN,IAAI;gBACJ,OAAO,EAAE,WAAW;aACrB,CAAC,CAAC;YAEH,OAAO,CAAC,cAAc,CAAC,SAAS,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QACzD,CAAC,CAAA;IACH,CAAC,CAAA;AACH,CAAC,CAAA;AAEY,QAAA,GAAG,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;AAC7B,QAAA,IAAI,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;AAC/B,QAAA,GAAG,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;AAC7B,QAAA,KAAK,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;AACjC,QAAA,MAAM,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAC"}
+{"version":3,"file":"methods.js","sourceRoot":"","sources":["../../../../src/lib/core/decorators/methods.ts"],"names":[],"mappings":";;;AAEA,MAAM,eAAe,GAAG,CAAC,MAAgB,EAAE,EAAE;IAC3C,OAAO,CAAC,IAAkB,EAAE,EAAE;QAC5B,OAAO,CAAC,MAAU,EAAE,WAAe,EAAE,EAAE;YACrC,MAAM,UAAU,GAAG,MAAM,CAAC,WAAW,CAAC;YAEtC,MAAM,OAAO,GAAe,OAAO,CAAC,WAAW,CAAC,SAAS,EAAE,UAAU,CAAC;gBACpE,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,SAAS,EAAE,UAAU,CAAC;gBAC5C,CAAC,CAAC,EAAE,CAAC;YAEP,OAAO,CAAC,IAAI,CAAC;gBACX,MAAM;gBACN,IAAI;gBACJ,OAAO,EAAE,WAAW;aACrB,CAAC,CAAC;YAEH,OAAO,CAAC,cAAc,CAAC,SAAS,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QACzD,CAAC,CAAA;IACH,CAAC,CAAA;AACH,CAAC,CAAA;AAED;;;;;;;;;;GAUG;AACU,QAAA,GAAG,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;AAE1C;;;;;;;;;;GAUG;AACU,QAAA,IAAI,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;AAE5C;;;;;;;;;;GAUG;AACU,QAAA,GAAG,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;AAE1C;;;;;;;;;;GAUG;AACU,QAAA,KAAK,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;AAE9C;;;;;;;;GAQG;AACU,QAAA,MAAM,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAC;AAEhD;;;;;;;;;;GAUG;AACU,QAAA,IAAI,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;AAE5C;;;;;;;;;;GAUG;AACU,QAAA,OAAO,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC"}