v0.1.1

CHANGELOG.md

@@ -0,0 +1,5 @@
+## [0.1.1] - 2024-03-03
+
+### Added
+
+- initial release

jsr.json

@@ -1,6 +1,6 @@
 {
   "name": "@dklab/oak-routing-ctrl",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "exports": {
     ".": "./mod.ts"
   }

src/Controller.ts

@@ -8,6 +8,9 @@ export abstract class BaseController {
 
 export type Controller = new () => BaseController;
 
+/**
+ * Decorator that should be used on the Controller Class
+ */
 export const Controller =
   (pathPrefix: string = "") =>
   (target: Controller, context: ClassDecoratorContext) => {

src/ControllerActionArgs.ts

@@ -1,6 +1,11 @@
 import { debug } from "./utils/logger.ts";
 import { Context, RouteContext } from "../deps.ts";
 
+/**
+ * Decorator that should be used on the Controller Class Method
+ * when we need to refer to request body, params, etc. in the
+ * method body
+ */
 export const ControllerActionArgs =
   (...desirableParams: string[]) =>
   (target: Function, context: ClassMethodDecoratorContext): any => {

src/Delete.ts

@@ -1,6 +1,10 @@
 import { debug } from "./utils/logger.ts";
 import { register } from "./Store.ts";
 
+/**
+ * Decorator that should be used on the Controller Class Method
+ * for DELETE endpoints
+ */
 export const Delete =
   (path: string = "") =>
   (target: Function, context: ClassMethodDecoratorContext) => {

src/Get.ts

@@ -1,6 +1,10 @@
 import { debug } from "./utils/logger.ts";
 import { register } from "./Store.ts";
 
+/**
+ * Decorator that should be used on the Controller Class Method
+ * for GET endpoints
+ */
 export const Get =
   (path: string = "") =>
   (target: Function, context: ClassMethodDecoratorContext) => {

src/Post.ts

@@ -1,6 +1,10 @@
 import { debug } from "./utils/logger.ts";
 import { register } from "./Store.ts";
 
+/**
+ * Decorator that should be used on the Controller Class Method
+ * for POST endpoints
+ */
 export const Post =
   (path: string = "") =>
   (target: Function, context: ClassMethodDecoratorContext) => {

src/Put.ts

@@ -1,6 +1,10 @@
 import { debug } from "./utils/logger.ts";
 import { register } from "./Store.ts";
 
+/**
+ * Decorator that should be used on the Controller Class Method
+ * for PUT endpoints
+ */
 export const Put =
   (path: string = "") =>
   (target: Function, context: ClassMemberDecoratorContext) => {

src/Store.ts

@@ -2,6 +2,10 @@ type SupportedVerb = "get" | "post" | "put" | "delete" | "patch";
 
 export const store: Map<string, Map<SupportedVerb, string>> = new Map();
 
+/**
+ * internal library helper method, used to keep track of the declared
+ * handler functions and their corresponding HTTP methods and paths
+ */
 export const register = (
   verb: SupportedVerb,
   path: string,

src/useOakServer.ts

@@ -6,6 +6,10 @@ import { store } from "./Store.ts";
 
 const oakRouter: Router = new Router({});
 
+/**
+ * entry method to supercharge an `oak` application with routing-controllers -like
+ * capabilities (i.e. Controller Class and Method Decorators)
+ */
 export const useOakServer = (
   app: Application,
   Controllers: Controller[],

src/utils/logger.ts

@@ -1,3 +1,7 @@
+/**
+ * proxies to `console.debug` but acts as a no-op unless the `DEBUG`
+ * env var is declared
+ */
 export const debug = (...data: any[]): void => {
   if (Deno.env.get("DEBUG")) {
     console.debug(...data);