@baseline-ui/test-utils 3.5.0 → 3.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +32 -1
- package/dist/index.d.ts +32 -1
- package/dist/index.js +8 -8
- package/dist/index.mjs +8 -8
- package/package.json +2 -2
- package/sbom.json +6 -6
package/dist/index.d.mts
CHANGED
|
@@ -146,6 +146,35 @@ interface BaseTesterOptions {
|
|
|
146
146
|
*/
|
|
147
147
|
type DisclosureOpenWith = "click" | "Space" | "Enter" | "ArrowDown" | "ArrowUp" | "ArrowRight" | "ArrowLeft";
|
|
148
148
|
|
|
149
|
+
interface BreadcrumbsTesterOptions extends Omit<BaseTesterOptions, "trigger"> {
|
|
150
|
+
/**
|
|
151
|
+
* The accessible name of the `nav`, to pick one trail when a page has several
|
|
152
|
+
* navigation landmarks.
|
|
153
|
+
*/
|
|
154
|
+
name?: string | RegExp;
|
|
155
|
+
}
|
|
156
|
+
/**
|
|
157
|
+
* Driver for a `<Breadcrumbs>` in Playwright component tests. Construct with
|
|
158
|
+
* {@link breadcrumbsTester} (or `testers(frame).breadcrumbs()`).
|
|
159
|
+
*/
|
|
160
|
+
interface BreadcrumbsTester {
|
|
161
|
+
/** The `navigation` landmark wrapping the breadcrumb trail. */
|
|
162
|
+
readonly root: Locator;
|
|
163
|
+
/**
|
|
164
|
+
* The current-page item (`aria-current="page"`). Matches nothing when the
|
|
165
|
+
* last breadcrumb is custom children.
|
|
166
|
+
*/
|
|
167
|
+
readonly current: Locator;
|
|
168
|
+
/** The decorative separators between items. */
|
|
169
|
+
readonly separators: Locator;
|
|
170
|
+
/**
|
|
171
|
+
* A breadcrumb link, resolved by role and accessible name. A string matches
|
|
172
|
+
* the full name exactly; pass a RegExp for a partial match. Matches link items
|
|
173
|
+
* only: custom children are not links.
|
|
174
|
+
*/
|
|
175
|
+
item: (name: string | RegExp) => Locator;
|
|
176
|
+
}
|
|
177
|
+
|
|
149
178
|
/**
|
|
150
179
|
* How to open a ComboBox from the keyboard. `Space` and `Enter` are excluded
|
|
151
180
|
* from {@link DisclosureOpenWith}: the input is a text field, so `Space` would
|
|
@@ -547,6 +576,7 @@ type BoundComboBoxOptions = Omit<ComboBoxTesterOptions, "frame">;
|
|
|
547
576
|
type BoundEditorOptions = Omit<EditorTesterOptions, "frame">;
|
|
548
577
|
type BoundFileUploaderOptions = Omit<FileUploaderTesterOptions, "frame">;
|
|
549
578
|
type BoundMenuOptions = Omit<MenuTesterOptions, "frame">;
|
|
579
|
+
type BoundBreadcrumbsOptions = Omit<BreadcrumbsTesterOptions, "frame">;
|
|
550
580
|
/**
|
|
551
581
|
* The frame-bound tester factory. Methods are flat — one per component — so
|
|
552
582
|
* IDE autocomplete on `t.` lists the full surface in one place. Variants of a
|
|
@@ -562,6 +592,7 @@ interface Testers {
|
|
|
562
592
|
editor: (options?: BoundEditorOptions) => EditorTester;
|
|
563
593
|
fileUploader: (options?: BoundFileUploaderOptions) => FileUploaderTester;
|
|
564
594
|
menu: (options?: BoundMenuOptions) => MenuTester;
|
|
595
|
+
breadcrumbs: (options?: BoundBreadcrumbsOptions) => BreadcrumbsTester;
|
|
565
596
|
}
|
|
566
597
|
/**
|
|
567
598
|
* Build a frame-bound tester factory. Construct once per test and pick the
|
|
@@ -579,4 +610,4 @@ interface Testers {
|
|
|
579
610
|
*/
|
|
580
611
|
declare function testers(frame: Frame): Testers;
|
|
581
612
|
|
|
582
|
-
export { type AutocompleteTester, type ComboBoxTester, DEFAULT_CRITICAL_INCOMPLETE_RULES, DEFAULT_DISABLED_RULES, DEFAULT_WCAG_TAGS, type EditorTester, type FileUploaderTester, type Frame, type MenuSubmenuTester, type MenuTester, type MultiSelectTester, type SelectTester, type Testers, type ToBeAccessibleOptions, expect, testers };
|
|
613
|
+
export { type AutocompleteTester, type BreadcrumbsTester, type ComboBoxTester, DEFAULT_CRITICAL_INCOMPLETE_RULES, DEFAULT_DISABLED_RULES, DEFAULT_WCAG_TAGS, type EditorTester, type FileUploaderTester, type Frame, type MenuSubmenuTester, type MenuTester, type MultiSelectTester, type SelectTester, type Testers, type ToBeAccessibleOptions, expect, testers };
|
package/dist/index.d.ts
CHANGED
|
@@ -146,6 +146,35 @@ interface BaseTesterOptions {
|
|
|
146
146
|
*/
|
|
147
147
|
type DisclosureOpenWith = "click" | "Space" | "Enter" | "ArrowDown" | "ArrowUp" | "ArrowRight" | "ArrowLeft";
|
|
148
148
|
|
|
149
|
+
interface BreadcrumbsTesterOptions extends Omit<BaseTesterOptions, "trigger"> {
|
|
150
|
+
/**
|
|
151
|
+
* The accessible name of the `nav`, to pick one trail when a page has several
|
|
152
|
+
* navigation landmarks.
|
|
153
|
+
*/
|
|
154
|
+
name?: string | RegExp;
|
|
155
|
+
}
|
|
156
|
+
/**
|
|
157
|
+
* Driver for a `<Breadcrumbs>` in Playwright component tests. Construct with
|
|
158
|
+
* {@link breadcrumbsTester} (or `testers(frame).breadcrumbs()`).
|
|
159
|
+
*/
|
|
160
|
+
interface BreadcrumbsTester {
|
|
161
|
+
/** The `navigation` landmark wrapping the breadcrumb trail. */
|
|
162
|
+
readonly root: Locator;
|
|
163
|
+
/**
|
|
164
|
+
* The current-page item (`aria-current="page"`). Matches nothing when the
|
|
165
|
+
* last breadcrumb is custom children.
|
|
166
|
+
*/
|
|
167
|
+
readonly current: Locator;
|
|
168
|
+
/** The decorative separators between items. */
|
|
169
|
+
readonly separators: Locator;
|
|
170
|
+
/**
|
|
171
|
+
* A breadcrumb link, resolved by role and accessible name. A string matches
|
|
172
|
+
* the full name exactly; pass a RegExp for a partial match. Matches link items
|
|
173
|
+
* only: custom children are not links.
|
|
174
|
+
*/
|
|
175
|
+
item: (name: string | RegExp) => Locator;
|
|
176
|
+
}
|
|
177
|
+
|
|
149
178
|
/**
|
|
150
179
|
* How to open a ComboBox from the keyboard. `Space` and `Enter` are excluded
|
|
151
180
|
* from {@link DisclosureOpenWith}: the input is a text field, so `Space` would
|
|
@@ -547,6 +576,7 @@ type BoundComboBoxOptions = Omit<ComboBoxTesterOptions, "frame">;
|
|
|
547
576
|
type BoundEditorOptions = Omit<EditorTesterOptions, "frame">;
|
|
548
577
|
type BoundFileUploaderOptions = Omit<FileUploaderTesterOptions, "frame">;
|
|
549
578
|
type BoundMenuOptions = Omit<MenuTesterOptions, "frame">;
|
|
579
|
+
type BoundBreadcrumbsOptions = Omit<BreadcrumbsTesterOptions, "frame">;
|
|
550
580
|
/**
|
|
551
581
|
* The frame-bound tester factory. Methods are flat — one per component — so
|
|
552
582
|
* IDE autocomplete on `t.` lists the full surface in one place. Variants of a
|
|
@@ -562,6 +592,7 @@ interface Testers {
|
|
|
562
592
|
editor: (options?: BoundEditorOptions) => EditorTester;
|
|
563
593
|
fileUploader: (options?: BoundFileUploaderOptions) => FileUploaderTester;
|
|
564
594
|
menu: (options?: BoundMenuOptions) => MenuTester;
|
|
595
|
+
breadcrumbs: (options?: BoundBreadcrumbsOptions) => BreadcrumbsTester;
|
|
565
596
|
}
|
|
566
597
|
/**
|
|
567
598
|
* Build a frame-bound tester factory. Construct once per test and pick the
|
|
@@ -579,4 +610,4 @@ interface Testers {
|
|
|
579
610
|
*/
|
|
580
611
|
declare function testers(frame: Frame): Testers;
|
|
581
612
|
|
|
582
|
-
export { type AutocompleteTester, type ComboBoxTester, DEFAULT_CRITICAL_INCOMPLETE_RULES, DEFAULT_DISABLED_RULES, DEFAULT_WCAG_TAGS, type EditorTester, type FileUploaderTester, type Frame, type MenuSubmenuTester, type MenuTester, type MultiSelectTester, type SelectTester, type Testers, type ToBeAccessibleOptions, expect, testers };
|
|
613
|
+
export { type AutocompleteTester, type BreadcrumbsTester, type ComboBoxTester, DEFAULT_CRITICAL_INCOMPLETE_RULES, DEFAULT_DISABLED_RULES, DEFAULT_WCAG_TAGS, type EditorTester, type FileUploaderTester, type Frame, type MenuSubmenuTester, type MenuTester, type MultiSelectTester, type SelectTester, type Testers, type ToBeAccessibleOptions, expect, testers };
|
package/dist/index.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
'use strict';var test=require('@playwright/test'),
|
|
1
|
+
'use strict';var test=require('@playwright/test'),j=require('axe-core'),promises=require('fs/promises'),F=require('path');function _interopDefault(e){return e&&e.__esModule?e:{default:e}}var j__default=/*#__PURE__*/_interopDefault(j);var F__default=/*#__PURE__*/_interopDefault(F);/**
|
|
2
2
|
* Copyright (c) 2023-2024 PSPDFKit GmbH. All rights reserved.
|
|
3
3
|
*
|
|
4
4
|
* THIS SOURCE CODE AND ANY ACCOMPANYING DOCUMENTATION ARE PROTECTED BY INTERNATIONAL COPYRIGHT LAW
|
|
@@ -7,15 +7,15 @@
|
|
|
7
7
|
* This notice may not be removed from this file.
|
|
8
8
|
*
|
|
9
9
|
*/
|
|
10
|
-
var L=["wcag2a","wcag2aa","wcag21a","wcag21aa","best-practice"],O=["landmark-one-main","page-has-heading-one","region","aria-allowed-role","duplicate-id","scrollable-region-focusable"],E=["aria-valid-attr-value","aria-valid-attr","aria-required-attr"];function C(e,t={}){let{prefix:o="BaselineUI-",ignoreHashed:
|
|
10
|
+
var L=["wcag2a","wcag2aa","wcag21a","wcag21aa","best-practice"],O=["landmark-one-main","page-has-heading-one","region","aria-allowed-role","duplicate-id","scrollable-region-focusable"],E=["aria-valid-attr-value","aria-valid-attr","aria-required-attr"];function C(e,t={}){let{prefix:o="BaselineUI-",ignoreHashed:r=false}=t,n=Array.isArray(o)?o:[o];function s(c){return c.split(/[-_]/).some(u=>u.length>=5&&/^[a-z\d]+$/.test(u)&&/[a-z]/.test(u)&&/\d/.test(u))}function l(c){return [...c.classList].filter(u=>n.some(m=>u.startsWith(m))&&(!r||!s(u)))}function p(c,u=false){let m=[],h=c.shadowRoot?c.shadowRoot.children:c.children;for(let f of h){let b=u||f.getAttribute("aria-hidden")==="true",x=l(f),w=p(f,b);x.length>0?m.push({classes:x,children:w,hidden:b}):m.push(...w);}return m}function d(c,u="",m=false){let h=[];for(let f=0;f<c.length;f++){let b=c[f],x=f===c.length-1,w=m?"":x?"\u2514\u2500\u2500 ":"\u251C\u2500\u2500 ",_=m?"":u+(x?" ":"\u2502 "),W=b.classes.join(", ");h.push(u+w+W+(b.hidden?" [aria-hidden]":""),...d(b.children,_));}return h}let a=l(e),i=p(e);return a.length===0&&i.length===0?"":a.length>0?d([{classes:a,children:i,hidden:false}],"",true).join(`
|
|
11
11
|
`):d(i,"",true).join(`
|
|
12
|
-
`)}var
|
|
13
|
-
${
|
|
12
|
+
`)}var B=e=>{if(e instanceof Error)return e.message;if(typeof e=="string")return e;if(e==null)return "unknown error";try{return JSON.stringify(e)}catch{return "unstringifiable error"}},V=async e=>{let t=typeof e.goto=="function",o=!t&&typeof e.owner=="function";if(t||o)return e.locator("body");let r=e;return await r.first().evaluate(s=>s.tagName?.toLowerCase()==="iframe").catch(()=>false)?r.contentFrame().locator("body"):r},G=async e=>{await e.first().evaluate((t,o)=>{if(window.axe)return;let n=document.createElement("script");n.textContent=o,document.head.append(n);},j__default.default.source);},q=["document-title","html-has-lang","html-lang-valid","html-xml-lang-mismatch"],J=(e,t=[])=>{let o=new Set([...O,...t,...e.disableRules??[]]);return {runOnly:{type:"tag",values:[...e.tags??L]},rules:Object.fromEntries([...o].map(r=>[r,{enabled:false}]))}},I=e=>{if(e!==void 0)return typeof e=="string"?[e]:[...e]},K=async(e,t,o)=>{let r=await e.count();if(r===0)throw new Error("toBeAccessible: locator resolved to zero elements; nothing to scan.");await G(e);let n=I(t.include),s=I(t.exclude);return r===1?await e.evaluate(async(l,p)=>{let d=window,a={include:[l,...p.userInclude??[]],exclude:p.userExclude??[]};return await d.axe.run(a,p.runOptions)},{userInclude:n,userExclude:s,runOptions:o}):await e.evaluateAll(async(l,p)=>{let d=window,a={include:[...l,...p.userInclude??[]],exclude:p.userExclude??[]};return await d.axe.run(a,p.runOptions)},{userInclude:n,userExclude:s,runOptions:o})},A="BaselineUI-";function S(e){return e.replaceAll(/\W+/g,"-").replaceAll(/^-|-$/g,"")}function X(e){return Array.isArray(e)?e.length===1&&e[0]===A:e===A}function Q(e){return (Array.isArray(e)?e:[e]).join("+")}function Y(e,t,o,r,n){let s=t.slice(1).map(l=>S(l));return o&&s.push(S(o)),r!==void 0&&!X(r)&&s.push(S(Q(r))),n&&s.push("ignoreHashed"),F__default.default.join(e,`${s.join("--")}.txt`)}var T=(e,t)=>{if(typeof e?.callCount!="number")throw new TypeError(`${t}: expected a sinon spy.`)},Z=test.expect.extend({toBeWithinDelta(e,t,o){let r=Math.abs(e-t);if(Number.isNaN(r)||Number.isNaN(Number(o))||o<0)throw new TypeError(`toBeWithinDelta: cannot compare ${e} with ${t} within ${o}; expected numbers and a non-negative delta.`);return r<=o?{message:()=>`expected ${e} not to be within ${o} of ${t}`,pass:true}:{message:()=>`expected ${e} to be within ${o} of ${t}`,pass:false}},async toBeCalledOnce(e){T(e,"toBeCalledOnce");try{return await test.expect.poll(()=>e.callCount).toBe(1),{message:()=>"Expected function to be called once.",pass:!0}}catch(t){return {message:()=>B(t),pass:false}}},async toBeCalledTwice(e){T(e,"toBeCalledTwice");try{return await test.expect.poll(()=>e.callCount).toBe(2),{message:()=>"Expected function to be called twice.",pass:!0}}catch(t){return {message:()=>B(t),pass:false}}},async toBeCalledThrice(e){T(e,"toBeCalledThrice");try{return await test.expect.poll(()=>e.callCount).toBe(3),{message:()=>"Expected function to be called thrice.",pass:!0}}catch(t){return {message:()=>B(t),pass:false}}},async toBeCalledWith(e,...t){T(e,"toBeCalledWith");try{return await test.expect.poll(()=>({called:e.called,args:t.map((o,r)=>e.lastCall?.args[r])})).toStrictEqual({called:!0,args:t}),{message:()=>`Expected function to be called with ${t.join(", ")}.`,pass:!0}}catch(o){return {message:()=>B(o),pass:false}}},async toBeCalledWithExactly(e,...t){T(e,"toBeCalledWithExactly");try{return await test.expect.poll(()=>e.lastCall?.args).toStrictEqual(t),{message:()=>`Expected function to be called with exactly ${t.join(", ")}.`,pass:!0}}catch(o){return {message:()=>B(o),pass:false}}},toBeCalled(e){T(e,"toBeCalled");try{return test.expect(e.called).toBeTruthy(),{message:()=>"Expected function to be called.",pass:!0}}catch(t){return {message:()=>B(t),pass:false}}},async toBeCalledTimes(e,t){if(T(e,"toBeCalledTimes"),!Number.isInteger(t)||t<0)throw new TypeError("toBeCalledTimes: times must be a non-negative integer.");try{return await test.expect.poll(()=>e.callCount).toBe(t),{message:()=>`Expected function to be called ${t} times.`,pass:!0}}catch(o){return {message:()=>B(o),pass:false}}},async toBeAccessible(e,t={}){let o=await V(e),r=await o.first().evaluate(i=>{let c=i.ownerDocument?.defaultView;return c!==null&&c!==window.top}).catch(()=>false),n=J(t,r?q:[]),s,l=async()=>{let i=await K(o,t,n),c=t.treatIncompleteAsViolationIds??E,u=[...i.violations,...i.incomplete.filter(m=>c.includes(m.id))];return s={result:i,violations:u},u},p;try{if(t.timeout&&t.timeout>0){let i=test.expect.poll(l,{timeout:t.timeout});await(this.isNot?i.not.toHaveLength(0):i.toHaveLength(0));}else await l();}catch(i){p=i;}if(!s)throw new Error(`toBeAccessible: axe scan never completed.
|
|
13
|
+
${B(p)}`);if(s.violations.length===0)return {message:()=>"Expected accessibility violations but found none.",pass:true};this.isNot||await test.test.info().attach(t.attachmentName??"accessibility-scan-results",{body:JSON.stringify(s.result,null,2),contentType:"application/json"});let d=s.violations.map(i=>{let c=i.nodes.map(u=>Array.isArray(u.target)?u.target.join(" "):String(u.target)).join(`
|
|
14
14
|
`);return ` \u2022 [${i.id}] ${i.help}
|
|
15
15
|
${c}
|
|
16
16
|
${i.helpUrl??""}`}).join(`
|
|
17
|
-
`),a=
|
|
18
|
-
${d}`,pass:false}},async toMatchClassTree(e,t,o={}){let{prefix:
|
|
19
|
-
`,
|
|
17
|
+
`),a=s.violations.length;return {message:()=>`Found ${a} accessibility violation${a===1?"":"s"}:
|
|
18
|
+
${d}`,pass:false}},async toMatchClassTree(e,t,o={}){let{prefix:r=A,ignoreHashed:n=false}=o,s=await e.evaluate(C,{prefix:r,ignoreHashed:n});if(!s){let u=Array.isArray(r)?r.map(m=>`${m}*`).join(" / "):`${r}*`;throw new Error(`No ${u} classes found in the DOM tree.`)}let l=`${s}
|
|
19
|
+
`,p=test.test.info();if(p.config.ignoreSnapshots)return {message:()=>"Class tree snapshot check skipped.",pass:true};let a=Y(p.project.snapshotDir,p.titlePath,t,r,n),i=p.config.updateSnapshots,c;try{c=await promises.readFile(a,"utf8");}catch(u){let m=u.code;if(m==="ENOENT"&&this.isNot)return {message:()=>`A class tree snapshot doesn't exist at ${a}, matchers using ".not" won't write them automatically.`,pass:true};if(m==="ENOENT"&&i!=="none")return await promises.mkdir(F__default.default.dirname(a),{recursive:true}),await promises.writeFile(a,l),i==="missing"?{message:()=>`A class tree snapshot doesn't exist at ${a}, writing actual.`,pass:false,shouldNotRetryTest:true}:{message:()=>"Class tree snapshot created.",pass:true};throw u}if(c!==l){if(!this.isNot&&(i==="all"||i==="changed"))return await promises.writeFile(a,l),{message:()=>"Class tree snapshot updated.",pass:true};try{test.expect(l).toBe(c);}catch(u){return {message:()=>`Class tree snapshot mismatch at ${a}
|
|
20
20
|
|
|
21
|
-
${
|
|
21
|
+
${u.message}`,pass:false}}}return {message:()=>"Class tree matched snapshot.",pass:true}}});function v({frame:e,name:t}){let o=e.locator(".BaselineUI-Breadcrumbs"),r=t===void 0?o:o.and(e.getByRole("navigation",{name:t,exact:typeof t=="string"}));return {root:r,current:r.locator('[aria-current="page"]'),separators:r.getByTestId("breadcrumbs-separator"),item:n=>r.getByRole("link",{name:n,exact:typeof n=="string"})}}function g(e){let t=async()=>{if(await e.getAttribute("aria-expanded")!==null)return e;let n=e.locator("[aria-expanded]").first();return await n.count()>0?n:e},o=async()=>await(await t()).getAttribute("aria-expanded")==="true";return {button:t,isOpen:o,open:async(n="click")=>{if(await o())return;if(n==="click"){await e.click();return}await(await t()).press(n);}}}function D({frame:e,trigger:t,toggleButton:o}){let r=t??e.getByRole("combobox",{includeHidden:true}),n=o??e.getByTestId("combobox-toggle-button"),s=a=>e.getByRole("option",{name:a,exact:typeof a=="string"}),{isOpen:l,open:p}=g(r),d=async(a="click")=>{if(!await l()){if(a==="click"){await n.click();return}await p(a);}};return {input:r,toggleButton:n,listbox:e.getByRole("listbox"),option:s,isOpen:l,open:d,async selectOption(a){await d(),await s(a).click();},async filter(a){await r.fill(a);}}}function P({frame:e,root:t}){let o=t??e.locator(".BaselineUI-Editor"),r=o.getByTestId("editor-font-color-button"),n=o.getByTestId("editor-background-color-button"),s=o.getByTestId("editor-add-link-button"),l=o.getByTestId("editor-help-button"),p=o.getByTestId("editor-mention-button"),d=o.getByRole("combobox"),a=e.getByTestId("editor-mention-listbox"),i=e.getByTestId("editor-help-dialog-close-button"),c=e.getByRole("dialog").filter({has:i}),u=e.getByRole("dialog").filter({has:e.getByTestId(/^editor-link-/)});return {root:o,textbox:o.getByRole("textbox"),placeholder:o.getByTestId("editor-placeholder"),toolbar:o.getByRole("toolbar"),boldButton:o.getByTestId("editor-bold-button"),italicButton:o.getByTestId("editor-italic-button"),underlineButton:o.getByTestId("editor-underline-button"),fontColorButton:r,backgroundColorButton:n,openFontColorPicker:g(r).open,openBackgroundColorPicker:g(n).open,addLinkButton:s,linkDialog:u,linkInput:e.getByTestId("editor-link-input"),linkAddButton:e.getByTestId("editor-link-add-button"),linkEditButton:e.getByTestId("editor-link-edit-button"),linkRemoveButton:e.getByTestId("editor-link-remove-button"),linkCancelButton:e.getByTestId("editor-link-cancel-button"),linkSaveButton:e.getByTestId("editor-link-save-button"),openLinkDialog:g(s).open,saveButton:o.getByTestId("editor-save-button"),cancelButton:o.getByTestId("editor-cancel-button"),mentionButton:p,helpButton:l,helpDialog:c,helpDialogCloseButton:i,async openHelpDialog(){await c.isVisible()||await l.click();},mentionInput:d,mentionListbox:a,mentionOption:m=>a.getByRole("option",{name:m}),async startMention(){await d.isVisible()||await p.click();}}}function U({frame:e,trigger:t,variant:o="dropzone"}){let r=e.getByTestId("file-uploader"),n=r.locator('input[type="file"]'),s=t??(o==="button"?r.getByRole("button"):e.getByTestId("file-uploader-dropzone"));return {root:r,button:s,input:n,dropzone:e.getByTestId("file-uploader-dropzone"),errorMessage:r.getByRole("alert"),async upload(l){await n.setInputFiles(l);}}}function M(e,t,o){let r=l=>t.getByRole("menuitem",{name:l}).or(t.getByRole("menuitemradio",{name:l})).or(t.getByRole("menuitemcheckbox",{name:l})),n=l=>t.getByRole("group",{name:l}),{isOpen:s}=g(o);return {menu:t,item:r,section:n,isOpen:s,submenu(l){let p=r(l),d=e.getByRole("menu",{name:l}),a=M(e,d,p),{open:i}=g(p);return {...a,trigger:p,open:async(c="Enter")=>i(c)}}}}function $({frame:e,trigger:t,longPress:o=false}){let r=t??e.getByTestId("menu-trigger"),n=e.getByRole("menu").first(),s=M(e,n,r),{button:l,open:p,isOpen:d}=g(r),a=async(i="click")=>{if(!o)return p(i);if(i==="ArrowLeft"||i==="ArrowRight")throw new Error(`menuTester: cannot open a long-press menu with "${i}"; use "click", "Enter", "Space", "ArrowDown" or "ArrowUp"`);if(await d())return;let c=await l();if(i==="click"){await c.click({delay:800});return}await c.press(`Alt+${i}`);};return {...s,trigger:r,open:a,isOpen:d,async close(){await d()&&await r.press("Escape");},async selectItem(i){await a(),await s.item(i).click();}}}var N=(e=>{let o=ee(e);return e.multiple&&(o=te(o,e.frame)),e.autocomplete&&(o=oe(o,e.frame)),o});function ee({frame:e,trigger:t}){let o=t??e.getByTestId("select-button"),r=s=>e.getByRole("option",{name:s,exact:typeof s=="string"}),{open:n}=g(o);return {trigger:o,listbox:e.getByRole("listbox"),option:r,open:n,async selectOption(s){await n(),await r(s).click();}}}function te(e,t){return {...e,selectAllButton:t.getByTestId("select-all-button"),clearButton:t.getByTestId("select-clear-button"),tag:o=>e.trigger.getByRole("row",{name:o}),removeTagButton:o=>e.trigger.getByRole("row",{name:o}).getByRole("button")}}function oe(e,t){let o=t.getByRole("searchbox");return {...e,searchbox:o,async filter(r){await o.fill(r);}}}function re(e){return {select:((t={})=>N({frame:e,...t})),comboBox:(t={})=>D({frame:e,...t}),editor:(t={})=>P({frame:e,...t}),fileUploader:(t={})=>U({frame:e,...t}),menu:(t={})=>$({frame:e,...t}),breadcrumbs:(t={})=>v({frame:e,...t})}}exports.DEFAULT_CRITICAL_INCOMPLETE_RULES=E;exports.DEFAULT_DISABLED_RULES=O;exports.DEFAULT_WCAG_TAGS=L;exports.expect=Z;exports.testers=re;
|
package/dist/index.mjs
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {expect,test}from'@playwright/test';import
|
|
1
|
+
import {expect,test}from'@playwright/test';import j from'axe-core';import {readFile,mkdir,writeFile}from'fs/promises';import F from'path';/**
|
|
2
2
|
* Copyright (c) 2023-2024 PSPDFKit GmbH. All rights reserved.
|
|
3
3
|
*
|
|
4
4
|
* THIS SOURCE CODE AND ANY ACCOMPANYING DOCUMENTATION ARE PROTECTED BY INTERNATIONAL COPYRIGHT LAW
|
|
@@ -7,15 +7,15 @@ import {expect,test}from'@playwright/test';import W from'axe-core';import {readF
|
|
|
7
7
|
* This notice may not be removed from this file.
|
|
8
8
|
*
|
|
9
9
|
*/
|
|
10
|
-
var L=["wcag2a","wcag2aa","wcag21a","wcag21aa","best-practice"],O=["landmark-one-main","page-has-heading-one","region","aria-allowed-role","duplicate-id","scrollable-region-focusable"],E=["aria-valid-attr-value","aria-valid-attr","aria-required-attr"];function C(e,t={}){let{prefix:o="BaselineUI-",ignoreHashed:
|
|
10
|
+
var L=["wcag2a","wcag2aa","wcag21a","wcag21aa","best-practice"],O=["landmark-one-main","page-has-heading-one","region","aria-allowed-role","duplicate-id","scrollable-region-focusable"],E=["aria-valid-attr-value","aria-valid-attr","aria-required-attr"];function C(e,t={}){let{prefix:o="BaselineUI-",ignoreHashed:r=false}=t,n=Array.isArray(o)?o:[o];function s(c){return c.split(/[-_]/).some(u=>u.length>=5&&/^[a-z\d]+$/.test(u)&&/[a-z]/.test(u)&&/\d/.test(u))}function l(c){return [...c.classList].filter(u=>n.some(m=>u.startsWith(m))&&(!r||!s(u)))}function p(c,u=false){let m=[],h=c.shadowRoot?c.shadowRoot.children:c.children;for(let f of h){let b=u||f.getAttribute("aria-hidden")==="true",x=l(f),w=p(f,b);x.length>0?m.push({classes:x,children:w,hidden:b}):m.push(...w);}return m}function d(c,u="",m=false){let h=[];for(let f=0;f<c.length;f++){let b=c[f],x=f===c.length-1,w=m?"":x?"\u2514\u2500\u2500 ":"\u251C\u2500\u2500 ",_=m?"":u+(x?" ":"\u2502 "),W=b.classes.join(", ");h.push(u+w+W+(b.hidden?" [aria-hidden]":""),...d(b.children,_));}return h}let a=l(e),i=p(e);return a.length===0&&i.length===0?"":a.length>0?d([{classes:a,children:i,hidden:false}],"",true).join(`
|
|
11
11
|
`):d(i,"",true).join(`
|
|
12
|
-
`)}var
|
|
13
|
-
${
|
|
12
|
+
`)}var B=e=>{if(e instanceof Error)return e.message;if(typeof e=="string")return e;if(e==null)return "unknown error";try{return JSON.stringify(e)}catch{return "unstringifiable error"}},V=async e=>{let t=typeof e.goto=="function",o=!t&&typeof e.owner=="function";if(t||o)return e.locator("body");let r=e;return await r.first().evaluate(s=>s.tagName?.toLowerCase()==="iframe").catch(()=>false)?r.contentFrame().locator("body"):r},G=async e=>{await e.first().evaluate((t,o)=>{if(window.axe)return;let n=document.createElement("script");n.textContent=o,document.head.append(n);},j.source);},q=["document-title","html-has-lang","html-lang-valid","html-xml-lang-mismatch"],J=(e,t=[])=>{let o=new Set([...O,...t,...e.disableRules??[]]);return {runOnly:{type:"tag",values:[...e.tags??L]},rules:Object.fromEntries([...o].map(r=>[r,{enabled:false}]))}},I=e=>{if(e!==void 0)return typeof e=="string"?[e]:[...e]},K=async(e,t,o)=>{let r=await e.count();if(r===0)throw new Error("toBeAccessible: locator resolved to zero elements; nothing to scan.");await G(e);let n=I(t.include),s=I(t.exclude);return r===1?await e.evaluate(async(l,p)=>{let d=window,a={include:[l,...p.userInclude??[]],exclude:p.userExclude??[]};return await d.axe.run(a,p.runOptions)},{userInclude:n,userExclude:s,runOptions:o}):await e.evaluateAll(async(l,p)=>{let d=window,a={include:[...l,...p.userInclude??[]],exclude:p.userExclude??[]};return await d.axe.run(a,p.runOptions)},{userInclude:n,userExclude:s,runOptions:o})},A="BaselineUI-";function S(e){return e.replaceAll(/\W+/g,"-").replaceAll(/^-|-$/g,"")}function X(e){return Array.isArray(e)?e.length===1&&e[0]===A:e===A}function Q(e){return (Array.isArray(e)?e:[e]).join("+")}function Y(e,t,o,r,n){let s=t.slice(1).map(l=>S(l));return o&&s.push(S(o)),r!==void 0&&!X(r)&&s.push(S(Q(r))),n&&s.push("ignoreHashed"),F.join(e,`${s.join("--")}.txt`)}var T=(e,t)=>{if(typeof e?.callCount!="number")throw new TypeError(`${t}: expected a sinon spy.`)},Z=expect.extend({toBeWithinDelta(e,t,o){let r=Math.abs(e-t);if(Number.isNaN(r)||Number.isNaN(Number(o))||o<0)throw new TypeError(`toBeWithinDelta: cannot compare ${e} with ${t} within ${o}; expected numbers and a non-negative delta.`);return r<=o?{message:()=>`expected ${e} not to be within ${o} of ${t}`,pass:true}:{message:()=>`expected ${e} to be within ${o} of ${t}`,pass:false}},async toBeCalledOnce(e){T(e,"toBeCalledOnce");try{return await expect.poll(()=>e.callCount).toBe(1),{message:()=>"Expected function to be called once.",pass:!0}}catch(t){return {message:()=>B(t),pass:false}}},async toBeCalledTwice(e){T(e,"toBeCalledTwice");try{return await expect.poll(()=>e.callCount).toBe(2),{message:()=>"Expected function to be called twice.",pass:!0}}catch(t){return {message:()=>B(t),pass:false}}},async toBeCalledThrice(e){T(e,"toBeCalledThrice");try{return await expect.poll(()=>e.callCount).toBe(3),{message:()=>"Expected function to be called thrice.",pass:!0}}catch(t){return {message:()=>B(t),pass:false}}},async toBeCalledWith(e,...t){T(e,"toBeCalledWith");try{return await expect.poll(()=>({called:e.called,args:t.map((o,r)=>e.lastCall?.args[r])})).toStrictEqual({called:!0,args:t}),{message:()=>`Expected function to be called with ${t.join(", ")}.`,pass:!0}}catch(o){return {message:()=>B(o),pass:false}}},async toBeCalledWithExactly(e,...t){T(e,"toBeCalledWithExactly");try{return await expect.poll(()=>e.lastCall?.args).toStrictEqual(t),{message:()=>`Expected function to be called with exactly ${t.join(", ")}.`,pass:!0}}catch(o){return {message:()=>B(o),pass:false}}},toBeCalled(e){T(e,"toBeCalled");try{return expect(e.called).toBeTruthy(),{message:()=>"Expected function to be called.",pass:!0}}catch(t){return {message:()=>B(t),pass:false}}},async toBeCalledTimes(e,t){if(T(e,"toBeCalledTimes"),!Number.isInteger(t)||t<0)throw new TypeError("toBeCalledTimes: times must be a non-negative integer.");try{return await expect.poll(()=>e.callCount).toBe(t),{message:()=>`Expected function to be called ${t} times.`,pass:!0}}catch(o){return {message:()=>B(o),pass:false}}},async toBeAccessible(e,t={}){let o=await V(e),r=await o.first().evaluate(i=>{let c=i.ownerDocument?.defaultView;return c!==null&&c!==window.top}).catch(()=>false),n=J(t,r?q:[]),s,l=async()=>{let i=await K(o,t,n),c=t.treatIncompleteAsViolationIds??E,u=[...i.violations,...i.incomplete.filter(m=>c.includes(m.id))];return s={result:i,violations:u},u},p;try{if(t.timeout&&t.timeout>0){let i=expect.poll(l,{timeout:t.timeout});await(this.isNot?i.not.toHaveLength(0):i.toHaveLength(0));}else await l();}catch(i){p=i;}if(!s)throw new Error(`toBeAccessible: axe scan never completed.
|
|
13
|
+
${B(p)}`);if(s.violations.length===0)return {message:()=>"Expected accessibility violations but found none.",pass:true};this.isNot||await test.info().attach(t.attachmentName??"accessibility-scan-results",{body:JSON.stringify(s.result,null,2),contentType:"application/json"});let d=s.violations.map(i=>{let c=i.nodes.map(u=>Array.isArray(u.target)?u.target.join(" "):String(u.target)).join(`
|
|
14
14
|
`);return ` \u2022 [${i.id}] ${i.help}
|
|
15
15
|
${c}
|
|
16
16
|
${i.helpUrl??""}`}).join(`
|
|
17
|
-
`),a=
|
|
18
|
-
${d}`,pass:false}},async toMatchClassTree(e,t,o={}){let{prefix:
|
|
19
|
-
`,
|
|
17
|
+
`),a=s.violations.length;return {message:()=>`Found ${a} accessibility violation${a===1?"":"s"}:
|
|
18
|
+
${d}`,pass:false}},async toMatchClassTree(e,t,o={}){let{prefix:r=A,ignoreHashed:n=false}=o,s=await e.evaluate(C,{prefix:r,ignoreHashed:n});if(!s){let u=Array.isArray(r)?r.map(m=>`${m}*`).join(" / "):`${r}*`;throw new Error(`No ${u} classes found in the DOM tree.`)}let l=`${s}
|
|
19
|
+
`,p=test.info();if(p.config.ignoreSnapshots)return {message:()=>"Class tree snapshot check skipped.",pass:true};let a=Y(p.project.snapshotDir,p.titlePath,t,r,n),i=p.config.updateSnapshots,c;try{c=await readFile(a,"utf8");}catch(u){let m=u.code;if(m==="ENOENT"&&this.isNot)return {message:()=>`A class tree snapshot doesn't exist at ${a}, matchers using ".not" won't write them automatically.`,pass:true};if(m==="ENOENT"&&i!=="none")return await mkdir(F.dirname(a),{recursive:true}),await writeFile(a,l),i==="missing"?{message:()=>`A class tree snapshot doesn't exist at ${a}, writing actual.`,pass:false,shouldNotRetryTest:true}:{message:()=>"Class tree snapshot created.",pass:true};throw u}if(c!==l){if(!this.isNot&&(i==="all"||i==="changed"))return await writeFile(a,l),{message:()=>"Class tree snapshot updated.",pass:true};try{expect(l).toBe(c);}catch(u){return {message:()=>`Class tree snapshot mismatch at ${a}
|
|
20
20
|
|
|
21
|
-
${
|
|
21
|
+
${u.message}`,pass:false}}}return {message:()=>"Class tree matched snapshot.",pass:true}}});function v({frame:e,name:t}){let o=e.locator(".BaselineUI-Breadcrumbs"),r=t===void 0?o:o.and(e.getByRole("navigation",{name:t,exact:typeof t=="string"}));return {root:r,current:r.locator('[aria-current="page"]'),separators:r.getByTestId("breadcrumbs-separator"),item:n=>r.getByRole("link",{name:n,exact:typeof n=="string"})}}function g(e){let t=async()=>{if(await e.getAttribute("aria-expanded")!==null)return e;let n=e.locator("[aria-expanded]").first();return await n.count()>0?n:e},o=async()=>await(await t()).getAttribute("aria-expanded")==="true";return {button:t,isOpen:o,open:async(n="click")=>{if(await o())return;if(n==="click"){await e.click();return}await(await t()).press(n);}}}function D({frame:e,trigger:t,toggleButton:o}){let r=t??e.getByRole("combobox",{includeHidden:true}),n=o??e.getByTestId("combobox-toggle-button"),s=a=>e.getByRole("option",{name:a,exact:typeof a=="string"}),{isOpen:l,open:p}=g(r),d=async(a="click")=>{if(!await l()){if(a==="click"){await n.click();return}await p(a);}};return {input:r,toggleButton:n,listbox:e.getByRole("listbox"),option:s,isOpen:l,open:d,async selectOption(a){await d(),await s(a).click();},async filter(a){await r.fill(a);}}}function P({frame:e,root:t}){let o=t??e.locator(".BaselineUI-Editor"),r=o.getByTestId("editor-font-color-button"),n=o.getByTestId("editor-background-color-button"),s=o.getByTestId("editor-add-link-button"),l=o.getByTestId("editor-help-button"),p=o.getByTestId("editor-mention-button"),d=o.getByRole("combobox"),a=e.getByTestId("editor-mention-listbox"),i=e.getByTestId("editor-help-dialog-close-button"),c=e.getByRole("dialog").filter({has:i}),u=e.getByRole("dialog").filter({has:e.getByTestId(/^editor-link-/)});return {root:o,textbox:o.getByRole("textbox"),placeholder:o.getByTestId("editor-placeholder"),toolbar:o.getByRole("toolbar"),boldButton:o.getByTestId("editor-bold-button"),italicButton:o.getByTestId("editor-italic-button"),underlineButton:o.getByTestId("editor-underline-button"),fontColorButton:r,backgroundColorButton:n,openFontColorPicker:g(r).open,openBackgroundColorPicker:g(n).open,addLinkButton:s,linkDialog:u,linkInput:e.getByTestId("editor-link-input"),linkAddButton:e.getByTestId("editor-link-add-button"),linkEditButton:e.getByTestId("editor-link-edit-button"),linkRemoveButton:e.getByTestId("editor-link-remove-button"),linkCancelButton:e.getByTestId("editor-link-cancel-button"),linkSaveButton:e.getByTestId("editor-link-save-button"),openLinkDialog:g(s).open,saveButton:o.getByTestId("editor-save-button"),cancelButton:o.getByTestId("editor-cancel-button"),mentionButton:p,helpButton:l,helpDialog:c,helpDialogCloseButton:i,async openHelpDialog(){await c.isVisible()||await l.click();},mentionInput:d,mentionListbox:a,mentionOption:m=>a.getByRole("option",{name:m}),async startMention(){await d.isVisible()||await p.click();}}}function U({frame:e,trigger:t,variant:o="dropzone"}){let r=e.getByTestId("file-uploader"),n=r.locator('input[type="file"]'),s=t??(o==="button"?r.getByRole("button"):e.getByTestId("file-uploader-dropzone"));return {root:r,button:s,input:n,dropzone:e.getByTestId("file-uploader-dropzone"),errorMessage:r.getByRole("alert"),async upload(l){await n.setInputFiles(l);}}}function M(e,t,o){let r=l=>t.getByRole("menuitem",{name:l}).or(t.getByRole("menuitemradio",{name:l})).or(t.getByRole("menuitemcheckbox",{name:l})),n=l=>t.getByRole("group",{name:l}),{isOpen:s}=g(o);return {menu:t,item:r,section:n,isOpen:s,submenu(l){let p=r(l),d=e.getByRole("menu",{name:l}),a=M(e,d,p),{open:i}=g(p);return {...a,trigger:p,open:async(c="Enter")=>i(c)}}}}function $({frame:e,trigger:t,longPress:o=false}){let r=t??e.getByTestId("menu-trigger"),n=e.getByRole("menu").first(),s=M(e,n,r),{button:l,open:p,isOpen:d}=g(r),a=async(i="click")=>{if(!o)return p(i);if(i==="ArrowLeft"||i==="ArrowRight")throw new Error(`menuTester: cannot open a long-press menu with "${i}"; use "click", "Enter", "Space", "ArrowDown" or "ArrowUp"`);if(await d())return;let c=await l();if(i==="click"){await c.click({delay:800});return}await c.press(`Alt+${i}`);};return {...s,trigger:r,open:a,isOpen:d,async close(){await d()&&await r.press("Escape");},async selectItem(i){await a(),await s.item(i).click();}}}var N=(e=>{let o=ee(e);return e.multiple&&(o=te(o,e.frame)),e.autocomplete&&(o=oe(o,e.frame)),o});function ee({frame:e,trigger:t}){let o=t??e.getByTestId("select-button"),r=s=>e.getByRole("option",{name:s,exact:typeof s=="string"}),{open:n}=g(o);return {trigger:o,listbox:e.getByRole("listbox"),option:r,open:n,async selectOption(s){await n(),await r(s).click();}}}function te(e,t){return {...e,selectAllButton:t.getByTestId("select-all-button"),clearButton:t.getByTestId("select-clear-button"),tag:o=>e.trigger.getByRole("row",{name:o}),removeTagButton:o=>e.trigger.getByRole("row",{name:o}).getByRole("button")}}function oe(e,t){let o=t.getByRole("searchbox");return {...e,searchbox:o,async filter(r){await o.fill(r);}}}function re(e){return {select:((t={})=>N({frame:e,...t})),comboBox:(t={})=>D({frame:e,...t}),editor:(t={})=>P({frame:e,...t}),fileUploader:(t={})=>U({frame:e,...t}),menu:(t={})=>$({frame:e,...t}),breadcrumbs:(t={})=>v({frame:e,...t})}}export{E as DEFAULT_CRITICAL_INCOMPLETE_RULES,O as DEFAULT_DISABLED_RULES,L as DEFAULT_WCAG_TAGS,Z as expect,re as testers};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@baseline-ui/test-utils",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.7.0",
|
|
4
4
|
"description": "A collection of test utilities for Baseline UI",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"module": "dist/index.mjs",
|
|
@@ -52,7 +52,7 @@
|
|
|
52
52
|
"dependencies": {
|
|
53
53
|
"axe-core": "^4.11.4",
|
|
54
54
|
"react-frame-component": "^5.3.2",
|
|
55
|
-
"@baseline-ui/core": "3.
|
|
55
|
+
"@baseline-ui/core": "3.7.0"
|
|
56
56
|
},
|
|
57
57
|
"scripts": {
|
|
58
58
|
"build": "tsup",
|
package/sbom.json
CHANGED
|
@@ -2,10 +2,10 @@
|
|
|
2
2
|
"$schema": "http://cyclonedx.org/schema/bom-1.6.schema.json",
|
|
3
3
|
"bomFormat": "CycloneDX",
|
|
4
4
|
"specVersion": "1.6",
|
|
5
|
-
"serialNumber": "urn:uuid:
|
|
5
|
+
"serialNumber": "urn:uuid:af24b70e-d501-463f-9d2c-c1ddfbfd9082",
|
|
6
6
|
"version": 1,
|
|
7
7
|
"metadata": {
|
|
8
|
-
"timestamp": "2026-10-
|
|
8
|
+
"timestamp": "2026-10-23T17:52:32.929Z",
|
|
9
9
|
"lifecycles": [
|
|
10
10
|
{
|
|
11
11
|
"phase": "pre-build"
|
|
@@ -23,9 +23,9 @@
|
|
|
23
23
|
"component": {
|
|
24
24
|
"type": "library",
|
|
25
25
|
"name": "@baseline-ui/test-utils",
|
|
26
|
-
"version": "3.
|
|
27
|
-
"purl": "pkg:npm/@baseline-ui/test-utils@3.
|
|
28
|
-
"bom-ref": "pkg:npm/@baseline-ui/test-utils@3.
|
|
26
|
+
"version": "3.7.0",
|
|
27
|
+
"purl": "pkg:npm/@baseline-ui/test-utils@3.7.0",
|
|
28
|
+
"bom-ref": "pkg:npm/@baseline-ui/test-utils@3.7.0",
|
|
29
29
|
"licenses": [
|
|
30
30
|
{
|
|
31
31
|
"license": {
|
|
@@ -500,7 +500,7 @@
|
|
|
500
500
|
],
|
|
501
501
|
"dependencies": [
|
|
502
502
|
{
|
|
503
|
-
"ref": "pkg:npm/@baseline-ui/test-utils@3.
|
|
503
|
+
"ref": "pkg:npm/@baseline-ui/test-utils@3.7.0",
|
|
504
504
|
"dependsOn": [
|
|
505
505
|
"pkg:npm/%40neondatabase/serverless@1.1.0",
|
|
506
506
|
"pkg:npm/%40playwright/test@1.62.1",
|