dh-auth-library 1.0.0

package/README.md

@@ -0,0 +1,39 @@
+# NL Portal Playwright Libraries
+
+A Playwright library for testing NL Portal implementaties.
+test
+
+it is published an npm package too and should be imported like that
+
+---
+
+## 📦 Purpose
+
+This repository contains the base objects that are needed for testing nl-portal implementations
+It is the base for the nl-portal-playwright-template but could also be used directly if wanted
+The template however will be the easiest way to setup your testautomation
+
+---
+
+## 🧱 Structure
+
+packages/
+├── auth/        # Login en storage-state helpers for api requests and UI tests on localhost, digid and eherkenning
+├── core/        # Constains most util classes
+├── nl-portal/   # NL Portal pages, base_fixture and some utils that help with testing and testdata
+
+---
+
+## Auth
+
+The auth directory does contain fixtures for digid and eherkenning but you will still need to to create
+your own login pages with login logic for this.
+The login logic should be added to the session_helper.ts and session_manager.ts
+
+
+## Publishing to npm
+
+1 - npm version minor/major/patch  (npm version minor) -> this will update the package json version
+2 - npm pack --dry-run (just for checking if it is all okay)
+3 - npm login (follow the login instructions)
+4 - npm publish

package/dist/auth/api/apiAuthentication.d.ts

@@ -0,0 +1,10 @@
+/**
+ * The api's will use an existing session and use that token for the requests.
+ * The reason for this is that the token life-span is short and the UI always does a token-refresh.
+ * By using the UI session and stealing that token it will always be valid.
+ */
+export declare const burgerApiTest: import("@playwright/test").TestType<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & import("./apiTokenHelper").ApiFixtures, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions>;
+export declare const bedrijfApiTest: import("@playwright/test").TestType<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & import("./apiTokenHelper").ApiFixtures, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions>;
+export declare const vestigingApiTest: import("@playwright/test").TestType<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & import("./apiTokenHelper").ApiFixtures, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions>;
+export declare const digidGemachtigdeApiTest: import("@playwright/test").TestType<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & import("./apiTokenHelper").ApiFixtures, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions>;
+export declare const eHerkenningBewindvoerderApiTest: import("@playwright/test").TestType<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & import("./apiTokenHelper").ApiFixtures, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions>;

package/dist/auth/api/apiTokenHelper.d.ts

@@ -0,0 +1,17 @@
+import { test as base } from '@playwright/test';
+import { SessionHandler, urls } from 'nl-portal-playwright-libraries';
+export type ApiFixtures = {
+    urls: typeof urls;
+    token: string;
+};
+/**
+ * The token is often being refreshed so the easiest is to open a browser using the current session
+ * The UI will automatically refresh the token and that is the token we will return
+ *
+ * That token can be used to perform some api requests for a short time
+ * Per specfile it is not problem but this should be done in every specfile to assure a valid token
+ *
+ * @param baseTest
+ * @param handlerResolver
+ */
+export declare function getApiTokenFromSession(baseTest: typeof base, handlerResolver: () => SessionHandler): import("@playwright/test").TestType<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & ApiFixtures, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions>;

package/dist/auth/api/index.d.ts

@@ -0,0 +1,3 @@
+export * from './apiAuthentication';
+export * from './apiTokenHelper';
+export * from './sessionHandlerResolvers';

package/dist/auth/api/sessionHandlerResolvers.d.ts

@@ -0,0 +1,6 @@
+export declare function getBurgerSessionHandler(): import("nl-portal-playwright-libraries").SessionHandler;
+export declare function getBedrijfSessionHandler(): import("nl-portal-playwright-libraries").SessionHandler;
+export declare function getVestigingSessionHandler(): import("nl-portal-playwright-libraries").SessionHandler;
+export declare function getDigidGemachtigdeSessionHandler(): import("nl-portal-playwright-libraries").SessionHandler;
+export declare function getEHerkenningBewindvoerderSessionHandler(): import("nl-portal-playwright-libraries").SessionHandler;
+export declare function getAdSessionHandler(): import("nl-portal-playwright-libraries").SessionHandler;

package/dist/auth/getLoginHandler.d.ts

@@ -0,0 +1,3 @@
+import { AuthType } from '../constants/authTypes';
+import { LoginHandler } from '../constants/loginHandler';
+export declare function getLoginHandler(authType: AuthType): LoginHandler;

package/dist/auth/index.d.ts

@@ -0,0 +1,6 @@
+export { getLoginHandler } from './getLoginHandler';
+export { createSessionHandler, MAX_SESSION_TIME_IN_MINUTES } from './sessionHandler';
+export * from './api/index';
+export * from './loginhandlers/index';
+export * from './pages/index';
+export * from './utils/index';

package/dist/auth/loginhandlers/adLoginHandler.d.ts

@@ -0,0 +1,6 @@
+import { Page } from '@playwright/test';
+import { Account } from 'nl-portal-playwright-libraries';
+import { LoginHandler } from '../../constants/loginHandler';
+export declare class ADLoginHandler implements LoginHandler {
+    loginAndCreateSessionStorage(page: Page, account: Account, file: string): Promise<void>;
+}

package/dist/auth/loginhandlers/digidGemachtigdeLoginHandler.d.ts

@@ -0,0 +1,6 @@
+import { Page } from '@playwright/test';
+import { Account } from 'nl-portal-playwright-libraries';
+import { LoginHandler } from '../../constants/loginHandler';
+export declare class DigidGemachtigdeLoginHandler implements LoginHandler {
+    loginAndCreateSessionStorage(page: Page, account: Account, file: string): Promise<void>;
+}

package/dist/auth/loginhandlers/digidLoginHandler.d.ts

@@ -0,0 +1,6 @@
+import { Page } from '@playwright/test';
+import { Account } from 'nl-portal-playwright-libraries';
+import { LoginHandler } from '../../constants/loginHandler';
+export declare class DigidLoginHandler implements LoginHandler {
+    loginAndCreateSessionStorage(page: Page, account: Account, file: string): Promise<void>;
+}

package/dist/auth/loginhandlers/eHerkenningBewindvoerderLoginHandler.d.ts

@@ -0,0 +1,6 @@
+import { Page } from '@playwright/test';
+import { Account } from 'nl-portal-playwright-libraries';
+import { LoginHandler } from '../../constants/loginHandler';
+export declare class EHerkenningBewindvoerderLoginHandler implements LoginHandler {
+    loginAndCreateSessionStorage(page: Page, account: Account, file: string): Promise<void>;
+}

package/dist/auth/loginhandlers/eHerkenningLoginHandler.d.ts

@@ -0,0 +1,6 @@
+import { Page } from '@playwright/test';
+import { Account } from 'nl-portal-playwright-libraries';
+import { LoginHandler } from '../../constants/loginHandler';
+export declare class EHerkenningLoginHandler implements LoginHandler {
+    loginAndCreateSessionStorage(page: Page, account: Account, file: string): Promise<void>;
+}

package/dist/auth/loginhandlers/index.d.ts

@@ -0,0 +1,6 @@
+export * from './adLoginHandler';
+export * from './digidGemachtigdeLoginHandler';
+export * from './digidLoginHandler';
+export * from './eHerkenningBewindvoerderLoginHandler';
+export * from './eHerkenningLoginHandler';
+export * from './localhostLoginHandler';

package/dist/auth/loginhandlers/localhostLoginHandler.d.ts

@@ -0,0 +1,6 @@
+import { Page } from '@playwright/test';
+import { Account } from 'nl-portal-playwright-libraries';
+import { LoginHandler } from '../../constants/loginHandler';
+export declare class LocalhostLoginHandler implements LoginHandler {
+    loginAndCreateSessionStorage(page: Page, account: Account, file: string): Promise<void>;
+}

package/dist/auth/pages/adLoginPage.d.ts

@@ -0,0 +1,23 @@
+import { Locator, Page } from '@playwright/test';
+import { Account, BasePage } from 'nl-portal-playwright-libraries';
+export declare class ADLoginPage extends BasePage {
+    gebruikersnaamInput: Locator;
+    wachtwoordInput: Locator;
+    volgendeInput: Locator;
+    aanmeldenInput: Locator;
+    kanAuthAppNietGebruikenLink: Locator;
+    gebruikVerificatieCode: Locator;
+    codeInput: Locator;
+    verifierenInput: Locator;
+    constructor(page: Page);
+    openPage(path: string): Promise<void>;
+    /**
+     * Login with the AD account so we can get behind the firewall
+     *
+     * @param account
+     * @param fileName
+     */
+    loginWithADAccountAndCreateSession(account: Account, fileName: string): Promise<void>;
+    tryAgainUntilSuccesful(): Promise<void>;
+    getGzacUrl(): string;
+}

package/dist/auth/pages/digidLoginPage.d.ts

@@ -0,0 +1,15 @@
+import { Page } from '@playwright/test';
+import { LoginOverzichtPage } from './loginOverzichtPage';
+import { Account } from 'nl-portal-playwright-libraries';
+export declare class DigidLoginPage extends LoginOverzichtPage {
+    constructor(page: Page);
+    loginAndCreateNewSession(account: Account, fileName: string): Promise<void>;
+    loginAndCreateNewGemachtigdeSession(account: Account, fileName: string): Promise<void>;
+    /**
+     * Indien er al een AD sessie is maar voor de verkeerde omgeving
+     * Je krijgt dan een speciaal scherm waar je moet bevestigen voordat je door kan
+     */
+    handleAnySpecialADLoginScreen(): Promise<void>;
+    loginWithDigid(account?: Account, gemachtigde?: boolean): Promise<import("@playwright/test").Response>;
+    loginAlsDigidGemachtigde(): Promise<void>;
+}

package/dist/auth/pages/eHerkenningLoginPage.d.ts

@@ -0,0 +1,22 @@
+import { Page } from '@playwright/test';
+import { LoginOverzichtPage } from './loginOverzichtPage';
+import { Account } from 'nl-portal-playwright-libraries';
+export declare class EHerkenningLoginPage extends LoginOverzichtPage {
+    private readonly dropdownSelectIdentityProvider;
+    private readonly buttonConfirmIdentityProviderSelection;
+    private readonly textfieldUsername;
+    private readonly textfieldPassword;
+    private readonly inloggenKnop;
+    private readonly verderKnop;
+    private readonly verderLink;
+    private readonly inputBsn;
+    private readonly buttonZoek;
+    constructor(page: Page);
+    probeerInTeLoggenMetEHerkenning(account?: Account): Promise<void>;
+    loginWithEHerkenningAndCreateSession(fileName: string, account?: Account): Promise<void>;
+    loginWithEHerkenning(account?: Account): Promise<void>;
+    loginWithEHerkenningVestigingAndCreateSession(fileName: string, account?: Account): Promise<void>;
+    loginWithEHerkenningVestiging(account?: Account): Promise<void>;
+    loginAlsProfessioneelBewindvoerder(gemachtigde?: Account, file?: string): Promise<void>;
+    valideerDatNietGemachtigdBerichtZichtbaarIs(): Promise<void>;
+}

package/dist/auth/pages/index.d.ts

@@ -0,0 +1,4 @@
+export { ADLoginPage } from './adLoginPage';
+export { DigidLoginPage } from './digidLoginPage';
+export { EHerkenningLoginPage } from './eHerkenningLoginPage';
+export { LoginOverzichtPage } from './loginOverzichtPage';

package/dist/auth/pages/loginOverzichtPage.d.ts

@@ -0,0 +1,16 @@
+import { Locator, Page } from '@playwright/test';
+import { BasePage } from 'nl-portal-playwright-libraries';
+export declare class LoginOverzichtPage extends BasePage {
+    digidLoginKnop: Locator;
+    digidMachtigenLoginKnop: Locator;
+    eHerkenningLoginKnop: Locator;
+    eHerkenningMachtigingLoginKnop: Locator;
+    constructor(page: Page);
+    klikOpDigidLoginOptie(): Promise<void>;
+    klikOpDigidMachtigenLoginOptie(): Promise<void>;
+    klikOpEHerkenningLoginOptie(): Promise<void>;
+    klikOpProfessioneelBewindvoerderLoginOptie(): Promise<void>;
+    valideerDatHetLoginOverzichtZichtbaarIs(): Promise<void>;
+    accepteerCookies(): Promise<void>;
+    reloadPage(): Promise<void>;
+}

package/dist/auth/sessionHandler.d.ts

@@ -0,0 +1,13 @@
+import { Account, SessionHandler } from 'nl-portal-playwright-libraries';
+import { AuthType } from '../constants/authTypes';
+import { LoginHandler } from '../constants/loginHandler';
+export declare 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 declare function createSessionHandler(authType: AuthType, account: Account, loginHandler: LoginHandler): SessionHandler;

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

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

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

@@ -0,0 +1,14 @@
+import { Browser } from '@playwright/test';
+/**
+ * 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;
+}

package/dist/constants/accountTypes.d.ts

@@ -0,0 +1,34 @@
+import { AuthType } from './authTypes';
+export type AccountType = 'burger' | 'bedrijf' | 'vestiging' | 'digid-gemachtigde';
+export interface TestProfile {
+    accountType: AccountType;
+    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/accounts.d.ts

@@ -0,0 +1,12 @@
+import { Account } from 'nl-portal-playwright-libraries';
+/**
+ * To use these accounts they should be available as environment variables
+ */
+export declare const localhostBurgerAccount: Account;
+export declare const localhostBedrijfAccount: Account;
+export declare const defaultDigidAccount: Account;
+export declare const defaultDigidGemachtigdAccount: Account;
+export declare const defaultEHerkenningAccount: Account;
+export declare const defaultVestigingAccount: Account;
+export declare const defaultProfessioneelBewindvoerderAccount: Account;
+export declare const defaultADAccount: Account;

package/dist/constants/authTypes.d.ts

@@ -0,0 +1 @@
+export type AuthType = 'localhost_burger' | 'localhost_bedrijf' | 'digid' | 'digid_gemachtigde' | 'eherkenning' | 'eherkenning_vestiging' | 'eherkenning_bewindvoerder' | 'ad-session';

package/dist/constants/index.d.ts

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

package/dist/constants/loginHandler.d.ts

@@ -0,0 +1,5 @@
+import { Page } from '@playwright/test';
+import { Account } from 'nl-portal-playwright-libraries';
+export interface LoginHandler {
+    loginAndCreateSessionStorage(page: Page, account: Account, file: string): Promise<void>;
+}

package/dist/constants/testAccounts.d.ts

@@ -0,0 +1,38 @@
+export declare const TestAccounts: {
+    zgwdigiduser1: {
+        id: string;
+        type: "burger";
+    };
+    zgwdigiduser2: {
+        id: string;
+        type: "burger";
+    };
+    zgwdigiduser3: {
+        id: string;
+        type: "burger";
+    };
+    zgwdigiduser4: {
+        id: string;
+        type: "burger";
+    };
+    zgwdigiduser5: {
+        id: string;
+        type: "burger";
+    };
+    testautomatisering: {
+        id: string;
+        type: "burger";
+    };
+    localhostaccount: {
+        id: string;
+        type: "burger";
+    };
+    kvkAccount: {
+        id: string;
+        type: "bedrijf";
+    };
+    kvkVestiging: {
+        id: string;
+        type: "vestiging";
+    };
+};

package/dist/constants/testProfiles.d.ts

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