authentik/web/e2e/fixtures/PointerFixture.ts

import { PageFixture } from "#e2e/fixtures/PageFixture";
import type { LocatorContext } from "#e2e/selectors/types";

import { Page } from "@playwright/test";

export type GetByRoleParameters = Parameters<Page["getByRole"]>;
export type ARIARole = GetByRoleParameters[0];
export type ARIAOptions = GetByRoleParameters[1];

export type ClickByName = (name: string) => Promise<void>;
export type ClickByRole = (
    role: ARIARole,
    options?: ARIAOptions,
    context?: LocatorContext,
) => Promise<void>;

export class PointerFixture extends PageFixture {
    public static fixtureName = "Pointer";

    /**
     * A high-level click function that simplifies clicking on buttons and links.
     */
    public click = (
        name: string | RegExp,
        optionsOrRole?: ARIAOptions | ARIARole,
        context: LocatorContext = this.page,
    ): Promise<void> => {
        if (typeof optionsOrRole === "string") {
            return context.getByRole(optionsOrRole, { name }).first().click();
        }

        const options = {
            exact: typeof name === "string",
            ...optionsOrRole,
            name,
        };

        return (
            context
                // ---
                .getByRole("button", options)
                .or(context.getByRole("link", options))
                .click()
        );
    };
}