@noma.to/qwik-testing-library 1.0.4 → 1.1.0

package/lib-types/lib/mock.d.ts

@@ -0,0 +1,34 @@
+export declare const mockQrl: () => import("@builder.io/qwik").QRL<import("vitest").Mock<(...args: any[]) => any>>;
+/**
+ * @experimental
+ *
+ * Create a QRL mock that can be used in tests to verify interactions
+ *
+ * As Qwik is an async framework, you need to `resolve()` the mock before making your verifications.
+ * And remember to clear the mocks before each test to start with a clean slate!
+ *
+ * @example
+ * ```tsx
+ * describe('<MyButton />', () => {
+ *   const onClickMock = mock$(() => {});
+ *
+ *   beforeEach(() => {
+ *     clearAllMocks();
+ *   });
+ *
+ *   it('should call onClick$', async () => {
+ *     await render(<MyButton onClick$={onClickMock} />);
+ *
+ *     await userEvent.click(screen.getByRole('button'));
+ *
+ *     await waitFor(() => expect(onClickMock.resolve()).resolves.toHaveBeenCalled());
+ *   });
+ * });
+ * ```
+ */
+export declare const mock$: (qrl: unknown) => import("@builder.io/qwik").QRL<import("vitest").Mock<(...args: any[]) => any>>;
+/**
+ * Will call `.mockClear()` on all spies. This will clear mock history, but not reset its implementation to the
+ * default one.
+ */
+export declare function clearAllMocks(): void;

package/lib-types/lib/qwik-testing-library.d.ts

@@ -1,6 +1,7 @@
 import { JSXOutput } from "@builder.io/qwik";
 import type { Options, Result } from "./types";
+import { clearAllMocks, mock$, mockQrl } from "./mock";
 declare function render(ui: JSXOutput, options?: Options): Promise<Result>;
 declare function cleanup(): void;
 export * from "@testing-library/dom";
-export { cleanup, render };
+export { cleanup, render, mock$, mockQrl, clearAllMocks };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@noma.to/qwik-testing-library",
-  "version": "1.0.4",
+  "version": "1.1.0",
   "description": "Simple and complete Qwik testing utilities that encourage good testing practices.",
   "repository": "https://github.com/ianlet/qwik-testing-library",
   "homepage": "https://github.com/ianlet/qwik-testing-library",
@@ -38,14 +38,15 @@
     "@testing-library/dom": "^10.4.0",
     "@types/eslint": "8.56.10",
     "@types/node": "22.7.4",
-    "@typescript-eslint/eslint-plugin": "8.7.0",
-    "@typescript-eslint/parser": "8.7.0",
+    "@typescript-eslint/eslint-plugin": "8.8.0",
+    "@typescript-eslint/parser": "8.8.0",
     "eslint": "8.57.1",
     "eslint-plugin-qwik": "1.9.0",
     "prettier": "3.3.3",
     "typescript": "5.6.2",
     "undici": "*",
     "vite": "5.4.8",
-    "vite-tsconfig-paths": "^5.0.1"
+    "vite-tsconfig-paths": "^5.0.1",
+    "vitest": "^2.1.1"
   }
 }