twd-js 1.1.2 → 1.2.0

package/dist/commands/url.d.ts

@@ -1,33 +0,0 @@
-/**
- * All supported assertion names for the `should` function in url command
- *
- * @example
- * twd.url().should("contain.url", "/new-page");
- * twd.url().should("eq", "http://localhost:3000/new-page");
- */
-export type URLAssertionName = "eq" | "contain.url";
-/**
- * Negatable assertion names (e.g., 'not.have.text').
- */
-export type Negatable<T extends string> = T | `not.${T}`;
-/**
- * All assertion names, including negated ones.
- */
-export type AnyURLAssertion = Negatable<URLAssertionName>;
-export type URLCommandAPI = {
-    location: Location;
-    should: (name: AnyURLAssertion, value: string) => URLCommandAPI | string;
-};
-/**
- * Argument types for each assertion.
- */
-export type URLAssertionArgs = {
-    (name: "contain.url", urlPart: string): URLCommandAPI;
-    (name: "not.contain.url", urlPart: string): URLCommandAPI;
-};
-/**
- * URL command for assertions on the current URL.
- * @returns URLCommandAPI
- */
-declare const urlCommand: () => URLCommandAPI;
-export default urlCommand;

package/dist/commands/visit.d.ts

@@ -1 +0,0 @@
-export declare const visit: (url: string, reload?: boolean) => Promise<void>;

package/dist/constants/version.d.ts

@@ -1 +0,0 @@
-export declare const TWD_VERSION = "1.1.2";

package/dist/global.d.ts

@@ -1,8 +0,0 @@
-// global.d.ts
-export {};
-
-declare global {
-  interface Window {
-    __testRunner?: TestRunner;
-  }
-}

package/dist/initializers/initSidebar.d.ts

@@ -1,22 +0,0 @@
-interface Options {
-    Component: React.ReactNode;
-    createRoot: (el: HTMLElement) => {
-        render: (el: React.ReactNode) => void;
-    };
-}
-/**
- * Initialize the TWD sidebar.
- * @param options - Options for initializing the sidebar.
- * @example
- * ```ts
- * import { initSidebar } from 'twd-js';
- *
- * // Initialize the sidebar (e.g., in your main app file)
- * initSidebar({
- *   Component: <TWDSidebar open={true} position="left" />,
- *   createRoot,
- * });
- * ```
- */
-export declare const initSidebar: (options: Options) => void;
-export {};

package/dist/initializers/initTests.d.ts

@@ -1,31 +0,0 @@
-/**
- * A record of test module paths to their loader functions.
- * Each function returns a promise that resolves when the module is loaded.
- * This is typically used with Vite's `import.meta.glob` to dynamically import test modules.
- * @example
- * ```ts
- * const testModules = {
- *   './test1.twd.test.ts': () => import('./test1.twd.test.ts'),
- *   './test2.twd.test.ts': () => import('./test2.twd.test.ts'),
- * };
- * ```
- */
-type TestModule = Record<string, () => Promise<unknown>>;
-/**
- * Initialize Vite test loading.
- * @param testModules - The test modules to load.
- * @param component - The React component to render the sidebar.
- * @param createRoot - Function to create a React root.
- * @example
- * ```ts
- * if (import.meta.env.DEV) {
- *   const testModules = import.meta.glob("./example.twd.test.ts");
- *   const { initTests, TWDSidebar } = await import('twd-js');
- *   await initTests(testModules, <TWDSidebar open={true} position="left" />, createRoot);
- * }
- * ```
- */
-export declare const initTests: (testModules: TestModule, Component: React.ReactNode, createRoot: (el: HTMLElement) => {
-    render: (el: React.ReactNode) => void;
-}) => Promise<void>;
-export {};

package/dist/plugin/removeMockServiceWorker.d.ts

@@ -1,18 +0,0 @@
-import { Plugin } from 'vite';
-/**
- * Vite plugin to remove the mock service worker file from the build output.
- * This is useful for production builds where you don't want the mock service worker to be included.
- *
- * @example
- * ```ts
- * import { removeMockServiceWorker } from 'twd-js';
- *
- * export default defineConfig({
- *   plugins: [
- *     // ... other plugins
- *     removeMockServiceWorker()
- *   ]
- * });
- * ```
- */
-export declare function removeMockServiceWorker(): Plugin;

package/dist/proxies/domMessage.d.ts

@@ -1 +0,0 @@
-export declare function domMessage(prefix: string, prop: PropertyKey, args: any[]): string;

package/dist/proxies/eventsMessage.d.ts

@@ -1 +0,0 @@
-export declare function eventsMessage(prefix: string, prop: PropertyKey, args: any[]): string;

package/dist/proxies/screenDom.d.ts

@@ -1,5 +0,0 @@
-import { screen, configure } from '@testing-library/dom';
-type ScreenDom = typeof screen;
-export declare const screenDom: ScreenDom;
-export declare const configureScreenDom: typeof configure;
-export {};

package/dist/proxies/userEvent.d.ts

@@ -1,4 +0,0 @@
-import { default as userEventLib } from '@testing-library/user-event';
-type UserEvent = typeof userEventLib;
-export declare const userEvent: UserEvent;
-export {};

package/dist/twd-types.d.ts

@@ -1,106 +0,0 @@
-/**
- * Types and interfaces for the TWD testing library.
- *
- * @module twd-types
- */
-/**
- * All supported assertion names for the `should` function.
- *
- * @example
- * api.should("have.text", "Hello");
- * api.should("be.empty");
- */
-export type AssertionName = "have.text" | "contain.text" | "be.empty" | "have.attr" | "have.value" | "be.disabled" | "be.enabled" | "be.checked" | "be.selected" | "be.focused" | "be.visible" | "have.class";
-/**
- * Negatable assertion names (e.g., 'not.have.text').
- */
-export type Negatable<T extends string> = T | `not.${T}`;
-/**
- * All assertion names, including negated ones.
- */
-export type AnyAssertion = Negatable<AssertionName>;
-/**
- * Argument types for each assertion.
- */
-export type AssertionArgs = {
-    "have.text": [expected: string];
-    "contain.text": [expected: string];
-    "be.empty": [];
-    "have.attr": [attr: string, value: string];
-    "have.value": [value: string];
-    "be.disabled": [];
-    "be.enabled": [];
-    "be.checked": [];
-    "be.selected": [];
-    "be.focused": [];
-    "be.visible": [];
-    "have.class": [className: string];
-};
-/**
- * Maps assertion name to its argument tuple.
- */
-export type ArgsFor<A extends AnyAssertion> = A extends `not.${infer Base extends AssertionName}` ? AssertionArgs[Base] : A extends AssertionName ? AssertionArgs[A] : never;
-/**
- * Overloads for the `should` function, for best IntelliSense.
- *
- * @example
- * twd.should("have.text", "Hello");
- * twd.should("be.empty");
- * twd.should("have.class", "active");
- */
-export type ShouldFn = {
-    (name: "have.text", expected: string): TWDElemAPI;
-    (name: "not.have.text", expected: string): TWDElemAPI;
-    (name: "contain.text", expected: string): TWDElemAPI;
-    (name: "not.contain.text", expected: string): TWDElemAPI;
-    (name: "be.empty"): TWDElemAPI;
-    (name: "not.be.empty"): TWDElemAPI;
-    (name: "have.attr", attr: string, value: string): TWDElemAPI;
-    (name: "not.have.attr", attr: string, value: string): TWDElemAPI;
-    (name: "have.value", value: string): TWDElemAPI;
-    (name: "not.have.value", value: string): TWDElemAPI;
-    (name: "be.disabled"): TWDElemAPI;
-    (name: "not.be.disabled"): TWDElemAPI;
-    (name: "be.enabled"): TWDElemAPI;
-    (name: "not.be.enabled"): TWDElemAPI;
-    (name: "be.checked"): TWDElemAPI;
-    (name: "not.be.checked"): TWDElemAPI;
-    (name: "be.selected"): TWDElemAPI;
-    (name: "not.be.selected"): TWDElemAPI;
-    (name: "be.focused"): TWDElemAPI;
-    (name: "not.be.focused"): TWDElemAPI;
-    (name: "be.visible"): TWDElemAPI;
-    (name: "not.be.visible"): TWDElemAPI;
-    (name: "have.class", className: string): TWDElemAPI;
-    (name: "not.have.class", className: string): TWDElemAPI;
-};
-/**
- * The main API returned by `twd.get()`.
- *
- * @example
- * ```ts
- * const btn = await twd.get("button");
- * btn.should("have.text", "Clicked").click();
- *
- * ```
- *
- */
-export interface TWDElemAPI {
-    /** The underlying DOM element. */
-    el: Element;
-    /**
-     * Asserts something about the element.
-     * @param name The name of the assertion.
-     * @param args Arguments for the assertion.
-     * @returns The same API for chaining.
-     *
-     * @example
-     * ```ts
-     * const btn = await twd.get("button");
-     * btn.should("have.text", "Click me").should("not.be.disabled");
-     *
-     * ```
-     *
-     */
-    should: ShouldFn;
-}

package/dist/twd.d.ts

@@ -1,178 +0,0 @@
-import { Options, Rule } from './commands/mockBridge';
-import { AnyAssertion, ArgsFor, TWDElemAPI } from './twd-types';
-import { URLCommandAPI } from './commands/url';
-interface TWDAPI {
-    /**
-     * Finds an element by selector and returns the TWD API for it.
-     * @param selector CSS selector
-     * @returns {Promise<TWDElemAPI>} The TWD API for the element
-     *
-     * @example
-     * ```ts
-     * const btn = await twd.get("button");
-     *
-     * ```
-     *
-     */
-    get: (selector: string) => Promise<TWDElemAPI>;
-    /**
-     * Sets the value of an input element and dispatches an input event. We recommend using this only for range, color, time inputs.
-     * @param el The input element
-     * @param value The value to set
-     *
-     * @example
-     * ```ts
-     * const input = await twd.get("input[type='time']");
-     * twd.setInputValue(input.el, "13:30");
-     *
-     * ```
-     */
-    setInputValue: (el: Element, value: string) => void;
-    /**
-     * Finds multiple elements by selector and returns an array of TWD APIs for them.
-     * @param selector CSS selector
-     * @returns {Promise<TWDElemAPI[]>} Array of TWD APIs for the elements
-     *
-     * @example
-     * ```ts
-     * const items = await twd.getAll(".item");
-     * items.at(0).should("be.visible");
-     * items.at(1).should("contain.text", "Hello");
-     * expect(items).to.have.length(3);
-     * ```
-     */
-    getAll: (selector: string) => Promise<TWDElemAPI[]>;
-    /**
-     * Simulates visiting a URL (SPA navigation).
-     * @param url The URL to visit
-     * @param [reload] Whether to force a reload even if already on the URL (optional)
-     *
-     * @example
-     * ```ts
-     * twd.visit("/contact");
-     * // visit with reload
-     * twd.visit("/contact", true);
-     * ```
-     */
-    visit: (url: string, reload?: boolean) => Promise<void>;
-    /**
-     * Mock a network request.
-     *
-     * @param alias Identifier for the mock rule. Useful for `waitFor()`.
-     * @param options Options to configure the mock:
-     *  - `method`: HTTP method ("GET", "POST", …)
-     *  - `url`: URL string or RegExp to match
-     *  - `response`: Body of the mocked response
-     *  - `status`: (optional) HTTP status code (default: 200)
-     *  - `headers`: (optional) Response headers
-     *
-     * @example
-     * ```ts
-     * mockRequest("getUser", {
-     *   method: "GET",
-     *   url: /\/api\/user\/\d+/,
-     *   response: { id: 1, name: "Kevin" },
-     *   status: 200,
-     *   headers: { "x-mock": "true" }
-     * });
-     * ```
-     */
-    mockRequest: (alias: string, options: Options) => Promise<void>;
-    /**
-     * Wait for a mocked request to be made.
-     * @param alias The alias of the mock rule to wait for
-     * @return The matched rule (with body if applicable)
-     *
-     * @example
-     * ```ts
-     * const rule = await twd.waitFor("aliasId");
-     * console.log(rule.body);
-     *
-     * ```
-     */
-    waitForRequest: (alias: string) => Promise<Rule>;
-    /**
-     * wait for a list of mocked requests to be made.
-     * @param aliases The aliases of the mock rules to wait for
-     * @returns The matched rules (with body if applicable)
-     * @example
-     * ```ts
-     * const rules = await waitForRequests(["getUser", "postComment"]);
-     * ```
-     */
-    waitForRequests: (aliases: string[]) => Promise<Rule[]>;
-    /**
-     * URL-related assertions.
-     *
-     * @example
-     * ```ts
-     * twd.url().should("eq", "http://localhost:3000/contact");
-     * twd.url().should("contain.url", "/contact");
-     *
-     * ```
-     */
-    url: () => URLCommandAPI;
-    /**
-     * Initializes request mocking (registers the service worker).
-     * Must be called before using `twd.mockRequest()`.
-     *
-     * @example
-     * ```ts
-     * await twd.initRequestMocking();
-     *
-     * ```
-     */
-    initRequestMocking: () => Promise<void>;
-    /**
-     * Clears all request mock rules.
-     *
-     * @example
-     * ```ts
-     * twd.clearRequestMockRules();
-     *
-     * ```
-     */
-    clearRequestMockRules: () => void;
-    /**
-     * Gets all current request mock rules.
-     *
-     * @example
-     * ```ts
-     * const rules = twd.getRequestMockRules();
-     * console.log(rules);
-     * ```
-     */
-    getRequestMockRules: () => Rule[];
-    /**
-     * Waits for a specified time.
-     * @param time Time in milliseconds to wait
-     * @returns A promise that resolves after the specified time
-     * @example
-     * ```ts
-     * await twd.wait(500); // wait for 500ms
-     * ```
-     */
-    wait: (time: number) => Promise<void>;
-    /**
-     * Asserts something about the element.
-     * @param el The element to assert on
-     * @param name The name of the assertion.
-     * @param args Arguments for the assertion.
-     * @returns The same API for chaining.
-     * @example
-     * ```ts
-     * const button = await twd.get("button");
-     * const text = screenDom.getByText("Hello");
-     * twd.should(button.el, "have.text", "Hello");
-     * twd.should(text, "be.empty");
-     * twd.should(button.el, "have.class", "active");
-     * ```
-     */
-    should: (el: Element, name: AnyAssertion, ...args: ArgsFor<AnyAssertion>) => void;
-}
-/**
- * Mini Cypress-style helpers for DOM testing.
- * @namespace twd
- */
-export declare const twd: TWDAPI;
-export {};

package/dist/ui/ClosedSidebar.d.ts

@@ -1,6 +0,0 @@
-interface ClosedSidebarProps {
-    setOpen: (open: boolean) => void;
-    position: "left" | "right";
-}
-export declare const ClosedSidebar: ({ setOpen, position }: ClosedSidebarProps) => import("react/jsx-runtime").JSX.Element;
-export {};

package/dist/ui/Icons/BaseIcon.d.ts

@@ -1,7 +0,0 @@
-interface BaseIconProps {
-    className: string;
-    children: React.ReactNode;
-    dataTestId: string;
-}
-declare const BaseIcon: ({ className, children, dataTestId }: BaseIconProps) => import("react/jsx-runtime").JSX.Element;
-export default BaseIcon;

package/dist/ui/Icons/ChevronDown.d.ts

@@ -1,2 +0,0 @@
-declare const ChevronDown: () => import("react/jsx-runtime").JSX.Element;
-export default ChevronDown;

package/dist/ui/Icons/ChevronRight.d.ts

@@ -1,2 +0,0 @@
-declare const ChevronRight: () => import("react/jsx-runtime").JSX.Element;
-export default ChevronRight;

package/dist/ui/Icons/Loader.d.ts

@@ -1,2 +0,0 @@
-declare const Loader: () => import("react/jsx-runtime").JSX.Element;
-export default Loader;

package/dist/ui/Icons/MockRequestIcon.d.ts

@@ -1,2 +0,0 @@
-declare const MockRequestIcon: () => import("react/jsx-runtime").JSX.Element;
-export default MockRequestIcon;

package/dist/ui/Icons/Play.d.ts

@@ -1,2 +0,0 @@
-declare const Play: () => import("react/jsx-runtime").JSX.Element;
-export default Play;

package/dist/ui/MockRulesButton.d.ts

@@ -1 +0,0 @@
-export declare const MockRulesButton: () => import("react/jsx-runtime").JSX.Element;

package/dist/ui/TWDSidebar.d.ts

@@ -1,16 +0,0 @@
-interface TWDSidebarProps {
-    /**
-     * Whether the sidebar is open by default
-     */
-    open: boolean;
-    /**
-     * Sidebar position
-     * - left: Sidebar on the left side (default)
-     * - right: Sidebar on the right side
-     *
-     * @default "left"
-     */
-    position?: "left" | "right";
-}
-export declare const TWDSidebar: ({ open, position }: TWDSidebarProps) => import("react/jsx-runtime").JSX.Element;
-export {};

package/dist/ui/TestList.d.ts

@@ -1,17 +0,0 @@
-interface Test {
-    name: string;
-    depth: number;
-    status?: "idle" | "pass" | "fail" | "skip" | "running";
-    logs?: string[];
-    parent?: string;
-    id: string;
-    type: "test" | "suite";
-    only?: boolean;
-    skip?: boolean;
-}
-interface TestListProps {
-    runTest: (id: string) => Promise<void>;
-    tests: Test[];
-}
-export declare const TestList: ({ tests, runTest }: TestListProps) => import("react/jsx-runtime").JSX.Element;
-export {};

package/dist/ui/TestListItem.d.ts

@@ -1,39 +0,0 @@
-interface Test {
-    name: string;
-    depth: number;
-    status?: "idle" | "pass" | "fail" | "skip" | "running";
-    logs?: string[];
-    id: string;
-    parent?: string;
-    type: "test" | "suite";
-    only?: boolean;
-    skip?: boolean;
-}
-interface TestListItemProps {
-    node: Test;
-    depth: number;
-    id: string;
-    runTest: (i: string) => void;
-}
-export declare const statusStyles: (node: Test) => {
-    item: {
-        background: string;
-    };
-    container: {
-        borderLeft: string;
-    };
-} | {
-    item: {
-        background: string;
-    };
-    container?: undefined;
-};
-export declare const assertStyles: (text: string) => {
-    color: string;
-    fontWeight: string;
-} | {
-    color?: undefined;
-    fontWeight?: undefined;
-};
-export declare const TestListItem: ({ node, depth, id, runTest, }: TestListItemProps) => import("react/jsx-runtime").JSX.Element;
-export {};

package/dist/ui/buildTreeFromHandlers.d.ts

@@ -1,14 +0,0 @@
-interface Test {
-    name: string;
-    depth: number;
-    status?: "idle" | "pass" | "fail" | "skip" | "running";
-    logs?: string[];
-    id: string;
-    parent?: string;
-    type: "test" | "suite";
-}
-export type Node = Test & {
-    childrenNodes?: Node[];
-};
-export declare const buildTreeFromHandlers: (handlers: Test[]) => Node[];
-export {};

package/dist/ui/hooks/useLayout.d.ts

@@ -1,6 +0,0 @@
-interface UseLayoutProps {
-    isOpen: boolean;
-    position: "left" | "right";
-}
-export declare const useLayout: ({ isOpen, position }: UseLayoutProps) => void;
-export {};

package/dist/utils/assertionMessage.d.ts

@@ -1 +0,0 @@
-export declare const assertionMessage: (valid: boolean, isNegated: boolean, correctMessage: string, errorMessage: string) => string;

package/dist/utils/log.d.ts

@@ -1 +0,0 @@
-export declare const log: (msg: string) => void;

package/dist/utils/wait.d.ts

@@ -1,3 +0,0 @@
-export declare const waitForElement: (selector: string, fn: () => HTMLElement | null, timeout?: number, interval?: number) => Promise<HTMLElement>;
-export declare const waitForElements: (selector: string, fn: () => NodeListOf<Element> | null, timeout?: number, interval?: number) => Promise<Element[]>;
-export declare const wait: (time: number) => Promise<void>;