@flink-app/bankid-plugin 0.12.1-alpha.23 → 0.12.1-alpha.24

package/dist/BankIdPluginOptions.d.ts

@@ -48,18 +48,20 @@ export interface BankIdPluginOptions {
      * token. This will be relayed in the collect response to client.
      * @param userData
      * @param ip
+     * @param payload
      * @returns
      */
-    onAuthSuccess: (userData: BankIdUserData, ip?: string) => Promise<AuthSuccessCallbackResponse>;
+    onAuthSuccess: (userData: BankIdUserData, ip?: string, payload?: Record<string, any>) => 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
      */
-    onSignSuccess?: (userData: BankIdUserData, signature: BankIdSignature) => Promise<void>;
+    onSignSuccess?: (userData: BankIdUserData, signature: BankIdSignature, payload?: Record<string, any>) => 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/auth.d.ts

@@ -1,6 +1,7 @@
 import { BankIdInternalCtx } from "../BankIdInternalContext";
 export interface AuthOptions {
     endUserIp?: string;
+    payload?: Record<string, any>;
 }
 export interface AuthResponse {
     orderRef: string;

package/dist/functions/auth.js

@@ -87,6 +87,7 @@ function auth(ctx_1) {
                         createdAt: new Date(),
                         ip: clientIp,
                         autoStartToken: authResponse.autoStartToken,
+                        payload: options.payload,
                         qr: {
                             qrStartToken: authResponse.qrStartToken,
                             qrStartSecret: authResponse.qrStartSecret,

package/dist/functions/getAuthStatus.js

@@ -60,7 +60,7 @@ function getAuthStatus(ctx, options) {
                 case 2:
                     _c.sent();
                     throw new Error("User data is missing");
-                case 3: return [4 /*yield*/, pluginOptions.onAuthSuccess(session.user, (_a = session.device) === null || _a === void 0 ? void 0 : _a.ipAddress)];
+                case 3: return [4 /*yield*/, pluginOptions.onAuthSuccess(session.user, (_a = session.device) === null || _a === void 0 ? void 0 : _a.ipAddress, session.payload)];
                 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)];
+                return [4 /*yield*/, pluginOptions.onSignSuccess(session.user, session.signature, session.payload)];
                 case 6:
                     // Invoke host app callback
                     _b.sent();

package/dist/functions/sign.d.ts

@@ -3,6 +3,7 @@ export interface SignOptions {
     userVisibleData: string;
     userNonVisibleData?: string;
     endUserIp?: string;
+    payload?: Record<string, any>;
 }
 export interface SignResponse {
     orderRef: string;

package/dist/functions/sign.js

@@ -96,6 +96,7 @@ function sign(ctx, options) {
                         createdAt: new Date(),
                         ip: clientIp,
                         autoStartToken: signResponse.autoStartToken,
+                        payload: options.payload,
                         qr: {
                             qrStartToken: signResponse.qrStartToken,
                             qrStartSecret: signResponse.qrStartSecret,

package/dist/handlers/PostBankIdAuth.js

@@ -56,7 +56,10 @@ var PostBankIdAuth = function (_a) { return __awaiter(void 0, [_a], void 0, func
                 return [4 /*yield*/, options.onGetEndUserIp(req)];
             case 2:
                 clientIp = _c.sent();
-                return [4 /*yield*/, (0, auth_1.auth)(ctx, { endUserIp: clientIp })];
+                return [4 /*yield*/, (0, auth_1.auth)(ctx, {
+                        endUserIp: clientIp,
+                        payload: req.body.payload
+                    })];
             case 3:
                 authResponse = _c.sent();
                 return [2 /*return*/, {

package/dist/schemas/AuthInitiateReq.d.ts

@@ -1,2 +1,3 @@
 export default interface AuthInitiateReq {
+    payload?: Record<string, any>;
 }

package/dist/schemas/BankIdSession.d.ts

@@ -22,6 +22,7 @@ export default interface BankIdSession {
     hintCode?: string | null;
     ip: string;
     autoStartToken: string;
+    payload?: Record<string, any>;
     qr?: {
         qrStartToken: string;
         qrStartSecret: string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@flink-app/bankid-plugin",
-    "version": "0.12.1-alpha.23",
+    "version": "0.12.1-alpha.24",
     "description": "Flink plugin for Swedish BankID authentication and document signing",
     "scripts": {
         "test": "node --preserve-symlinks -r ts-node/register -- node_modules/jasmine/bin/jasmine --config=./spec/support/jasmine.json",
@@ -32,5 +32,5 @@
         "tsc-watch": "^4.2.9",
         "typescript": "5.4.5"
     },
-    "gitHead": "ab25ba2532fd79e5452390591c1899fbe3eae230"
+    "gitHead": "7acc954a5cfd65c1cba7707d633c18025cc80dcd"
 }

package/spec/bankid-plugin.spec.ts

@@ -0,0 +1,5 @@
+describe("BankID Plugin", () => {
+    it("should be testable", () => {
+        expect(true).toBe(true);
+    });
+});

package/spec/support/jasmine.json

@@ -0,0 +1,7 @@
+{
+  "spec_dir": "spec",
+  "spec_files": ["**/*[sS]pec.ts"],
+  "helpers": ["helpers/**/*.ts"],
+  "stopSpecOnExpectationFailure": false,
+  "random": true
+}

package/src/BankIdPluginOptions.ts

@@ -57,9 +57,10 @@ export interface BankIdPluginOptions {
      * token. This will be relayed in the collect response to client.
      * @param userData
      * @param ip
+     * @param payload
      * @returns
      */
-    onAuthSuccess: (userData: BankIdUserData, ip?: string) => Promise<AuthSuccessCallbackResponse>;
+    onAuthSuccess: (userData: BankIdUserData, ip?: string, payload?: Record<string, any>) => Promise<AuthSuccessCallbackResponse>;
 
     /**
      * Callback invoked when BankID sign is successful.
@@ -67,9 +68,10 @@ export interface BankIdPluginOptions {
      * signature data. This will be relayed in the collect response to client.
      * @param userData
      * @param signature
+     * @param payload
      * @returns
      */
-    onSignSuccess?: (userData: BankIdUserData, signature: BankIdSignature) => Promise<void>;
+    onSignSuccess?: (userData: BankIdUserData, signature: BankIdSignature, payload?: Record<string, any>) => Promise<void>;
 
     /**
      * For how long to keep sessions in database.

package/src/functions/auth.ts

@@ -5,6 +5,7 @@ import { checkAndGenerateQr } from "../bankid-utils";
 
 export interface AuthOptions {
     endUserIp?: string;
+    payload?: Record<string, any>;
 }
 
 export interface AuthResponse {
@@ -55,6 +56,7 @@ export async function auth(ctx: BankIdInternalCtx, options: AuthOptions = {}): P
         createdAt: new Date(),
         ip: clientIp,
         autoStartToken: authResponse.autoStartToken,
+        payload: options.payload,
         qr: {
             qrStartToken: authResponse.qrStartToken,
             qrStartSecret: authResponse.qrStartSecret,

package/src/functions/getAuthStatus.ts

@@ -40,7 +40,7 @@ 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);
+        const authCallbackRes = await pluginOptions.onAuthSuccess(session.user, session.device?.ipAddress, session.payload);
 
         return {
             status: "complete",

package/src/functions/getSignStatus.ts

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

package/src/functions/sign.ts

@@ -7,6 +7,7 @@ export interface SignOptions {
     userVisibleData: string;
     userNonVisibleData?: string;
     endUserIp?: string;
+    payload?: Record<string, any>;
 }
 
 export interface SignResponse {
@@ -69,6 +70,7 @@ export async function sign(ctx: BankIdInternalCtx, options: SignOptions): Promis
         createdAt: new Date(),
         ip: clientIp,
         autoStartToken: signResponse.autoStartToken,
+        payload: options.payload,
         qr: {
             qrStartToken: signResponse.qrStartToken,
             qrStartSecret: signResponse.qrStartSecret,

package/src/handlers/PostBankIdAuth.ts

@@ -15,7 +15,10 @@ const PostBankIdAuth: Handler<BankIdInternalCtx, AuthInitiateReq, AuthInitiateRe
     try {
         let clientIp = await options.onGetEndUserIp(req);
 
-        const authResponse = await auth(ctx, { endUserIp: clientIp });
+        const authResponse = await auth(ctx, { 
+            endUserIp: clientIp,
+            payload: req.body.payload 
+        });
 
         return {
             data: authResponse,

package/src/schemas/AuthInitiateReq.ts

@@ -1 +1,3 @@
-export default interface AuthInitiateReq {}
+export default interface AuthInitiateReq {
+    payload?: Record<string, any>;
+}

package/src/schemas/BankIdSession.ts

@@ -24,6 +24,7 @@ export default interface BankIdSession {
     hintCode?: string | null;
     ip: string;
     autoStartToken: string;
+    payload?: Record<string, any>;
     qr?: {
         qrStartToken: string;
         qrStartSecret: string;