@vickbk/tests 0.0.0-stage → 0.2.0

package/dist/index-CKsosUpb.d.mts

@@ -0,0 +1,249 @@
+import { fireEvent } from "@testing-library/react";
+//#region src/features/vitest/modules/dom/modules/toggle-event/utils/types.d.ts
+/**
+ * Possible states for a disclosure or popover toggle transition.
+ *
+ * @example
+ * ```ts
+ * const nextState: ToggleState = "open";
+ * ```
+ */
+type ToggleState = "open" | "closed";
+/**
+ * The previous and next states dispatched by the toggle-event polyfill.
+ *
+ * @example
+ * ```ts
+ * const transition: ToggleConfig = { oldState: "closed", newState: "open" };
+ * ```
+ */
+type ToggleConfig = Record<"oldState" | "newState", ToggleState>;
+/**
+ * Internal shape added to Testing Library's `fireEvent` by its type augmentation.
+ *
+ * @example
+ * ```ts
+ * installToggleEvent();
+ * fireEvent.toggle(document.body, { newState: "open" });
+ * ```
+ */
+type ToggleFireEventExtensions = {
+  toggle: (element: Document | Element | Window | Node, initDict?: Partial<ToggleConfig>) => boolean;
+};
+//#endregion
+//#region src/features/vitest/modules/dom/modules/toggle-event/utils/fireEvent.d.ts
+/**
+ * Testing Library's fireEvent API with an additional `toggle` event helper.
+ *
+ * The exported object copies the standard `fireEvent` properties and adds
+ * `toggle`, which dispatches the toggle event through `togglePolyfill`.
+ * It does not install the extension onto Testing Library's original export.
+ *
+ * Standard Testing Library event helpers remain available, including
+ * `click`, `change`, `input`, `submit`, `focus`, and keyboard/mouse events.
+ *
+ * @remarks
+ * The `toggle` helper defaults to a transition from `closed` to `open`.
+ * Call-specific configuration overrides those defaults. This helper does
+ * not maintain state between calls.
+ *
+ * @example
+ * ```ts
+ * import { fireEvent } from "@vickbk/tests/vitest";
+ *
+ * const disclosure = document.querySelector("details")!;
+ *
+ * fireEvent.toggle(disclosure);
+ * fireEvent.toggle(disclosure, { newState: "closed" });
+ * ```
+ *
+ * @example
+ * ```ts
+ * import { fireEvent } from "@vickbk/tests/vitest";
+ *
+ * const button = document.querySelector("button")!;
+ *
+ * fireEvent.click(button);
+ * ```
+ */
+declare const fireEvent$1: typeof fireEvent & ToggleFireEventExtensions;
+//#endregion
+//#region src/shared/regex/types.d.ts
+type TEXT_PATTERN = RegExp | string;
+type TEXT_WITH_NTH = [TEXT_PATTERN, number];
+type TEXT_MATCHER = TEXT_PATTERN | TEXT_WITH_NTH;
+//#endregion
+//#region src/features/vitest/modules/dom/utils/clickLabelInput.d.ts
+/**
+ * Simulates clicking an input found by its label or placeholder.
+ *
+ * @param label Label or placeholder text/regular expression identifying the input.
+ * @param container Optional element that limits the input search.
+ * @returns A promise that resolves after the click interaction completes.
+ * @example
+ * ```ts
+ * await clickLabelInput("Email address");
+ * ```
+ */
+declare function clickLabelInput(label: TEXT_PATTERN, container?: HTMLElement): Promise<void>;
+//#endregion
+//#region src/features/vitest/modules/dom/utils/isChecked.d.ts
+/**
+ * Asserts that the radio button or checkbox matching the accessible name is checked.
+ *
+ * @param selector Accessible label text or regular expression for the control.
+ * @param container Optional element that limits the control search.
+ * @returns Nothing; throws an assertion error if the control is absent or unchecked.
+ * @example
+ * ```ts
+ * isChecked("Accept terms");
+ * ```
+ */
+declare function isChecked(selector: TEXT_PATTERN, container?: HTMLElement): void;
+//#endregion
+//#region src/features/vitest/modules/dom/utils/isNotChecked.d.ts
+/**
+ * Asserts that the radio button or checkbox matching the accessible name is unchecked.
+ *
+ * @param selector Accessible label text or regular expression for the control.
+ * @param container Optional element that limits the control search.
+ * @returns Nothing; throws an assertion error if the control is absent or checked.
+ * @example
+ * ```ts
+ * isNotChecked("Subscribe to updates");
+ * ```
+ */
+declare function isNotChecked(selector: TEXT_PATTERN, container?: HTMLElement): void;
+//#endregion
+//#region src/features/vitest/modules/dom/utils/shouldHaveAttributes.d.ts
+/**
+ * Asserts that an HTMLElement possesses the expected set of DOM attributes and values.
+ *
+ * Handles string/numeric values, boolean attributes (true = present, false = absent),
+ * and null/undefined values (absent).
+ *
+ * @param element The DOM element whose attributes will be checked.
+ * @param attributes Attribute names mapped to their expected values.
+ * @returns Nothing; throws an assertion error when any attribute does not match.
+ * @example
+ * ```ts
+ * shouldHaveAttributes(input, { required: true, "aria-label": "Email" });
+ * ```
+ */
+declare function shouldHaveAttributes(element: HTMLElement, attributes: Record<string, unknown>): void;
+//#endregion
+//#region src/features/vitest/modules/dom/utils/shouldHaveTestId.d.ts
+/**
+ * Asserts that elements with all supplied test IDs are present in the document.
+ *
+ * @param ids One or more `data-testid` values to locate.
+ * @returns The elements found, in the same order as the supplied IDs.
+ * @example
+ * ```ts
+ * const [submitButton] = shouldHaveTestId("submit-button");
+ * ```
+ */
+declare function shouldHaveTestId(...ids: string[]): HTMLElement[];
+//#endregion
+//#region src/features/vitest/modules/dom/utils/shouldNotHaveTestId.d.ts
+/**
+ * Asserts that elements with all supplied test IDs are absent from the document.
+ *
+ * @param ids One or more `data-testid` values to verify are absent.
+ * @returns The query results (`null` for each absent element), in ID order.
+ * @example
+ * ```ts
+ * shouldNotHaveTestId("loading-spinner");
+ * ```
+ */
+declare function shouldNotHaveTestId(...ids: string[]): (HTMLElement | null)[];
+//#endregion
+//#region src/features/vitest/modules/dom/utils/shouldNotSee.d.ts
+/**
+ * Asserts that none of the supplied text matchers appear in the document.
+ *
+ * @param texts Text strings or regular expressions that must be absent.
+ * @returns Nothing; throws an assertion error if any text is found.
+ * @example
+ * ```ts
+ * shouldNotSee("Error", /failed/i);
+ * ```
+ */
+declare const shouldNotSee: (...texts: (string | RegExp)[]) => void;
+//#endregion
+//#region src/features/vitest/modules/dom/utils/shouldSee.d.ts
+/**
+ * Asserts that each requested text matcher is present in the document.
+ *
+ * @param texts Text strings, regular expressions, or `[matcher, occurrenceIndex]` pairs.
+ * @returns The matching elements in the same order as the supplied matchers.
+ * @example
+ * ```ts
+ * const [heading] = shouldSee("Welcome");
+ * ```
+ */
+declare const shouldSee: (...texts: TEXT_MATCHER[]) => HTMLElement[];
+//#endregion
+//#region src/features/vitest/modules/dom/utils/togglePopover.d.ts
+/**
+ * Dispatches a toggle event on the first element matching a selector.
+ *
+ * @param options Selector, optional search container, and target open/closed state.
+ * @returns The matched element, or `undefined` when no matching element exists.
+ * @example
+ * ```ts
+ * const popover = togglePopover({ selector: "#help", newState: "open" });
+ * ```
+ */
+declare function togglePopover({ container, selector, newState }: {
+  container?: HTMLElement;
+  selector: string;
+  newState?: ToggleState;
+}): Element | undefined;
+//#endregion
+//#region src/features/vitest/modules/dom/utils/userClicks.d.ts
+/**
+ * Simulates a user click on a button with the requested name, or matching text.
+ *
+ * @param target Button accessible name or text string/regular expression.
+ * @param container Optional element that limits the target search.
+ * @returns A promise that resolves after the click interaction completes.
+ * @example
+ * ```ts
+ * await userClicks("Save");
+ * ```
+ */
+declare const userClicks: (target: string | RegExp, container?: HTMLElement) => Promise<void>;
+//#endregion
+//#region src/features/vitest/modules/dom/utils/userTypes.d.ts
+/**
+ * Replaces the value of a textbox found by its label, placeholder, or textbox name.
+ *
+ * @param target Accessible label, placeholder, or textbox name as text or a regex.
+ * @param text Text to type after clearing the existing value.
+ * @param container Optional element that limits the textbox search.
+ * @param user User-event instance used for the interaction; defaults to a new instance.
+ * @returns A promise resolving to the textbox that was updated.
+ * @example
+ * ```ts
+ * const emailInput = await userTypes("Email", "person@example.com");
+ * ```
+ */
+declare const userTypes: (target: TEXT_PATTERN, text: string, container?: HTMLElement, user?: import("@testing-library/user-event").UserEvent) => Promise<HTMLElement>;
+//#endregion
+//#region src/features/vitest/modules/dom/utils/userTypesMultiple.d.ts
+/**
+ * Replaces the values of multiple textboxes, located by their respective selectors.
+ *
+ * @param inputs Object mapping each textbox label/placeholder to the text to enter.
+ * @param container Optional element that limits all textbox searches.
+ * @returns A promise resolving to an object mapping each selector to its updated textbox.
+ * @example
+ * ```ts
+ * const fields = await userTypesMultiple({ Email: "person@example.com", Name: "Pat" });
+ * ```
+ */
+declare function userTypesMultiple(inputs: Record<string, string>, container?: HTMLElement): Promise<Record<string, HTMLElement>>;
+//#endregion
+export { shouldSee as a, shouldHaveTestId as c, isChecked as d, clickLabelInput as f, ToggleState as h, togglePopover as i, shouldHaveAttributes as l, ToggleConfig as m, userTypes as n, shouldNotSee as o, fireEvent$1 as p, userClicks as r, shouldNotHaveTestId as s, userTypesMultiple as t, isNotChecked as u };
+//# sourceMappingURL=index-CKsosUpb.d.mts.map

package/dist/index-CKsosUpb.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-CKsosUpb.d.mts","names":["fireEvent","rtlFireEvent"],"sources":["../src/features/vitest/modules/dom/modules/toggle-event/utils/types.ts","../src/features/vitest/modules/dom/modules/toggle-event/utils/fireEvent.ts","../src/shared/regex/types.ts","../src/features/vitest/modules/dom/utils/clickLabelInput.ts","../src/features/vitest/modules/dom/utils/isChecked.ts","../src/features/vitest/modules/dom/utils/isNotChecked.ts","../src/features/vitest/modules/dom/utils/shouldHaveAttributes.ts","../src/features/vitest/modules/dom/utils/shouldHaveTestId.ts","../src/features/vitest/modules/dom/utils/shouldNotHaveTestId.ts","../src/features/vitest/modules/dom/utils/shouldNotSee.ts","../src/features/vitest/modules/dom/utils/shouldSee.ts","../src/features/vitest/modules/dom/utils/togglePopover.ts","../src/features/vitest/modules/dom/utils/userClicks.ts","../src/features/vitest/modules/dom/utils/userTypes.ts","../src/features/vitest/modules/dom/utils/userTypesMultiple.ts"],"mappings":";;;;;;;;;;KAQY;;;;;;;;;KAUA,eAAe,gCAAgC;;;;;;;;;;KAW/C;EACV,SACE,SAAS,WAAW,UAAU,SAAS,MACvC,WAAW,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cCQVA,oBAyBAC,YAAe;;;KCjEhB,eAAe;KAEf,iBAAiB;KACjB,eAAe,eAAe;;;;;;;;;;;;;;iBCapB,gBACpB,OAAO,cACP,YAAY,cAAW;;;;;;;;;;;;;;iBCHT,UAAU,UAAU,cAAc,YAAY;;;;;;;;;;;;;;iBCA9C,aAAa,UAAU,cAAc,YAAY;;;;;;;;;;;;;;;;;iBCCjD,qBACd,SAAS,aACT,YAAY;;;;;;;;;;;;;iBCLE,oBAAoB,gBAAa;;;;;;;;;;;;;iBCAjC,uBAAuB,iBAAa;;;;;;;;;;;;;cCDvC,kBAAmB,iBAAiB;;;;;;;;;;;;;cCCpC,eAAgB,OAAO,mBAAc;;;;;;;;;;;;;iBCDlC,gBACd,WACA,UACA;EAEA,YAAY;EACZ;EACA,WAAW;IACZ;;;;;;;;;;;;;;cCLY,aACX,iBAAiB,QACjB,YAAY,gBAAW;;;;;;;;;;;;;;;;cCAZ,YACX,QAAQ,cACR,cACA,YAAY,aACZ,6CAAA,cAAwB,QAAA;;;;;;;;;;;;;;iBCRJ,kBACpB,QAAQ,wBACR,YAAY,cAAW,QAAA,eAAA"}

package/dist/index-DtGBqDev.d.mts

@@ -0,0 +1,25 @@
+//#region src/features/vitest/modules/console/utils/console.d.ts
+/**
+ * Suppresses console.log, console.warn, and console.error until resetConsole runs.
+ *
+ * @example
+ * ```ts
+ * beforeEach(shutConsole);
+ * afterEach(resetConsole);
+ * ```
+ */
+declare function shutConsole(): void;
+/**
+ * Restores the console methods most recently suppressed by shutConsole.
+ *
+ * @example
+ * ```ts
+ * shutConsole();
+ * // Run code whose console output should be ignored.
+ * resetConsole();
+ * ```
+ */
+declare function resetConsole(): void;
+//#endregion
+export { shutConsole as n, resetConsole as t };
+//# sourceMappingURL=index-DtGBqDev.d.mts.map

package/dist/index-DtGBqDev.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-DtGBqDev.d.mts","names":[],"sources":["../src/features/vitest/modules/console/utils/console.ts"],"mappings":";;;;;;;;;;iBAegB;;;;;;;;;;;iBAkBA"}

package/dist/index.cjs

@@ -0,0 +1,3 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_pattern_to_regex = require("./pattern-to-regex-BrMJtzu8.cjs");
+exports.patternToRegex = require_pattern_to_regex.patternToRegex;

package/dist/index.d.cts

@@ -0,0 +1,6 @@
+import { i as TEXT_WITH_NTH, n as TEXT_MATCHER, r as TEXT_PATTERN, t as LABEL_LOCATOR } from "./types-BlSFP07Z.cjs";
+//#region src/shared/regex/utils/pattern-to-regex.d.ts
+export declare function patternToRegex(target: TEXT_PATTERN, flags?: string): RegExp;
+//#endregion
+export type { LABEL_LOCATOR, TEXT_MATCHER, TEXT_PATTERN, TEXT_WITH_NTH };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/shared/regex/utils/pattern-to-regex.ts"],"mappings":";;wBAGgB,eACd,QAAQ,cACR,iBACC"}

package/dist/index.d.mts

@@ -0,0 +1,6 @@
+import { i as TEXT_WITH_NTH, n as TEXT_MATCHER, r as TEXT_PATTERN, t as LABEL_LOCATOR } from "./types-BlSFP07Z.mjs";
+//#region src/shared/regex/utils/pattern-to-regex.d.ts
+export declare function patternToRegex(target: TEXT_PATTERN, flags?: string): RegExp;
+//#endregion
+export type { LABEL_LOCATOR, TEXT_MATCHER, TEXT_PATTERN, TEXT_WITH_NTH };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/shared/regex/utils/pattern-to-regex.ts"],"mappings":";;wBAGgB,eACd,QAAQ,cACR,iBACC"}

package/dist/index.mjs

@@ -0,0 +1 @@
+export { t as patternToRegex } from "./pattern-to-regex-CO5Y0oDU.mjs";

package/dist/pattern-to-regex-BrMJtzu8.cjs

@@ -0,0 +1,19 @@
+//#region src/shared/regex/utils/escape-regex.ts
+function escapeRegExp(str) {
+	if (typeof RegExp.escape === "function") return RegExp.escape(str);
+	return str.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+}
+//#endregion
+//#region src/shared/regex/utils/pattern-to-regex.ts
+function patternToRegex(target, flags = "i") {
+	return typeof target === "string" ? new RegExp(escapeRegExp(target), flags) : target;
+}
+//#endregion
+Object.defineProperty(exports, "patternToRegex", {
+	enumerable: true,
+	get: function() {
+		return patternToRegex;
+	}
+});
+
+//# sourceMappingURL=pattern-to-regex-BrMJtzu8.cjs.map

package/dist/pattern-to-regex-BrMJtzu8.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"pattern-to-regex-BrMJtzu8.cjs","names":[],"sources":["../src/shared/regex/utils/escape-regex.ts","../src/shared/regex/utils/pattern-to-regex.ts"],"sourcesContent":["export function escapeRegExp(str: string): string {\n  if (typeof RegExp.escape === \"function\") {\n    return RegExp.escape(str);\n  }\n  return str.replace(/[.*+?^${}()|[\\]\\\\]/g, \"\\\\$&\");\n}\n","import { TEXT_PATTERN } from \"../types\";\nimport { escapeRegExp } from \"./escape-regex\";\n\nexport function patternToRegex(\n  target: TEXT_PATTERN,\n  flags: string = \"i\",\n): RegExp {\n  return typeof target === \"string\"\n    ? new RegExp(escapeRegExp(target), flags)\n    : target;\n}\n"],"mappings":";AAAA,SAAgB,aAAa,KAAqB;CAChD,IAAI,OAAO,OAAO,WAAW,YAC3B,OAAO,OAAO,OAAO,GAAG;CAE1B,OAAO,IAAI,QAAQ,uBAAuB,MAAM;AAClD;;;ACFA,SAAgB,eACd,QACA,QAAgB,KACR;CACR,OAAO,OAAO,WAAW,WACrB,IAAI,OAAO,aAAa,MAAM,GAAG,KAAK,IACtC;AACN"}

package/dist/pattern-to-regex-CO5Y0oDU.mjs

@@ -0,0 +1,14 @@
+//#region src/shared/regex/utils/escape-regex.ts
+function escapeRegExp(str) {
+	if (typeof RegExp.escape === "function") return RegExp.escape(str);
+	return str.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+}
+//#endregion
+//#region src/shared/regex/utils/pattern-to-regex.ts
+function patternToRegex(target, flags = "i") {
+	return typeof target === "string" ? new RegExp(escapeRegExp(target), flags) : target;
+}
+//#endregion
+export { patternToRegex as t };
+
+//# sourceMappingURL=pattern-to-regex-CO5Y0oDU.mjs.map

package/dist/pattern-to-regex-CO5Y0oDU.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"pattern-to-regex-CO5Y0oDU.mjs","names":[],"sources":["../src/shared/regex/utils/escape-regex.ts","../src/shared/regex/utils/pattern-to-regex.ts"],"sourcesContent":["export function escapeRegExp(str: string): string {\n  if (typeof RegExp.escape === \"function\") {\n    return RegExp.escape(str);\n  }\n  return str.replace(/[.*+?^${}()|[\\]\\\\]/g, \"\\\\$&\");\n}\n","import { TEXT_PATTERN } from \"../types\";\nimport { escapeRegExp } from \"./escape-regex\";\n\nexport function patternToRegex(\n  target: TEXT_PATTERN,\n  flags: string = \"i\",\n): RegExp {\n  return typeof target === \"string\"\n    ? new RegExp(escapeRegExp(target), flags)\n    : target;\n}\n"],"mappings":";AAAA,SAAgB,aAAa,KAAqB;CAChD,IAAI,OAAO,OAAO,WAAW,YAC3B,OAAO,OAAO,OAAO,GAAG;CAE1B,OAAO,IAAI,QAAQ,uBAAuB,MAAM;AAClD;;;ACFA,SAAgB,eACd,QACA,QAAgB,KACR;CACR,OAAO,OAAO,WAAW,WACrB,IAAI,OAAO,aAAa,MAAM,GAAG,KAAK,IACtC;AACN"}