@flink-app/bankid-plugin 2.0.0-alpha.80 → 2.0.0-alpha.81

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @flink-app/bankid-plugin
 
+## 2.0.0-alpha.81
+
+### Patch Changes
+
+-   Pass ctx to onAuthSuccess and onSignSuccess callbacks, matching the OIDC plugin pattern. Callbacks now receive a params object as first argument and the Flink context (TCtx) as second argument. Plugin factory is now generic: `bankIdPlugin<TCtx>()`.
+    -   @flink-app/flink@2.0.0-alpha.81
+
 ## 2.0.0-alpha.80
 
 ### Patch Changes

package/dist/BankIdPlugin.d.ts

@@ -1,3 +1,3 @@
 import { FlinkPlugin } from "@flink-app/flink";
 import { BankIdPluginOptions } from "./BankIdPluginOptions";
-export declare function bankIdPlugin(options: BankIdPluginOptions): FlinkPlugin;
+export declare function bankIdPlugin<TCtx = any>(options: BankIdPluginOptions<TCtx>): FlinkPlugin;

package/dist/BankIdPluginOptions.d.ts

@@ -14,7 +14,7 @@ export interface AuthSuccessCallbackResponse {
     user: any;
     token: string;
 }
-export interface BankIdPluginOptions {
+export interface BankIdPluginOptions<TCtx = any> {
     /**
      * BankID PFX certificate in base64 format
      */
@@ -46,22 +46,27 @@ export interface BankIdPluginOptions {
      * Callback invoked when BankID auth is successful.
      * Callback must return an object containing user information and
      * token. This will be relayed in the collect response to client.
-     * @param userData
-     * @param ip
-     * @param payload
-     * @returns
+     *
+     * @param params - Auth result data (user, ip, payload)
+     * @param ctx - Flink context with access to repos and plugins
+     * @returns User object and JWT token
      */
-    onAuthSuccess: (userData: BankIdUserData, ip?: string, payload?: Record<string, any>) => Promise<AuthSuccessCallbackResponse>;
+    onAuthSuccess: (params: {
+        user: BankIdUserData;
+        ip?: string;
+        payload?: Record<string, any>;
+    }, ctx: TCtx) => Promise<AuthSuccessCallbackResponse>;
     /**
      * Callback invoked when BankID sign is successful.
-     * Callback must return an object containing user information and
-     * signature data. This will be relayed in the collect response to client.
-     * @param userData
-     * @param signature
-     * @param payload
-     * @returns
+     *
+     * @param params - Sign result data (user, signature, payload)
+     * @param ctx - Flink context with access to repos and plugins
      */
-    onSignSuccess?: (userData: BankIdUserData, signature: BankIdSignature, payload?: Record<string, any>) => Promise<void>;
+    onSignSuccess?: (params: {
+        user: BankIdUserData;
+        signature: BankIdSignature;
+        payload?: Record<string, any>;
+    }, ctx: TCtx) => Promise<void>;
     /**
      * For how long to keep sessions in database.
      * This has nothing to do with how long the user is logged in, only

package/dist/functions/getAuthStatus.js

@@ -60,7 +60,7 @@ function getAuthStatus(ctx, options) {
                 case 2:
                     _c.sent();
                     throw (0, flink_1.internalServerError)("Session is completed but user data is missing");
-                case 3: return [4 /*yield*/, pluginOptions.onAuthSuccess(session.user, (_a = session.device) === null || _a === void 0 ? void 0 : _a.ipAddress, session.payload)];
+                case 3: return [4 /*yield*/, pluginOptions.onAuthSuccess({ user: session.user, ip: (_a = session.device) === null || _a === void 0 ? void 0 : _a.ipAddress, payload: session.payload }, ctx)];
                 case 4:
                     authCallbackRes = _c.sent();
                     return [2 /*return*/, {

package/dist/functions/getSignStatus.js

@@ -73,7 +73,7 @@ function getSignStatus(ctx, options) {
                     throw new Error("Signature data is missing");
                 case 5: 
                 // Invoke host app callback
-                return [4 /*yield*/, pluginOptions.onSignSuccess(session.user, session.signature, session.payload)];
+                return [4 /*yield*/, pluginOptions.onSignSuccess({ user: session.user, signature: session.signature, payload: session.payload }, ctx)];
                 case 6:
                     // Invoke host app callback
                     _b.sent();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flink-app/bankid-plugin",
-  "version": "2.0.0-alpha.80",
+  "version": "2.0.0-alpha.81",
   "description": "Flink plugin for Swedish BankID authentication and document signing",
   "author": "joel@frost.se",
   "license": "MIT",
@@ -20,11 +20,11 @@
     "@types/node": "22.13.10",
     "ts-node": "^10.9.2",
     "tsc-watch": "^4.2.9",
-    "@flink-app/flink": "2.0.0-alpha.80"
+    "@flink-app/flink": "2.0.0-alpha.81"
   },
   "gitHead": "4243e3b3cd6d4e1ca001a61baa8436bf2bbe4113",
   "peerDependencies": {
-    "@flink-app/flink": ">=2.0.0-alpha.80"
+    "@flink-app/flink": ">=2.0.0-alpha.81"
   },
   "scripts": {
     "test": "jasmine-ts --config=./spec/support/jasmine.json",

package/src/BankIdPlugin.ts

@@ -13,7 +13,7 @@ import { getAuthStatus } from "./functions/getAuthStatus";
 import { getSignStatus } from "./functions/getSignStatus";
 import { cancelSession } from "./functions/cancelSession";
 
-export function bankIdPlugin(options: BankIdPluginOptions): FlinkPlugin {
+export function bankIdPlugin<TCtx = any>(options: BankIdPluginOptions<TCtx>): FlinkPlugin {
     if (!options.pfxBase64) {
         throw new Error("BankID Plugin: pfxBase64 is required");
     }

package/src/BankIdPluginOptions.ts

@@ -18,7 +18,7 @@ export interface AuthSuccessCallbackResponse {
     token: string;
 }
 
-export interface BankIdPluginOptions {
+export interface BankIdPluginOptions<TCtx = any> {
     /**
      * BankID PFX certificate in base64 format
      */
@@ -55,23 +55,34 @@ export interface BankIdPluginOptions {
      * Callback invoked when BankID auth is successful.
      * Callback must return an object containing user information and
      * token. This will be relayed in the collect response to client.
-     * @param userData
-     * @param ip
-     * @param payload
-     * @returns
+     *
+     * @param params - Auth result data (user, ip, payload)
+     * @param ctx - Flink context with access to repos and plugins
+     * @returns User object and JWT token
      */
-    onAuthSuccess: (userData: BankIdUserData, ip?: string, payload?: Record<string, any>) => Promise<AuthSuccessCallbackResponse>;
+    onAuthSuccess: (
+        params: {
+            user: BankIdUserData;
+            ip?: string;
+            payload?: Record<string, any>;
+        },
+        ctx: TCtx
+    ) => Promise<AuthSuccessCallbackResponse>;
 
     /**
      * Callback invoked when BankID sign is successful.
-     * Callback must return an object containing user information and
-     * signature data. This will be relayed in the collect response to client.
-     * @param userData
-     * @param signature
-     * @param payload
-     * @returns
+     *
+     * @param params - Sign result data (user, signature, payload)
+     * @param ctx - Flink context with access to repos and plugins
      */
-    onSignSuccess?: (userData: BankIdUserData, signature: BankIdSignature, payload?: Record<string, any>) => Promise<void>;
+    onSignSuccess?: (
+        params: {
+            user: BankIdUserData;
+            signature: BankIdSignature;
+            payload?: Record<string, any>;
+        },
+        ctx: TCtx
+    ) => Promise<void>;
 
     /**
      * For how long to keep sessions in database.

package/src/functions/getAuthStatus.ts

@@ -40,7 +40,10 @@ export async function getAuthStatus(ctx: BankIdInternalCtx, options: AuthStatusO
         // - Create user if not found
         // - Create access token
         // If host app throws for example notFound error, this will be propagated as response here
-        const authCallbackRes = await pluginOptions.onAuthSuccess(session.user, session.device?.ipAddress, session.payload);
+        const authCallbackRes = await pluginOptions.onAuthSuccess(
+            { user: session.user, ip: session.device?.ipAddress, payload: session.payload },
+            ctx
+        );
 
         return {
             status: "complete",

package/src/functions/getSignStatus.ts

@@ -48,7 +48,10 @@ export async function getSignStatus(ctx: BankIdInternalCtx, options: SignStatusO
         }
 
         // Invoke host app callback
-        await pluginOptions.onSignSuccess(session.user, session.signature, session.payload);
+        await pluginOptions.onSignSuccess(
+            { user: session.user, signature: session.signature, payload: session.payload },
+            ctx
+        );
 
         return {
             status: "complete",