@decaf-ts/for-nest 0.1.5 → 0.1.7

package/lib/interceptors/AuthInterceptor.d.ts

@@ -0,0 +1,10 @@
+import { NestInterceptor, ExecutionContext, CallHandler } from "@nestjs/common";
+import { Reflector } from "@nestjs/core";
+import { Observable } from "rxjs";
+import type { AuthHandler } from "../types";
+export declare class AuthInterceptor implements NestInterceptor {
+    private readonly reflector;
+    private readonly authHandler?;
+    constructor(reflector: Reflector, authHandler?: AuthHandler | undefined);
+    intercept(ctx: ExecutionContext, next: CallHandler): Promise<Observable<any>>;
+}

package/lib/interceptors/AuthInterceptor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AuthInterceptor.js","sourceRoot":"","sources":["../../src/interceptors/AuthInterceptor.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAOwB;AACxB,uCAAyC;AAIzC,kDAA2D;AAIpD,IAAM,eAAe,GAArB,MAAM,eAAe;IAC1B,YACmB,SAAoB,EACc,WAAyB;QAD3D,cAAS,GAAT,SAAS,CAAW;QACc,gBAAW,GAAX,WAAW,CAAc;IAC3E,CAAC;IAEJ,KAAK,CAAC,SAAS,CACb,GAAqB,EACrB,IAAiB;QAEjB,MAAM,SAAS,GACb,IAAI,CAAC,SAAS,CAAC,GAAG,CAChB,yBAAa,EACb,GAAG,CAAC,UAAU,EAAE,CACjB;YACD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAuB,yBAAa,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;QAE1E,IAAI,SAAS,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YAClC,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QACnD,CAAC;QAED,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;IACvB,CAAC;CACF,CAAA;AAvBY,0CAAe;0BAAf,eAAe;IAD3B,IAAA,mBAAU,GAAE;IAIR,WAAA,IAAA,iBAAQ,GAAE,CAAA;IAAE,WAAA,IAAA,eAAM,EAAC,wBAAY,CAAC,CAAA;qCADL,gBAAS;GAF5B,eAAe,CAuB3B"}

package/lib/interceptors/DecafRequestHandlerInterceptor.cjs

@@ -64,7 +64,8 @@ let DecafRequestHandlerInterceptor = class DecafRequestHandlerInterceptor {
     }
     async intercept(ctx, next) {
         const req = ctx.switchToHttp().getRequest();
-        await this.executor.exec(req);
+        const res = ctx.switchToHttp().getResponse();
+        await this.executor.exec(req, res);
         return next.handle();
     }
 };

package/lib/interceptors/DecafRequestHandlerInterceptor.js.map

@@ -1 +1 @@
-{"version":3,"file":"DecafRequestHandlerInterceptor.js","sourceRoot":"","sources":["../../src/interceptors/DecafRequestHandlerInterceptor.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAMwB;AACxB,oDAAkD;AAElD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AAEI,IAAM,8BAA8B,GAApC,MAAM,8BAA8B;IACzC,YAA6B,QAA8B;QAA9B,aAAQ,GAAR,QAAQ,CAAsB;IAAG,CAAC;IAE/D,KAAK,CAAC,SAAS,CAAC,GAAqB,EAAE,IAAiB;QACtD,MAAM,GAAG,GAAG,GAAG,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,CAAC;QAC5C,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC9B,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;IACvB,CAAC;CACF,CAAA;AARY,wEAA8B;yCAA9B,8BAA8B;IAD1C,IAAA,mBAAU,EAAC,EAAE,KAAK,EAAE,cAAK,CAAC,OAAO,EAAE,CAAC;qCAEI,8BAAoB;GADhD,8BAA8B,CAQ1C"}
+{"version":3,"file":"DecafRequestHandlerInterceptor.js","sourceRoot":"","sources":["../../src/interceptors/DecafRequestHandlerInterceptor.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAMwB;AACxB,oDAAkD;AAElD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AAEI,IAAM,8BAA8B,GAApC,MAAM,8BAA8B;IACzC,YAA6B,QAA8B;QAA9B,aAAQ,GAAR,QAAQ,CAAsB;IAAG,CAAC;IAE/D,KAAK,CAAC,SAAS,CAAC,GAAqB,EAAE,IAAiB;QACtD,MAAM,GAAG,GAAG,GAAG,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,CAAC;QAC5C,MAAM,GAAG,GAAG,GAAG,CAAC,YAAY,EAAE,CAAC,WAAW,EAAE,CAAC;QAC7C,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACnC,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;IACvB,CAAC;CACF,CAAA;AATY,wEAA8B;yCAA9B,8BAA8B;IAD1C,IAAA,mBAAU,EAAC,EAAE,KAAK,EAAE,cAAK,CAAC,OAAO,EAAE,CAAC;qCAEI,8BAAoB;GADhD,8BAA8B,CAS1C"}

package/lib/request/DecafHandlerExecutor.cjs

@@ -65,9 +65,9 @@ let DecafHandlerExecutor = class DecafHandlerExecutor {
         this.handlers = handlers;
         this.context = context;
     }
-    async exec(req) {
+    async exec(req, res) {
         for (const handler of this.handlers) {
-            await handler.handle(this.context, req);
+            await handler.handle(this.context, req, res);
         }
     }
 };

package/lib/request/DecafHandlerExecutor.d.ts

@@ -48,5 +48,5 @@ export declare class DecafHandlerExecutor {
     private readonly handlers;
     private readonly context;
     constructor(handlers: DecafRequestHandler[], context: DecafRequestContext);
-    exec(req: Request): Promise<void>;
+    exec(req: Request, res: Response): Promise<void>;
 }

package/lib/request/DecafHandlerExecutor.js.map

@@ -1 +1 @@
-{"version":3,"file":"DecafHandlerExecutor.js","sourceRoot":"","sources":["../../src/request/DecafHandlerExecutor.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAA2D;AAC3D,mEAA4D;AAE5D,kDAA8C;AAE9C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AAEI,IAAM,oBAAoB,GAA1B,MAAM,oBAAoB;IAC/B,YAC2C,QAA+B,EACvD,OAA4B;QADJ,aAAQ,GAAR,QAAQ,CAAuB;QACvD,YAAO,GAAP,OAAO,CAAqB;IAC5C,CAAC;IAEJ,KAAK,CAAC,IAAI,CAAC,GAAY;QACrB,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YACpC,MAAM,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;QAC1C,CAAC;IACH,CAAC;CACF,CAAA;AAXY,oDAAoB;+BAApB,oBAAoB;IADhC,IAAA,mBAAU,EAAC,EAAE,KAAK,EAAE,cAAK,CAAC,OAAO,EAAE,CAAC;IAGhC,WAAA,IAAA,eAAM,EAAC,0BAAc,CAAC,CAAA;4CACG,yCAAmB;GAHpC,oBAAoB,CAWhC"}
+{"version":3,"file":"DecafHandlerExecutor.js","sourceRoot":"","sources":["../../src/request/DecafHandlerExecutor.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAA2D;AAC3D,mEAA4D;AAE5D,kDAA8C;AAE9C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AAEI,IAAM,oBAAoB,GAA1B,MAAM,oBAAoB;IAC/B,YAC2C,QAA+B,EACvD,OAA4B;QADJ,aAAQ,GAAR,QAAQ,CAAuB;QACvD,YAAO,GAAP,OAAO,CAAqB;IAC5C,CAAC;IAEJ,KAAK,CAAC,IAAI,CAAC,GAAY,EAAE,GAAa;QACpC,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YACpC,MAAM,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;CACF,CAAA;AAXY,oDAAoB;+BAApB,oBAAoB;IADhC,IAAA,mBAAU,EAAC,EAAE,KAAK,EAAE,cAAK,CAAC,OAAO,EAAE,CAAC;IAGhC,WAAA,IAAA,eAAM,EAAC,0BAAc,CAAC,CAAA;4CACG,yCAAmB;GAHpC,oBAAoB,CAWhC"}

package/lib/types.d.ts

@@ -1,12 +1,12 @@
 import { Adapter } from "@decaf-ts/core";
 import { Constructor } from "@decaf-ts/decoration";
-import { Type } from "@nestjs/common";
+import { ExecutionContext, Type } from "@nestjs/common";
 export interface RequestContextAccessor {
     set(key: string | symbol, value: any): void;
     get<T = any>(key: string | symbol): T | undefined;
 }
 export interface DecafRequestHandler {
-    handle(context: RequestContextAccessor, req: Request): Promise<void>;
+    handle(context: RequestContextAccessor, req: Request, res: Response): Promise<void>;
 }
 /**
  * @publicApi
@@ -18,3 +18,47 @@ export type DecafModuleOptions<CONF = any, A extends Adapter<CONF, any, any, any
     autoControllers: boolean;
     handlers?: Type<DecafRequestHandler>[];
 };
+/**
+ * Abstraction used by the {@link AuthInterceptor} to authorize decaf models.
+ *
+ * // costumauthHandler.ts
+ *
+ * @example
+ * export class CustomAuthHandler implements AuthHandler {
+ *   async authorize(ctx: ExecutionContext, resource: string) {
+ *     const req = ctx.switchToHttp().getRequest();
+ *     const userRole = req.headers.authorization?.split(" ")[1] as string;
+ *     if (!userRole) throw new AuthorizationError("Unauthenticated");
+ *     const roles = Metadata.get(Model.get(resource)!, AuthRole);
+ *     if (!roles.includes(userRole)) {
+ *       throw new AuthorizationError("Unauthorized");
+ *     }
+ *   }
+ * }
+ *
+ * // auth.module.ts
+ *
+ * @Global()
+ * @Module({
+ *  providers: [
+ *    AuthInterceptor,
+ *    CustomAuthHandler,
+ *    {
+ *      provide: AUTH_HANDLER,
+ *      useClass: CustomAuthHandler, //swap this to use another provider
+ *    },
+ *  ],
+ *  exports: [AUTH_HANDLER, AuthInterceptor],
+ * })
+ * export class AuthModule {}
+ */
+export interface AuthHandler {
+    /**
+     * Inspect the request context and ensure the caller can access the model.
+     * Implementations should throw an {@link AuthorizationError} on denial.
+     *
+     * @param ctx - Nest execution context that exposes the request/response.
+     * @param model - Model name or constructor being accessed.
+     */
+    authorize(ctx: ExecutionContext, model: string | Constructor): Promise<void> | void;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@decaf-ts/for-nest",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "NestJS decaf integration",
   "type": "module",
   "exports": {
@@ -75,13 +75,16 @@
   },
   "homepage": "https://github.com/decaf-ts/for-nest#readme",
   "devDependencies": {
+    "@decaf-ts/for-fabric": "^0.1.16",
     "@decaf-ts/utils": "latest",
     "@eslint/js": "^9.25.1",
     "@nestjs/cli": "^11.0.0",
+    "@nestjs/platform-express": "^11.1.9",
     "@nestjs/schematics": "^11.0.9",
     "@nestjs/swagger": "^11.2.0",
     "@nestjs/testing": "^11.0.1",
-    "@types/lodash": "^4.17.20"
+    "@types/lodash": "^4.17.20",
+    "supertest": "^7.1.4"
   },
   "dependencies": {
     "@decaf-ts/core": "latest",