@flink-app/flink 2.0.0-alpha.96 → 2.0.0-alpha.97

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @flink-app/flink
 
+## 2.0.0-alpha.97
+
+### Minor Changes
+
+-   eed6bc1: Pass host application context to auth plugins.
+
+    `FlinkAuthPlugin.authenticateRequest` now receives the host app's context as an optional third argument. Flink core supplies it on every authenticated request, so auth plugins can access repos/services without the caller wiring up a lazy accessor or maintaining a module-level mutable reference.
+
+    For `@flink-app/jwt-auth-plugin`, this means `getUser` receives the context directly:
+
+    ```typescript
+    jwtAuthPlugin({
+        getUser: async (tokenData, req, ctx) => {
+            const user = await ctx?.repos.userRepo.getById(tokenData._id);
+            return user ? { username: user.username, _id: user._id } : null;
+        },
+    });
+    ```
+
+    The `getContext` option previously added in alpha.96 is no longer needed and has been removed — remove it from your `jwtAuthPlugin({ … })` call. The third `ctx` parameter on `getUser` is optional, so callbacks that ignore it are unaffected.
+
 ## 2.0.0-alpha.96
 
 ### Patch Changes

package/dist/src/FlinkApp.js

@@ -1300,7 +1300,7 @@ var FlinkApp = /** @class */ (function () {
                         if (!this.auth) {
                             throw new Error("Attempting to authenticate request (".concat(req.method, " ").concat(req.path, ") but no authPlugin is set"));
                         }
-                        return [4 /*yield*/, this.auth.authenticateRequest(req, permissions)];
+                        return [4 /*yield*/, this.auth.authenticateRequest(req, permissions, this._ctx)];
                     case 1: return [2 /*return*/, _a.sent()];
                 }
             });

package/dist/src/auth/FlinkAuthPlugin.d.ts

@@ -1,5 +1,5 @@
 import { FlinkRequest } from "../FlinkHttpHandler";
 export interface FlinkAuthPlugin {
-    authenticateRequest: (req: FlinkRequest, permissions: string | string[]) => Promise<boolean>;
+    authenticateRequest: (req: FlinkRequest, permissions: string | string[], ctx?: any) => Promise<boolean>;
     createToken: (payload: any, roles: string[]) => Promise<string>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flink-app/flink",
-  "version": "2.0.0-alpha.96",
+  "version": "2.0.0-alpha.97",
   "description": "Typescript only framework for creating REST-like APIs on top of Express and mongodb",
   "types": "dist/src/index.d.ts",
   "main": "dist/src/index.js",

package/src/FlinkApp.ts

@@ -1580,7 +1580,7 @@ export class FlinkApp<C extends FlinkContext> {
         if (!this.auth) {
             throw new Error(`Attempting to authenticate request (${req.method} ${req.path}) but no authPlugin is set`);
         }
-        return await this.auth.authenticateRequest(req as FlinkRequest, permissions);
+        return await this.auth.authenticateRequest(req as FlinkRequest, permissions, this._ctx);
     }
 
     public getRegisteredRoutes() {

package/src/auth/FlinkAuthPlugin.ts

@@ -3,7 +3,8 @@ import { FlinkRequest } from "../FlinkHttpHandler";
 export interface FlinkAuthPlugin {
   authenticateRequest: (
     req: FlinkRequest,
-    permissions: string | string[]
+    permissions: string | string[],
+    ctx?: any
   ) => Promise<boolean>;
   createToken: (payload: any, roles: string[]) => Promise<string>;
 }