@dfinity/internet-identity-playwright 0.0.4 → 2.0.0

package/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2021 DFINITY LLC.
+   Copyright 2024 DFINITY Foundation.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

package/README.md

@@ -74,6 +74,26 @@ testWithII('should sign-in with an existing new user', async ({page, iiPage}) =>
 });
 ```
 
+The plugin defaults to an Internet Identity sign-in flow that does not require captcha. If you wish to set up a test that requires this validation, you can pass the option `captcha` set to `true` when initializing a new user:
+
+```javascript
+testWithII('should sign-in with a new user when II requires a captcha', async ({page, iiPage}) => {
+  await page.goto('/');
+
+  await iiPage.signInWithNewIdentity({captcha: true});
+});
+```
+
+Similarly, you can test a flow where Internet Identity requires the user to create and save a passkey:
+
+```javascript
+testWithII('should sign in with a new user when II requires a passkey', async ({page, iiPage}) => {
+  await page.goto('/');
+
+  await iiPage.signInWithNewIdentity({createPasskey: true});
+});
+```
+
 ### 3. Wait for Internet Identity (optional)
 
 You might encounter scenarios where you perform tests against a local replica started in parallel with your tests, commonly when automating the tests in a CI environment. The library also exposes a fixture that lets you wait for Internet Identity to be ready.
@@ -157,6 +177,20 @@ Then, navigate to the root directory and run the dedicated test:
 npm run e2e:captcha
 ```
 
+### Running Required Passkey Tests Locally
+
+The default test suite validates the use of the latest Internet Identity, which does not require the user to complete a specific step to create a passkey. To test a flow where passkey creation is required, run the following command from the `demo` directory:
+
+```bash
+docker compose -f docker-compose.passkey.yml up
+```
+
+Then, navigate to the root directory and run the dedicated test:
+
+```bash
+npm run e2e:passkey
+```
+
 ## 🚧 Limitations
 
 Currently, the library's fixtures cannot be implemented with Playwright's ability to [load existing authenticated state](https://playwright.dev/docs/auth). Playwright currently does not support IndexedDB for such features. This limitation is tracked in their [GitHub issue #11164](https://github.com/microsoft/playwright/issues/11164).
@@ -166,4 +200,4 @@ While it is technically possible to use local storage instead of IndexedDB, this
 ## 🧑‍🤝‍🧑 Community
 
 - [Forum](https://forum.dfinity.org/)
-- [Discord](https://discord.gg/E9FxceAg2j)
+- [Discord](https://discord.internetcomputer.org)

package/dist/index.js

@@ -1 +1 @@
-import{test as I}from"@playwright/test";import{expect as a}from"@playwright/test";var n=class{page;browser;context;constructor({page:o,context:i,browser:t}){this.page=o,this.browser=t,this.context=i}waitReady=async({url:o,canisterId:i,timeout:t=6e4})=>{let{host:e,protocol:c}=new URL(o),d=i!==void 0?this.browser.browserType().name()==="webkit"?`${c}//${e}?canisterId=${i}`:`${c}//${i}.${e.replace("127.0.0.1","localhost")}`:o,p=async()=>{try{return(await this.page.goto(d,{waitUntil:"domcontentloaded"}))?.ok()??!1}catch{return!1}},l=500,u=async({count:r})=>{if(await p())return"ready";let w=r-1;return w===0?"timeout":(await new Promise(m=>setTimeout(m,l)),await u({count:w}))},y=await u({count:t/l});a(y).toEqual("ready"),await a(this.page).toHaveTitle("Internet Identity");let g=this.page.locator("#registerButton");a(g).not.toBeNull()};signInWithNewIdentity=async o=>{let i=this.context.waitForEvent("page");await this.page.locator(o?.selector??"[data-tid=login-button]").click();let t=await i;await a(t).toHaveTitle("Internet Identity"),await t.locator("#registerButton").click(),await t.locator("[data-action=construct-identity]").click(),o?.captcha===!0&&(await t.locator("input#captchaInput").fill("a",{timeout:1e4}),await t.locator("#confirmRegisterButton").click());let e=await t.locator("#userNumber").textContent();return a(e).not.toBeNull(),await t.locator("#displayUserContinue").click(),await t.waitForEvent("close"),a(t.isClosed()).toBe(!0),parseInt(e)};signInWithIdentity=async({selector:o,identity:i})=>{let t=this.context.waitForEvent("page");await this.page.locator(o??"[data-tid=login-button]").click();let e=await t;await a(e).toHaveTitle("Internet Identity"),await e.locator(`[data-anchor-id='${i}']`).click(),await e.waitForEvent("close"),a(e.isClosed()).toBe(!0)}};import{expect as $}from"@playwright/test";var v=I.extend({iiPage:async({page:s,browser:o,context:i},t)=>{let e=new n({page:s,context:i,browser:o});await t(e)}});export{n as InternetIdentityPage,$ as expect,v as testWithII};
+import{test as I}from"@playwright/test";import{expect as a}from"@playwright/test";var n=class{page;browser;context;constructor({page:e,context:i,browser:t}){this.page=e,this.browser=t,this.context=i}waitReady=async({url:e,canisterId:i,timeout:t=6e4})=>{let{host:o,protocol:c}=new URL(e),d=i!==void 0?this.browser.browserType().name()==="webkit"?`${c}//${o}?canisterId=${i}`:`${c}//${i}.${o.replace("127.0.0.1","localhost")}`:e,y=async()=>{try{return(await this.page.goto(d,{waitUntil:"domcontentloaded"}))?.ok()??!1}catch{return!1}},l=500,u=async({count:r})=>{if(await y())return"ready";let w=r-1;return w===0?"timeout":(await new Promise(m=>setTimeout(m,l)),await u({count:w}))},p=await u({count:t/l});a(p).toEqual("ready"),await a(this.page).toHaveTitle("Internet Identity");let g=this.page.locator("#registerButton");a(g).not.toBeNull()};signInWithNewIdentity=async e=>{let i=this.context.waitForEvent("page");await this.page.locator(e?.selector??"[data-tid=login-button]").click();let t=await i;await a(t).toHaveTitle("Internet Identity"),await t.locator("#registerButton").click(),e?.createPasskey===!0&&await t.locator("[data-action=construct-identity]").click(),e?.captcha===!0&&(await t.locator("input#captchaInput").fill("a",{timeout:1e4}),await t.locator("#confirmRegisterButton").click());let o=await t.locator("#userNumber").textContent();return a(o).not.toBeNull(),await t.locator("#displayUserContinue").click(),await t.waitForEvent("close"),a(t.isClosed()).toBe(!0),parseInt(o)};signInWithIdentity=async({selector:e,identity:i})=>{let t=this.context.waitForEvent("page");await this.page.locator(e??"[data-tid=login-button]").click();let o=await t;await a(o).toHaveTitle("Internet Identity"),await o.locator(`[data-anchor-id='${i}']`).click(),await o.waitForEvent("close"),a(o.isClosed()).toBe(!0)}};import{expect as $}from"@playwright/test";var k=I.extend({iiPage:async({page:s,browser:e,context:i},t)=>{let o=new n({page:s,context:i,browser:e});await t(o)}});export{n as InternetIdentityPage,$ as expect,k as testWithII};

package/dist/types/page-objects/InternetIdentityPage.d.ts

@@ -30,8 +30,8 @@ export declare class InternetIdentityPage {
      */
     waitReady: ({ url: rootUrl, canisterId, timeout }: {
         url: string;
-        canisterId?: string | undefined;
-        timeout?: number | undefined;
+        canisterId?: string;
+        timeout?: number;
     }) => Promise<void>;
     /**
      * Signs in and create a new user.
@@ -39,11 +39,13 @@ export declare class InternetIdentityPage {
      * @param {Object} [params] - The optional arguments for the sign-in method.
      * @param {string} [params.selector] - The selector for the login button. Defaults to [data-tid=login-button].
      * @param {boolean} [params.captcha] - Set to true if the II login flow requires a captcha.
+     * @param {boolean} [params.createPasskey] - Set to true if the II login flow requires the user to create a passkey.
      * @returns {Promise<number>} A promise that resolves to the new identity number.
      */
     signInWithNewIdentity: (params?: {
         selector?: string;
         captcha?: boolean;
+        createPasskey?: boolean;
     }) => Promise<number>;
     /**
      * Signs in with an existing identity.
@@ -53,7 +55,7 @@ export declare class InternetIdentityPage {
      * @returns {Promise<void>} A promise that resolves when the sign-in process is complete.
      */
     signInWithIdentity: ({ selector, identity }: {
-        selector?: string | undefined;
+        selector?: string;
         identity: number;
     }) => Promise<void>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dfinity/internet-identity-playwright",
-  "version": "0.0.4",
+  "version": "2.0.0",
   "description": "A Playwright library to simplify the integration of Internet Identity authentication in E2E tests.",
   "license": "Apache-2.0",
   "repository": {
@@ -44,25 +44,27 @@
     "format:check": "prettier --check .",
     "ts-declaration": "tsc --emitDeclarationOnly --outDir dist/types",
     "build": "tsc --noEmit && node rmdir.mjs && node esbuild.mjs && npm run ts-declaration",
-    "lint": "eslint --max-warnings 0 \"src/**/*\"",
+    "lint": "eslint --max-warnings 0",
     "dev": "npm --prefix demo run dev",
-    "e2e": "NODE_ENV=development playwright test --grep-invert 'captcha'",
-    "e2e:ci": "playwright test --reporter=html --grep-invert 'captcha'",
+    "e2e": "NODE_ENV=development playwright test e2e/login.spec",
+    "e2e:ci": "playwright test --reporter=html e2e/login.spec",
     "e2e:captcha": "NODE_ENV=development playwright test e2e/captcha.spec",
-    "e2e:captcha:ci": "playwright test --reporter=html e2e/captcha.spec"
+    "e2e:captcha:ci": "playwright test --reporter=html e2e/captcha.spec",
+    "e2e:passkey": "NODE_ENV=development playwright test e2e/passkey.spec",
+    "e2e:passkey:ci": "playwright test --reporter=html e2e/passkey.spec"
   },
   "devDependencies": {
-    "@dfinity/eslint-config-oisy-wallet": "^0.0.6",
-    "@types/node": "^20.14.2",
-    "esbuild": "^0.23.1",
-    "prettier": "^3.3.3",
-    "prettier-plugin-organize-imports": "^4.0.0",
-    "typescript": "^5.3.3"
+    "@dfinity/eslint-config-oisy-wallet": "^0.1.10",
+    "@types/node": "^22.15.18",
+    "esbuild": "^0.25.4",
+    "prettier": "^3.5.3",
+    "prettier-plugin-organize-imports": "^4.1.0",
+    "typescript": "^5.7.3"
   },
   "engines": {
-    "node": ">=20"
+    "node": ">=22"
   },
   "peerDependencies": {
-    "@playwright/test": "^1.44.1"
+    "@playwright/test": "^1.52.0"
   }
 }