feat: add @Controller decorator (#23)

Author: Shinigami92

.changeset/chilly-carrots-kneel.md

@@ -0,0 +1,5 @@
+---
+"@auralis/core": minor
+---
+
+feat: add `@Controller` decorator

packages/core/src/decorators/controller.decorator.ts

@@ -0,0 +1,30 @@
+import type { Constructor } from "../utilities/constructor.util.ts";
+import { ensureControllerRef } from "../utilities/registry.util.ts";
+
+/**
+ * Controller decorator for defining a controller class.
+ *
+ * This decorator does not apply response headers.
+ *
+ * @param path The base path for the controller that usually starts with a slash.
+ *
+ * @see `RestController` if you want to create a RESTful controller.
+ */
+export function Controller(path: string): ClassDecorator {
+  return function (target) {
+    const controller = target as unknown as Constructor;
+
+    const controllerRef = ensureControllerRef(controller);
+
+    controllerRef.path = path;
+    controllerRef.responseHeaders ??= {};
+
+    if (process.env.AURALIS_DEBUG) {
+      console.debug("[Controller]:", {
+        args: [target],
+        controller,
+        path,
+      });
+    }
+  };
+}

packages/core/src/decorators/rest-controller.decorator.ts

@@ -1,6 +1,15 @@
 import type { Constructor } from "../utilities/constructor.util.ts";
 import { ensureControllerRef } from "../utilities/registry.util.ts";
 
+/**
+ * REST controller decorator for defining a RESTful controller class.
+ *
+ * This decorator applies the `Content-Type: application/json; charset=utf-8` response header.
+ *
+ * @param path The base path for the controller that usually starts with a slash.
+ *
+ * @see `Controller` if you want to create a basic controller that does not apply response headers.
+ */
 export function RestController(path: string): ClassDecorator {
   return function (target) {
     const controller = target as unknown as Constructor;

packages/core/src/index.ts

@@ -1,4 +1,5 @@
 export type { Auralis } from "./auralis.ts";
+export { Controller } from "./decorators/controller.decorator.ts";
 export { Delete } from "./decorators/delete.decorator.ts";
 export { Get } from "./decorators/get.decorator.ts";
 export { HttpMethod } from "./decorators/http-method.decorator.ts";