dh-auth-library 1.0.0 → 1.1.0

package/dist/auth/sessionHandler.js

@@ -0,0 +1,88 @@
+import { getUrl, Url } from 'nl-portal-playwright-libraries';
+import { SessionFileHelper } from './utils/sessionFileHelper';
+export const MAX_SESSION_TIME_IN_MINUTES = 10;
+/**
+ * This class creates the correct SessionHandler
+ * It will also perform the process of setting op the session
+ *
+ * @param authType type of login
+ * @param account with login details
+ * @param loginHandler that will handle the login itself
+ */
+export function createSessionHandler(authType, account, loginHandler) {
+    return {
+        // Get the file where the session will be stored
+        getFile: (browser) => {
+            switch (authType) {
+                case 'digid':
+                    return SessionFileHelper.getDigidFileName(browser, account);
+                case 'digid_gemachtigde':
+                    return SessionFileHelper.getDigidGemachtigdeFileName(browser, account);
+                case 'eherkenning':
+                    return SessionFileHelper.getEHerkenningFileName(browser, account);
+                case 'eherkenning_vestiging':
+                    return SessionFileHelper.getEHerkenningVestigingFileName(browser, account);
+                case 'eherkenning_bewindvoerder':
+                    return SessionFileHelper.getEHerkenningBewindvoerderFileName(browser, account);
+                case 'ad-session':
+                    return SessionFileHelper.getADFileName(browser, account);
+                default:
+                    throw new Error(`Unsupported auth type: ${authType}`);
+            }
+        },
+        /**
+         * Setup the new session
+         * If needed the AD Session if used (Needed outside the firewall)
+         *
+         * @param browser
+         * @param file
+         */
+        setupSession: async (browser, file) => {
+            const useADSession = process.env.WITH_AD_SESSION === 'true';
+            const page = await browser.newPage({
+                ignoreHTTPSErrors: true,
+                storageState: useADSession && authType !== 'ad-session' ?
+                    SessionFileHelper.getADFileName(browser, { username: `${process.env.AD_USER}`, password: `${process.env.AD_PASSWORD}` }) : undefined,
+            });
+            console.log(`New session will be created: ${file}`);
+            try {
+                await loginHandler.loginAndCreateSessionStorage(page, account, file);
+            }
+            finally {
+                await page.close();
+            }
+        },
+        /**
+         * Refresh the current session by opening a page and storing that session
+         * The UI should have refreshed the session meanwhile
+         *
+         * This is being called from the nl-portal-base-library
+         *
+         * @param browser
+         * @param file
+         */
+        refreshSession: async (browser, file) => {
+            const page = await browser.newPage({
+                ignoreHTTPSErrors: true,
+                storageState: file,
+            });
+            console.log(`Refresh of session started for : ${file}`);
+            await page.goto(getUrl(Url.PortalBaseUrl));
+            await page.waitForLoadState('networkidle');
+            if (page.url().match(/authn/)) {
+                console.log(`New session will be created as the current one is no longer valid: ${file}`);
+                try {
+                    await loginHandler.loginAndCreateSessionStorage(page, account, file);
+                }
+                catch (_error) {
+                    console.error(_error);
+                }
+            }
+            else {
+                console.log(`Current session was still valid and will be refreshed now: ${file}`);
+                await page.context().storageState({ path: file });
+            }
+            await page.close();
+        },
+    };
+}

package/dist/auth/utils/index.js

@@ -0,0 +1 @@
+export { SessionFileHelper } from './sessionFileHelper';

package/dist/auth/utils/sessionFileHelper.d.ts

@@ -1,14 +1,15 @@
 import { Browser } from '@playwright/test';
+import { Account } from 'nl-portal-playwright-libraries';
 /**
  * Easy way to create the filenames for the sessions
  */
 export declare class SessionFileHelper {
-    static getLocalhostFileName(browser: Browser): string;
-    static getLocalhostFileNameBedrijf(browser: Browser): string;
-    static getDigidFileName(browser: Browser): string;
-    static getDigidGemachtigdeFileName(browser: Browser): string;
-    static getEHerkenningFileName(browser: Browser): string;
-    static getEHerkenningVestigingFileName(browser: Browser): string;
-    static getEHerkenningBewindvoerderFileName(browser: Browser): string;
-    static getADFileName(browser: Browser): string;
+    static getLocalhostFileName(browser: Browser, account: Account): string;
+    static getLocalhostFileNameBedrijf(browser: Browser, account: Account): string;
+    static getDigidFileName(browser: Browser, account: Account): string;
+    static getDigidGemachtigdeFileName(browser: Browser, account: Account): string;
+    static getEHerkenningFileName(browser: Browser, account: Account): string;
+    static getEHerkenningVestigingFileName(browser: Browser, account: Account): string;
+    static getEHerkenningBewindvoerderFileName(browser: Browser, account: Account): string;
+    static getADFileName(browser: Browser, account: Account): string;
 }

package/dist/auth/utils/sessionFileHelper.js

@@ -0,0 +1,33 @@
+import * as path from 'node:path';
+import * as process from 'node:process';
+const sessionsDir = process.env.SESSIONS_DIR ?? path.resolve(process.cwd(), 'sessions');
+const environment = process.env.ENV ?? 'test';
+/**
+ * Easy way to create the filenames for the sessions
+ */
+export class SessionFileHelper {
+    static getLocalhostFileName(browser, account) {
+        return path.join(sessionsDir, `${browser.browserType().name()}-${environment}-${account.username}.json`);
+    }
+    static getLocalhostFileNameBedrijf(browser, account) {
+        return path.join(sessionsDir, `${browser.browserType().name()}-${environment}-${account.username}.json`);
+    }
+    static getDigidFileName(browser, account) {
+        return path.join(sessionsDir, `${browser.browserType().name()}-digid-${environment}-${account.username}.json`);
+    }
+    static getDigidGemachtigdeFileName(browser, account) {
+        return path.join(sessionsDir, `${browser.browserType().name()}-digid-gemachtigde-${environment}-${account.username}.json`);
+    }
+    static getEHerkenningFileName(browser, account) {
+        return path.join(sessionsDir, `${browser.browserType().name()}-eherkenning-${environment}-${account.username}.json`);
+    }
+    static getEHerkenningVestigingFileName(browser, account) {
+        return path.join(sessionsDir, `${browser.browserType().name()}-eherkenning-vestiging-${environment}-${account.username}.json`);
+    }
+    static getEHerkenningBewindvoerderFileName(browser, account) {
+        return path.join(sessionsDir, `${browser.browserType().name()}-eherkenning-bewindvoerder-${environment}-${account.username}.json`);
+    }
+    static getADFileName(browser, account) {
+        return path.join(sessionsDir, `${browser.browserType().name()}-ad-${environment}-${account.username}.json`);
+    }
+}

package/dist/constants/accountTypes.d.ts

@@ -1,34 +1,12 @@
 import { AuthType } from './authTypes';
-export type AccountType = 'burger' | 'bedrijf' | 'vestiging' | 'digid-gemachtigde';
+/**
+ * Interface for TestProfiles
+ * accountId should be used for identifying the account
+ * authType is used to determine the type of authentication (digid, eHerkenning etc)
+ * id can be used for extra information like bsn number or kvk number
+ */
 export interface TestProfile {
-    accountType: AccountType;
+    accountId: string;
     authType: AuthType;
     id: string;
 }
-export declare const profiles: {
-    burger: {
-        accountType: "burger";
-        authType: "digid";
-        id: string;
-    };
-    bedrijf: {
-        accountType: "bedrijf";
-        authType: "eherkenning";
-        id: string;
-    };
-    vestiging: {
-        accountType: "vestiging";
-        authType: "eherkenning_vestiging";
-        id: string;
-    };
-    gemachtigde: {
-        accountType: "digid-gemachtigde";
-        authType: "digid_gemachtigde";
-        id: string;
-    };
-    bewindvoerder: {
-        accountType: "bedrijf";
-        authType: "eherkenning_bewindvoerder";
-        id: string;
-    };
-};

package/dist/constants/accountTypes.js

@@ -0,0 +1 @@
+export {};

package/dist/constants/accounts.js

@@ -0,0 +1,40 @@
+/**
+ * To use these accounts they should be available as environment variables
+ */
+export const localhostBurgerAccount = {
+    username: `${process.env.LOCAL_BURGER_USERNAME}`,
+    password: `${process.env.LOCAL_BURGER_PASSWORD}`,
+};
+export const localhostBedrijfAccount = {
+    username: `${process.env.LOCAL_BEDRIJF_USERNAME}`,
+    password: `${process.env.LOCAL_BEDRIJF_PASSWORD}`,
+};
+export const defaultDigidAccount = {
+    username: `${process.env.DIGID_USER}`,
+    password: `${process.env.DIGID_PASSWORD}`,
+    bsn: `${process.env.DIGID_BSN}`,
+};
+export const defaultDigidGemachtigdAccount = {
+    username: `${process.env.DIGID_GEMACHTIGDE_USER}`,
+    password: `${process.env.DIGID_GEMACHTIGDE_PASSWORD}`,
+    bsn: `${process.env.DIGID_GEMACHTIGDE_BSN}`,
+};
+export const defaultEHerkenningAccount = {
+    username: `${process.env.EHERKENNING_USER}`,
+    password: `${process.env.EHERKENNING_PASSWORD}`,
+    bsn: `${process.env.EHERKENNING_NUMMER}`,
+};
+export const defaultVestigingAccount = {
+    username: `${process.env.EHERKENNING_VESTIGING_NAME}`,
+    password: `${process.env.EHERKENNING_VESTIGING_PASSWORD}`,
+    bsn: `${process.env.EHERKENNING_VESTIGING_NUMMER}`,
+};
+export const defaultProfessioneelBewindvoerderAccount = {
+    username: `${process.env.EHERKENNING_BEWINDVOERDER_USER}`,
+    password: `${process.env.EHERKENNING_BEWINDVOERDER_PASSWORD}`,
+    bsn: `${process.env.EHERKENNING_BEWINDVOERDER_BSN}`,
+};
+export const defaultADAccount = {
+    username: `${process.env.AD_USER}`,
+    password: `${process.env.AD_PASSWORD}`,
+};

package/dist/constants/authTypes.d.ts

@@ -1 +1,4 @@
+/**
+ * All possible types of authentication within DenHaag
+ */
 export type AuthType = 'localhost_burger' | 'localhost_bedrijf' | 'digid' | 'digid_gemachtigde' | 'eherkenning' | 'eherkenning_vestiging' | 'eherkenning_bewindvoerder' | 'ad-session';

package/dist/constants/authTypes.js

@@ -0,0 +1 @@
+export {};

package/dist/constants/index.d.ts

@@ -1,6 +1,3 @@
-export * from './accounts';
+export * from './loginHandler';
 export * from './accountTypes';
 export * from './authTypes';
-export * from './loginHandler';
-export * from './testAccounts';
-export * from './testProfiles';

package/dist/constants/index.js

@@ -0,0 +1,3 @@
+export * from './loginHandler';
+export * from './accountTypes';
+export * from './authTypes';

package/dist/constants/loginHandler.js

@@ -0,0 +1 @@
+export {};

package/dist/constants/testAccounts.js

@@ -0,0 +1,39 @@
+// These are all the accounts that we have for testing
+export const TestAccounts = {
+    zgwdigiduser1: {
+        id: '999991954',
+        type: 'burger',
+    },
+    zgwdigiduser2: {
+        id: '999991115',
+        type: 'burger',
+    },
+    zgwdigiduser3: {
+        id: '999991966',
+        type: 'burger',
+    },
+    zgwdigiduser4: {
+        id: '999992922',
+        type: 'burger',
+    },
+    zgwdigiduser5: {
+        id: '999991322',
+        type: 'burger',
+    },
+    testautomatisering: {
+        id: '999994499',
+        type: 'burger',
+    },
+    localhostaccount: {
+        id: '999993847',
+        type: 'burger',
+    },
+    kvkAccount: {
+        id: '90002768',
+        type: 'bedrijf',
+    },
+    kvkVestiging: {
+        id: '990000262129',
+        type: 'vestiging',
+    },
+};

package/dist/constants/testProfiles.js

@@ -0,0 +1,27 @@
+export const testProfiles = {
+    burger: {
+        accountType: 'burger',
+        authType: 'digid',
+        id: '999994499',
+    },
+    bedrijf: {
+        accountType: 'bedrijf',
+        authType: 'eherkenning',
+        id: '90002768',
+    },
+    vestiging: {
+        accountType: 'vestiging',
+        authType: 'eherkenning_vestiging',
+        id: '990000262129',
+    },
+    gemachtigde: {
+        accountType: 'digid-gemachtigde',
+        authType: 'digid_gemachtigde',
+        id: '',
+    },
+    bewindvoerder: {
+        accountType: 'bedrijf',
+        authType: 'eherkenning_bewindvoerder',
+        id: '999994499',
+    },
+};

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from './auth/index';
+export * from './constants/index';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "dh-auth-library",
-    "version": "1.0.0",
+    "version": "1.1.0",
     "repository": {
         "type": "git",
         "url": "git+https://github.com/Gemeente-DenHaag/dh-auth-library.git"
@@ -8,22 +8,19 @@
     "packageManager": "pnpm@11.5.2",
     "description": "Authentication package for all types of login on DH applications",
     "license": "MIT",
-    "main": "dist/index.cjs.js",
-    "module": "dist/index.es.js",
+    "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "exports": {
         ".": {
             "types": "./dist/index.d.ts",
-            "import": "./dist/index.es.js",
-            "require": "./dist/index.cjs.js"
+            "default": "./dist/index.js"
         }
     },
     "files": [
         "dist"
     ],
     "scripts": {
-        "preinstall": "npx only-allow pnpm",
-        "build": "vite build && tsc -p tsconfig.build.json",
+        "build": "tsc -p tsconfig.build.json",
         "prepublishOnly": "pnpm build",
         "lint": "eslint ."
     },
@@ -37,12 +34,11 @@
         "@types/node": "^25.9.4",
         "eslint": "^10.5.0",
         "typescript": "^6.0.3",
-        "typescript-eslint": "8.60.1",
-        "vite": "^8.1.0",
-        "totp-generator": "^2.0.1"
+        "typescript-eslint": "8.60.1"
     },
     "dependencies": {
-        "nl-portal-playwright-libraries": "^1.1.3"
+        "nl-portal-playwright-libraries": "^1.1.3",
+        "totp-generator": "^2.0.1"
     },
     "keywords": [
         "playwright",