@tahminator/sapling 1.5.1 → 1.5.4

package/README.md

@@ -31,7 +31,7 @@ A lightweight library that brings some structure to Express.js
 
 Check the `/example` folder for a basic todo app with database integration.
 
-Sapling is also powering one of my more complex projects with 400+ users in production, which you can view at [instalock-web](https://github.com/tahminator/instalock-web).
+Sapling is also powering one of my more complex projects with 600+ users in production, which you can view at [instalock-web](https://github.com/tahminator/instalock-web).
 
 ## Install
 
@@ -188,7 +188,7 @@ import { Controller, Middleware } from "@tahminator/sapling";
 import cookieParser from "cookie-parser";
 import { NextFunction, Request, Response } from "express";
 
-@Controller()
+@MiddlewareClass() // works the same as @Controller, semantically different
 class CookieParserMiddleware {
   private readonly plugin: ReturnType<typeof cookieParser>;
 

package/dist/src/annotation/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./controller";
 export * from "./injectable";
 export * from "./route";
+export * from "./middleware";

package/dist/src/annotation/index.js

@@ -1,3 +1,4 @@
 export * from "./controller";
 export * from "./injectable";
 export * from "./route";
+export * from "./middleware";

package/dist/src/annotation/middleware.d.ts

@@ -0,0 +1,9 @@
+import { Controller } from "./controller";
+/**
+ * Used to define a middleware-only class.
+ *
+ * __NOTE:__ `@MiddlewareClass` works exactly the same as `@Controller`. As such, you
+ * can still register `@Route` and `@Middleware` methods, though you very well should not
+ * for the sake of semantics.
+ */
+export declare function MiddlewareClass(...args: Parameters<typeof Controller>): ClassDecorator;

package/dist/src/annotation/middleware.js

@@ -0,0 +1,11 @@
+import { Controller } from "./controller";
+/**
+ * Used to define a middleware-only class.
+ *
+ * __NOTE:__ `@MiddlewareClass` works exactly the same as `@Controller`. As such, you
+ * can still register `@Route` and `@Middleware` methods, though you very well should not
+ * for the sake of semantics.
+ */
+export function MiddlewareClass(...args) {
+    return Controller(...args);
+}

package/dist/src/helper/sapling.d.ts

@@ -19,7 +19,7 @@ export declare class Sapling {
      * app.use(router);
      * ```
      */
-    static resolve<TClass>(clazz: Class<TClass>): Router;
+    static resolve<TClass>(this: void, clazz: Class<TClass>): Router;
     /**
      * Register this function as a middleware in order to utilize Sapling's `deserialize` function.
      *
@@ -32,7 +32,7 @@ export declare class Sapling {
      * app.use(Sapling.json());
      * ```
      */
-    static json(): ExpressMiddlewareFn;
+    static json(this: void): ExpressMiddlewareFn;
     /**
      * Register your application with all the necessary middlewares and logics for Sapling to function.
      *
@@ -68,7 +68,7 @@ export declare class Sapling {
      * });
      * ```
      */
-    static loadResponseStatusErrorMiddleware(app: e.Express, fn: (err: ResponseStatusError, request: e.Request, response: e.Response, next: e.NextFunction) => void): void;
+    static loadResponseStatusErrorMiddleware(this: void, app: e.Express, fn: (err: ResponseStatusError, request: e.Request, response: e.Response, next: e.NextFunction) => void): void;
     /**
      * Serialize a value into a JSON string.
      *
@@ -78,11 +78,11 @@ export declare class Sapling {
      *
      * @defaultValue `JSON.stringify`
      */
-    static serialize(value: any): string;
+    static serialize(this: void, value: any): string;
     /**
      * Replace the function used for `serialize`.
      */
-    static setSerializeFn(fn: (value: any) => string): void;
+    static setSerializeFn(this: void, fn: (value: any) => string): void;
     /**
      * De-serialize a JSON string back to a JavaScript object.
      *
@@ -92,9 +92,9 @@ export declare class Sapling {
      *
      * @defaultValue `JSON.parse`
      */
-    static deserialize<T = any>(value: string): T;
+    static deserialize<T = any>(this: void, value: string): T;
     /**
      * Replace the function used for `deserialize`
      */
-    static setDeserializeFn(fn: (value: string) => any): void;
+    static setDeserializeFn(this: void, fn: (value: string) => any): void;
 }

package/dist/src/helper/sapling.js

@@ -1,7 +1,7 @@
 import e from "express";
 import { _ControllerRegistry } from "../annotation/controller";
 import { ResponseStatusError } from "./error";
-let settings = {
+const settings = {
     serialize: JSON.stringify,
     deserialize: JSON.parse,
 };
@@ -80,7 +80,7 @@ export class Sapling {
      */
     static registerApp(app) {
         app.use(e.text({ type: "application/json" }));
-        app.use(this.json());
+        app.use(Sapling.json());
     }
     /**
      * Register a middleware that will handle {@link ResponseStatusError}.

package/package.json

@@ -1,7 +1,11 @@
 {
   "name": "@tahminator/sapling",
-  "version": "1.5.1",
+  "version": "1.5.4",
+  "author": "Tahmid Ahmed",
   "description": "A library to help you write cleaner Express.js code",
+  "repository": {
+    "url": "git+https://github.com/tahminator/sapling.git"
+  },
   "scripts": {
     "test": "pnpm run build",
     "build": "rm -rf dist && tsc"
@@ -12,14 +16,14 @@
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
     }
   },
   "files": [
     "/dist"
   ],
   "keywords": [],
-  "author": "Tahmid Ahmed",
   "license": "ISC",
   "packageManager": "pnpm@10.12.4",
   "dependencies": {