dh-auth-library 1.0.0 → 1.2.0

package/README.md

@@ -1,7 +1,6 @@
-# NL Portal Playwright Libraries
+# DH Authorizatoin Library
 
-A Playwright library for testing NL Portal implementaties.
-test
+A Playwright library for all login implementations in Den Haag
 
 it is published an npm package too and should be imported like that
 
@@ -9,27 +8,39 @@ 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
+Within DenHaag we will have several different repositories which will all have to use certain
+types of login like AD, digid and eHerkenning.
+
+In order to prevent each repo to have it's own implementation we created this library which 
+will take care of all login logic and even maintains the sessions during the testrun
 
 ---
 
 ## 🧱 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/        # Contains all classes for handling login and sessions
+├── constants/   # Constains accounts and types that can be used
 
 ---
 
 ## 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
+# api
+
+Has the authentication logic for api calls for nl-portal
+
+# loginhandlers
+
+Has all the login handlers that are needed for the nl-portal-playwright-libraries 
+
+# pages
+
+Has all the login pages and the login overview page
+
+# utils
 
+Has the sessionFileHelper which takes care of the filename for each session
 
 ## Publishing to npm
 

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

@@ -12,6 +12,6 @@ export type ApiFixtures = {
  * Per specfile it is not problem but this should be done in every specfile to assure a valid token
  *
  * @param baseTest
- * @param handlerResolver
+ * @param handler
  */
-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>;
+export declare function getApiTokenFromSession(baseTest: typeof base, handler: 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

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

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

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

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

@@ -10,6 +10,6 @@ export declare class DigidLoginPage extends LoginOverzichtPage {
      * 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>;
+    loginWithDigid(account: Account, gemachtigde?: boolean): Promise<import("@playwright/test").Response>;
     loginAlsDigidGemachtigde(): Promise<void>;
 }

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

@@ -12,11 +12,10 @@ export declare class EHerkenningLoginPage extends LoginOverzichtPage {
     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>;
+    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>;
 }

package/dist/auth/sessionHandler.d.ts

@@ -1,6 +1,6 @@
 import { Account, SessionHandler } from 'nl-portal-playwright-libraries';
-import { AuthType } from '../constants/authTypes';
 import { LoginHandler } from '../constants/loginHandler';
+import { AuthType } from '../constants';
 export declare const MAX_SESSION_TIME_IN_MINUTES = 10;
 /**
  * This class creates the correct SessionHandler

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/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/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/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';