Merge pull request #105 from bootgs/feature/new-response-features

Feature/new response features

Author: MaksymStoianov

README.md

@@ -1,5 +1,5 @@
 import { isString } from "apps-script-utils";
-import { ApplicationConfig, AppsScriptMenuProxy } from "../domain/types";
+import { ApplicationConfig, AppsScriptMenuProxy, HttpRequest, HttpResponse } from "../domain/types";
 import { AppsScriptEventType, RequestMethod } from "../domain/enums";
 import { BaseBootApplication } from "./BaseBootApplication";
 
@@ -59,8 +59,12 @@ export class AsyncBootApplication extends BaseBootApplication {
   public async doGet(
     event: GoogleAppsScript.Events.DoGet
   ): Promise<GoogleAppsScript.HTML.HtmlOutput | GoogleAppsScript.Content.TextOutput | string> {
-    const { request, response } = this.handleHttpRequestInternal(RequestMethod.GET, event);
-    const resolvedResponse = response instanceof Promise ? await response : response;
+    const {
+      request,
+      response
+    }: { request: HttpRequest; response: HttpResponse | Promise<HttpResponse> } =
+      this.handleHttpRequestInternal(RequestMethod.GET, event);
+    const resolvedResponse: HttpResponse = response instanceof Promise ? await response : response;
     return this._responseBuilder.wrap(request, resolvedResponse);
   }
 
@@ -73,8 +77,12 @@ export class AsyncBootApplication extends BaseBootApplication {
   public async doPost(
     event: GoogleAppsScript.Events.DoPost
   ): Promise<GoogleAppsScript.HTML.HtmlOutput | GoogleAppsScript.Content.TextOutput | string> {
-    const { request, response } = this.handleHttpRequestInternal(RequestMethod.POST, event);
-    const resolvedResponse = response instanceof Promise ? await response : response;
+    const {
+      request,
+      response
+    }: { request: HttpRequest; response: HttpResponse | Promise<HttpResponse> } =
+      this.handleHttpRequestInternal(RequestMethod.POST, event);
+    const resolvedResponse: HttpResponse = response instanceof Promise ? await response : response;
     return this._responseBuilder.wrap(request, resolvedResponse);
   }
 

src/controller/AsyncBootApplication.ts

@@ -10,7 +10,7 @@ import {
   Provider,
   RouteMetadata
 } from "../domain/types";
-import { RequestMethod } from "../domain/enums";
+import { ContentMimeType, RequestMethod } from "../domain/enums";
 import {
   EventDispatcher,
   RequestFactory,
@@ -155,8 +155,11 @@ export abstract class BaseBootApplication {
         req: HttpRequest,
         status: number | undefined,
         headers: HttpHeaders | undefined,
-        data: unknown
-      ): HttpResponse => this._responseBuilder.create(req, status, headers, data)
+        data: unknown,
+        produce?: ContentMimeType,
+        isResponseBody?: boolean
+      ): HttpResponse =>
+        this._responseBuilder.create(req, status, headers, data, produce, isResponseBody)
     );
 
     return { request, response };

src/controller/BaseBootApplication.ts

@@ -1,5 +1,5 @@
 import { isString } from "apps-script-utils";
-import { ApplicationConfig, AppsScriptMenuProxy, HttpResponse } from "../domain/types";
+import { ApplicationConfig, AppsScriptMenuProxy, HttpRequest, HttpResponse } from "../domain/types";
 import { AppsScriptEventType, RequestMethod } from "../domain/enums";
 import { BaseBootApplication } from "./BaseBootApplication";
 
@@ -59,7 +59,11 @@ export class BootApplication extends BaseBootApplication {
   public doGet(
     event: GoogleAppsScript.Events.DoGet
   ): GoogleAppsScript.HTML.HtmlOutput | GoogleAppsScript.Content.TextOutput | string {
-    const { request, response } = this.handleHttpRequestInternal(RequestMethod.GET, event);
+    const {
+      request,
+      response
+    }: { request: HttpRequest; response: HttpResponse | Promise<HttpResponse> } =
+      this.handleHttpRequestInternal(RequestMethod.GET, event);
 
     if (response instanceof Promise) {
       return response.then((res: HttpResponse): any =>
@@ -79,7 +83,11 @@ export class BootApplication extends BaseBootApplication {
   public doPost(
     event: GoogleAppsScript.Events.DoPost
   ): GoogleAppsScript.HTML.HtmlOutput | GoogleAppsScript.Content.TextOutput | string {
-    const { request, response } = this.handleHttpRequestInternal(RequestMethod.POST, event);
+    const {
+      request,
+      response
+    }: { request: HttpRequest; response: HttpResponse | Promise<HttpResponse> } =
+      this.handleHttpRequestInternal(RequestMethod.POST, event);
 
     if (response instanceof Promise) {
       return response.then((res: HttpResponse): any =>

src/controller/BootApplication.ts

@@ -0,0 +1,42 @@
+import { RESPONSE_BODY_METADATA } from "../../domain/constants";
+
+/**
+ * Decorator that tells the controller that the return object should be serialized
+ * directly into the HTTP response body.
+ *
+ * In this framework, this is the default behavior for all controller methods,
+ * but this decorator is provided for compatibility with Spring Boot patterns.
+ *
+ * @returns {MethodDecorator & ClassDecorator} A decorator.
+ *
+ * @example
+ * ```TypeScript
+ * import { ResponseBody, GetMapping, Controller } from "bootgs";
+ *
+ * @Controller()
+ * class MyController {
+ *   @GetMapping("/data")
+ *   @ResponseBody
+ *   getData() {
+ *     return { message: "Hello" };
+ *   }
+ * }
+ * ```
+ */
+export function ResponseBody(): MethodDecorator & ClassDecorator {
+  return (
+    target: object,
+    propertyKey?: string | symbol,
+    descriptor?: TypedPropertyDescriptor<any>
+  ): void => {
+    if (propertyKey) {
+      if (descriptor && descriptor.value) {
+        Reflect.defineMetadata(RESPONSE_BODY_METADATA, true, descriptor.value);
+      } else {
+        Reflect.defineMetadata(RESPONSE_BODY_METADATA, true, target, propertyKey);
+      }
+    } else {
+      Reflect.defineMetadata(RESPONSE_BODY_METADATA, true, target);
+    }
+  };
+}

src/controller/decorators/ResponseBody.ts

@@ -1,8 +1,12 @@
-import { HttpController } from "../../controller/decorators";
+import { HttpController } from "./HttpController";
+import { ResponseBody } from "./ResponseBody";
 
 /**
  * Decorator that marks a class as a REST controller.
  *
+ * @param   {string} [path] - The base path for all routes in the controller.
+ * @returns {ClassDecorator} A decorator.
+ *
  * @example
  * ```TypeScript
  * import { RestController, Get, Param } from "bootgs";
@@ -16,4 +20,9 @@ import { HttpController } from "../../controller/decorators";
  * }
  * ```
  */
-export const RestController = HttpController;
+export function RestController(path?: string): ClassDecorator {
+  return (target: object): void => {
+    HttpController(path)(target as any);
+    ResponseBody()(target as any);
+  };
+}

src/controller/decorators/RestController.ts

@@ -16,3 +16,4 @@ export * from "./ResponseStatus";
 export * from "./ControllerAdvice";
 export * from "./ExceptionHandler";
 export * from "./Value";
+export * from "./ResponseBody";

src/controller/decorators/index.ts

@@ -1,10 +1,10 @@
 import { RequestMethod } from "../../../domain/enums";
-import { createHttpDecorator } from "../../../repository";
+import { createHttpDecorator, HttpDecoratorOptions } from "../../../repository";
 
 /**
  * Route handler decorator for HTTP DELETE requests.
  *
- * @param   {string} [path] - Route path (optional).
+ * @param   {string | HttpDecoratorOptions} [options] - Route path or options (optional).
  * @returns {MethodDecorator} A method decorator.
  *
  * @example

src/controller/decorators/routing/DeleteMapping.ts

@@ -1,10 +1,10 @@
 import { RequestMethod } from "../../../domain/enums";
-import { createHttpDecorator } from "../../../repository";
+import { createHttpDecorator, HttpDecoratorOptions } from "../../../repository";
 
 /**
  * Route handler decorator for HTTP GET requests.
  *
- * @param   {string} [path] - Route path (optional).
+ * @param   {string | HttpDecoratorOptions} [options] - Route path or options (optional).
  * @returns {MethodDecorator} A method decorator.
  *
  * @example

src/controller/decorators/routing/GetMapping.ts

@@ -1,10 +1,10 @@
 import { RequestMethod } from "../../../domain/enums";
-import { createHttpDecorator } from "../../../repository";
+import { createHttpDecorator, HttpDecoratorOptions } from "../../../repository";
 
 /**
  * Route handler decorator for HTTP HEAD requests.
  *
- * @param   {string} [path] - Route path (optional).
+ * @param   {string | HttpDecoratorOptions} [options] - Route path or options (optional).
  * @returns {MethodDecorator} A method decorator.
  *
  * @example