Skip to content

feat(axe.d.ts): add nodeSerializer typings #4551

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 24, 2024
Merged

feat(axe.d.ts): add nodeSerializer typings #4551

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
629f1d5
feat(axe.d.ts): add nodeSerializer API
hamax Aug 1, 2024
dc44cdb
make CustomNodeSerializer a generic type
hamax Aug 14, 2024
8fba603
Merge branch 'develop' into node-serializer
dbjorge Sep 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 23 additions & 4 deletions axe.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,6 +342,9 @@ declare namespace axe {
interface DqElement extends SerialDqElement {
element: Element;
toJSON(): SerialDqElement;
}
interface DqElementConstructor {
new (elm: Element, options?: { absolutePaths?: boolean }): DqElement;
mergeSpecs(
childSpec: SerialDqElement,
parentSpec: SerialDqElement
Expand Down Expand Up @@ -405,6 +408,24 @@ declare namespace axe {
boundingClientRect: DOMRect;
}

interface CustomNodeSerializer<T = SerialDqElement> {
toSpec: (dqElm: DqElement) => T;
mergeSpecs: (nodeSpec: T, parentFrameSpec: T) => T;
}

interface NodeSerializer {
update: <T>(serializer: CustomNodeSerializer<T>) => void;
toSpec: (node: Element | VirtualNode) => SerialDqElement;
dqElmToSpec: (
dqElm: DqElement | SerialDqElement,
options?: RunOptions
) => SerialDqElement;
mergeSpecs: (
nodeSpec: SerialDqElement,
parentFrameSpec: SerialDqElement
) => SerialDqElement;
}

interface Utils {
getFrameContexts: (
context?: ElementContext,
Expand All @@ -423,15 +444,13 @@ declare namespace axe {
selector: unknown
) => selector is LabelledShadowDomSelector;

DqElement: new (
elm: Element,
options?: { absolutePaths?: boolean }
) => DqElement;
DqElement: DqElementConstructor;
uuid: (
options?: { random?: Uint8Array | Array<number> },
buf?: Uint8Array | Array<number>,
offset?: number
) => string | Uint8Array | Array<number>;
nodeSerializer: NodeSerializer;
}

interface Aria {
Expand Down
13 changes: 13 additions & 0 deletions typings/axe-core/axe-core-tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -450,6 +450,19 @@ if (axe.utils.isLabelledShadowDomSelector(unknownContext)) {
} else if (axe.utils.isContextSpec(unknownContext)) {
let context: axe.ContextSpec = unknownContext;
}
axe.utils.nodeSerializer.update({
toSpec(dqElm: axe.DqElement) {
return dqElm.toJSON();
},
mergeSpecs(childSpec: axe.SerialDqElement, parentSpec: axe.SerialDqElement) {
return axe.utils.DqElement.mergeSpecs(childSpec, parentSpec);
}
});
const spec2: axe.SerialDqElement = axe.utils.nodeSerializer.toSpec(element);
const spec3: axe.SerialDqElement = axe.utils.nodeSerializer.dqElmToSpec(
dqElement,
options
);

// Commons
axe.commons.aria.getRoleType('img');
Expand Down
Loading