@ryanbrandt/react-testing-utils 0.1.0 → 0.4.0

package/README.md

@@ -1,49 +1,154 @@
 # react-testing-utils
 
-Common wrappers and utilities for unit testing and mocking in React applications with Jest and RTL
+Wrappers and utilities for unit testing React components with Jest and React Testing Library.
 
 ## Usage
 
 ```tsx
-yarn add react-testing-utils
+yarn add @ryanbrandt/react-testing-utils
 
 // or
 
-npm install react-testing-utils
+npm install @ryanbrandt/react-testing-utils
 ```
 
-**Warning:** This project has several required peer dependencies which must be installed in your consuming project
+**Required Peer Dependencies**
 
-1. `@tesing-library/jest-dom`
-2. `@testing-library/react`
-3. `jest` (27+)
-4. `react` (17+)
-5. `react-dom` (17+)
+```json
+"peerDependencies": {
+  "@testing-library/dom": ">=8.13.0",
+  "@testing-library/jest-dom": ">=5.14.1",
+  "@testing-library/react": ">=12.1.2",
+  "@testing-library/user-event": ">=14.1.0",
+  "jest": ">=28.1.0",
+  "jest-environment-jsdom": ">=28.1.0",
+  "react": ">=17.0.2",
+  "react-dom": ">=17.0.2",
+}
+```
+
+## API
 
-### Example Usage of Key Utilities
+### Mocking Function Components
 
 ```tsx
-jest.mock("path/to/your/component");
-const mockedMyComponent = new MockFunctionComponentWrapper(MyComponent);
+jest.mock("path/to/component");
+const mockFunctionComponent = new MockFunctionComponent(MyFunctionComponent);
+```
 
-jest.mock("path/to/some/hook");
-// resolves to Jest.MockedFunction<typeof useMyHook>;
-const mockUseMyHook = JestUtilities.assertAsMockFunction(useMyHook);
+### Mocking Class Components
 
-describe("SomeOtherComponent", () => {
-  it("renders a MyComponent", () => {
-    render(<SomeOtherComponent />);
+```tsx
+jest.mock("path/to/component");
+const mockClassComponent = new MockClassComponent(MyClassComponent);
+```
 
-    mockedMyComponent.assertOnScreen();
-    mockedMyComponent.assertCalledWith({ someProps: "expected value" });
-  });
+### Methods
+
+**Setup**
+
+A setup is provided by default as `<div data-testid={MockComponent.DATA_TEST_ID} />` when instantiated.
+
+However, if a specific setup is needed, you can define your own. Each mock provided mock setup
+will be wrapped in a div as follows: `<div data-testid={MockComponent.DATA_TEST_ID}>{MockSetup}</div>`
+
+```tsx
+// Function
+
+mockFunctionComponent.mockReturnValue(<div />);
+mockFunctionComponent.mockImplementation((props) => <div>{children}</div>);
+
+// Class
+
+mockClassComponent.mockRenderReturnValue(<div />);
+mockClassComponent.mockRenderImplementation((props) => (
+  <div>{props.children}</div>
+));
+```
+
+**Getters**
+
+```tsx
+it("renders one instance", () => {
+  ...
+  expect(mockComponent.mockRoot).toBeInTheDocument();
+});
+
+it("renders many instances", () => {
+  expect(mockComponent.mockRoots.length).toBeGreaterThan(1);
+});
+
+```
+
+**Click Interactions**
+
+```tsx
+
+it("does something when clicked", async () => {
+  ...
+  await mockComponent.click();
+});
 
-  describe("when useMyHook does something", () => {
-      mockUseMyHook.mockReturnValue("something done");
+it("does something when an instance is clicked", async () => {
+  ...
+  await mockComponent.clickInstance(1);
+});
+
+```
+
+**Typing Interactions**
+
+```tsx
+
+it("does something when typed into", async () => {
+  ...
+  await mockComponent.type("Foo");
+});
+
+it("does something when an instance is typed into", async () => {
+  ...
+  await mockComponent.typeInstance("Foo", 1);
+});
+
+```
+
+**Screen Assertions**
+
+```tsx
+it("is on the screen", () => {
+  ...
+  mockComponent.assertOnScreen();
+});
+
+it("is not on the screen", () => {
+  ...
+  mockComponent.assertNotOnScreen();
+});
+
+```
+
+**Invocation Assertions**
 
-      render(<SomeOtherComponent />);
+```tsx
+it("is called with what I expect", () => {
+  ...
+  mockComponent.assertCalledWith({
+    foo: "bar",
+  });
+});
 
-      ...
-  })
+it("is called with what I expect when I expect it", () => {
+  ...
+  mockComponent.assertNthCalledWith({
+    foo: "bar",
+  }, 1);
 });
+
+it("is last called with what I expect", () => {
+  ...
+  mockComponent.assertLastCalledWith({
+    foo: "bar"
+  });
+});
+
 ```

package/dist/@types/AbstractMockComponent.d.ts

@@ -0,0 +1,106 @@
+/// <reference types="jest" />
+import "@testing-library/jest-dom";
+/**
+ * Abstract base mock component class
+ */
+declare abstract class AbstractMockComponent<T> {
+    protected _mock: jest.Mocked<unknown>;
+    receivedProps: T;
+    /**
+     * The data-testid applied to the component mocks
+     */
+    DATA_TEST_ID: string;
+    constructor();
+    private _buildPropsExpectation;
+    /**
+     * Retrieves the root element of the mocked component, which will
+     * always be a div with this.DATA_TEST_ID applied
+     *
+     * If more than one instance of the component or no instances of the component
+     * are on the screen this method will throw
+     *
+     * @see mockRoots
+     */
+    get mockRoot(): HTMLElement;
+    /**
+     * Retrieves the root elements of all of the mocked component instances, which will
+     * always be a div with this.DATA_TEST_ID applied
+     *
+     * Can be used when one or many instances of the mock component exist on the screen.
+     * If no instances exist this method will throw
+     *
+     * @see mockRoot
+     */
+    get mockRoots(): HTMLElement[];
+    /**
+     * Asserts that the mock component was called with the provided subset of props
+     * @param props The subset of props to match against
+     */
+    assertCalledWith: (props: Partial<T>) => void;
+    /**
+     * Asserts that the mock component was last called with the provided subset of props
+     * @param props The subset of props to match against
+     */
+    assertLastCalledWith: (props: Partial<T>) => void;
+    /**
+     * Asserts that the mock component was nth called with the provided subset of props
+     * @param props The subset of props to match against
+     * @param n The render number to check against
+     */
+    assertNthCalledWith: (props: Partial<T>, n: number) => void;
+    /**
+     * Asserts that an instance of the component exists within the document
+     * @param allowMultiple Optional boolean to allow for multiple instances
+     * of the component to exist. When set false, if more than 1 instance
+     * of the component is on the screen this assertion will fail.
+     * @default true
+     */
+    assertOnScreen: (allowMultiple?: boolean) => void;
+    /**
+     * Asserts that the component is not currently rendered within the document
+     */
+    assertNotOnScreen: () => void;
+    /**
+     * Clicks the root element defined in the mock component's return value/implementation
+     * This method will throw if no or more than a single instance of the mock component
+     * exists on the screen
+     *
+     * @param root The root element to click
+     * @default this.mockRoot.firstChild
+     *
+     * @see clickInstance
+     *
+     */
+    click: (root?: HTMLElement) => Promise<void>;
+    /**
+     * Clicks the root element of a specific instance of the mock component as defined in the
+     * mock return value/implementation.This method will throw if the provided index is not found.
+     *
+     * @param instanceIndex The index of the instance which should be clicked
+     *
+     * @see click
+     *
+     */
+    clickInstance: (instanceIndex: number) => Promise<void>;
+    /**
+     * Types into the root element of your mock. This method will throw if the root element
+     * does not support typing or if there are none or mulitple instances of the mock on the
+     * screen.
+     *
+     * @param value The value to type
+     * @param root The root element to type into
+     * @default this.mockRoot.firstChild
+     *
+     * @see typeInstance
+     */
+    type: (value: string, root?: HTMLElement) => Promise<void>;
+    /**
+     * Types into the root element of a specific instance of the mock component. This method will throw
+     * if the root element does not support typing or if the provided instance index is not found.
+     *
+     * @param value The value to type
+     * @param instanceIndex The index of the instance to type into
+     */
+    typeInstance: (value: string, instanceIndex: number) => Promise<void>;
+}
+export default AbstractMockComponent;

package/dist/@types/{src/react/MockClassComponentWrapper.d.ts → MockClassComponent.d.ts}

@@ -1,16 +1,16 @@
 /// <reference types="jest" />
 import "@testing-library/jest-dom";
-import AbstractMockComponentWrapper from "./AbstractMockComponentWrapper";
+import AbstractMockComponent from "./AbstractMockComponent";
 declare type ReactClassComponentWithProps<T> = React.ComponentClass<T>;
 /**
- * A standard mock class component wrapper
+ * A standard mock class component
  *
  * @example
  * jest.mock("path/to/my/class/component");
- * const mockMyClassComponent = new MockClassComponentWrapper(MyClassComponent);
+ * const mockMyClassComponent = new MockClassComponent(MyClassComponent);
  */
-declare class MockClassComponentWrapper<T> extends AbstractMockComponentWrapper<T> {
-    protected _mock: jest.MockedClass<ReactClassComponentWithProps<T>>;
+declare class MockClassComponent<T> extends AbstractMockComponent<T> {
+    protected _mock: jest.MockedObject<ReactClassComponentWithProps<T>>;
     constructor(actual: ReactClassComponentWithProps<T>);
     protected _configureMockImplementation: (valueGenerator?: (props: T) => JSX.Element | null) => void;
     /**
@@ -18,7 +18,7 @@ declare class MockClassComponentWrapper<T> extends AbstractMockComponentWrapper<
      *
      * Only should be used when truly necessary
      */
-    get __OVERRIDE__mock(): jest.MockedClass<ReactClassComponentWithProps<T>>;
+    get __OVERRIDE__mock(): jest.MockedObject<ReactClassComponentWithProps<T>>;
     /**
      * Mocks the return value of the render method
      * @param value The value render should return
@@ -30,4 +30,4 @@ declare class MockClassComponentWrapper<T> extends AbstractMockComponentWrapper<
      */
     mockRenderImplementation: (implementation: (props: T) => JSX.Element | null) => void;
 }
-export default MockClassComponentWrapper;
+export default MockClassComponent;

package/dist/@types/{src/react/MockFunctionComponentWrapper.d.ts → MockFunctionComponent.d.ts}

@@ -1,15 +1,15 @@
 /// <reference types="jest" />
 import "@testing-library/jest-dom";
-import AbstractMockComponentWrapper from "./AbstractMockComponentWrapper";
+import AbstractMockComponent from "./AbstractMockComponent";
 declare type ReactFunctionComponentWithProps<T> = React.FunctionComponent<T>;
 /**
- * A standard mock function component wrapper
+ * A standard mock function component instance
  *
  * @example
  * jest.mock("path/to/my/function/component");
- * const mockMyFunctionComponent = new MockFunctionComponentWrapper(MyFunctionComponent);
+ * const mockMyFunctionComponent = new MockFunctionComponent(MyFunctionComponent);
  */
-declare class MockFunctionComponentWrapper<T> extends AbstractMockComponentWrapper<T> {
+declare class MockFunctionComponent<T> extends AbstractMockComponent<T> {
     protected _mock: jest.MockedFunction<ReactFunctionComponentWithProps<T>>;
     constructor(actual: ReactFunctionComponentWithProps<T>);
     protected _configureMockImplementation: (valueGenerator?: (props: T) => JSX.Element | null) => void;
@@ -30,4 +30,4 @@ declare class MockFunctionComponentWrapper<T> extends AbstractMockComponentWrapp
      */
     mockImplementation: (implementation: (props: T) => JSX.Element | null) => void;
 }
-export default MockFunctionComponentWrapper;
+export default MockFunctionComponent;

package/dist/@types/index.d.ts

@@ -1,3 +1,2 @@
-export { default as JestUtilities } from "./jest";
-export { default as MockClassComponentWrapper } from "./react/MockClassComponentWrapper";
-export { default as MockFunctionComponentWrapper } from "./react/MockFunctionComponentWrapper";
+export { default as MockClassComponentWrapper } from "./MockClassComponent";
+export { default as MockFunctionComponentWrapper } from "./MockFunctionComponent";

package/dist/index.esm.js

@@ -1,2 +1,2 @@
-import{jsx as t}from"react/jsx-runtime";import"@testing-library/jest-dom";import{screen as e}from"@testing-library/react";class o{static assertAsMockFunction=t=>t;static assertAsMockClass=t=>t}class s{_mock;receivedProps;DATA_TEST_ID;constructor(){this.DATA_TEST_ID=Math.random().toString(36).slice(2)}_buildPropsExpectation=t=>[expect.objectContaining({...t}),expect.anything()];get mockRoot(){return e.getByTestId(this.DATA_TEST_ID)}get mockRoots(){return e.getAllByTestId(this.DATA_TEST_ID)}assertCalledWith=t=>{expect(this._mock).toHaveBeenCalledWith(...this._buildPropsExpectation(t))};assertLastCalledWith=t=>{expect(this._mock).toHaveBeenLastCalledWith(...this._buildPropsExpectation(t))};assertNthCalledWith=(t,e)=>{expect(this._mock).toHaveBeenNthCalledWith(e,...this._buildPropsExpectation(t))};assertOnScreen=(t=!0)=>{t?expect(this.mockRoots.length).toBeGreaterThanOrEqual(1):expect(this.mockRoot).toBeInTheDocument()};assertNotOnScreen=()=>{expect((()=>this.mockRoot)).toThrow()}}class i extends s{constructor(t){super(),this._mock=o.assertAsMockClass(t),this._configureMockImplementation()}_configureMockImplementation=e=>{this._mock.mockImplementation((o=>(this.receivedProps=o,{render:()=>t("div",{"data-testid":this.DATA_TEST_ID,children:e&&e(o)})})))};get __OVERRIDE__mock(){return this._mock}mockRenderReturnValue=t=>{this._configureMockImplementation((()=>t))};mockRenderImplementation=t=>{this._configureMockImplementation((e=>t(e)))}}class c extends s{constructor(t){super(),this._mock=o.assertAsMockFunction(t),this._configureMockImplementation()}_configureMockImplementation=e=>{this._mock.mockImplementation((o=>(this.receivedProps=o,t("div",{"data-testid":this.DATA_TEST_ID,children:e&&e(o)}))))};get __OVERRIDE__mock(){return this._mock}mockReturnValue=t=>{this._configureMockImplementation((()=>t))};mockImplementation=t=>{this._configureMockImplementation((e=>t(e)))}}export{o as JestUtilities,i as MockClassComponentWrapper,c as MockFunctionComponentWrapper};
+import{jsx as t}from"react/jsx-runtime";import"@testing-library/jest-dom";import{screen as e}from"@testing-library/react";import o from"@testing-library/user-event";class i{_mock;receivedProps;DATA_TEST_ID;constructor(){this.DATA_TEST_ID=Math.random().toString(36).slice(2)}_buildPropsExpectation=t=>[expect.objectContaining({...t}),expect.anything()];get mockRoot(){return e.getByTestId(this.DATA_TEST_ID)}get mockRoots(){return e.getAllByTestId(this.DATA_TEST_ID)}assertCalledWith=t=>{expect(this._mock).toHaveBeenCalledWith(...this._buildPropsExpectation(t))};assertLastCalledWith=t=>{expect(this._mock).toHaveBeenLastCalledWith(...this._buildPropsExpectation(t))};assertNthCalledWith=(t,e)=>{expect(this._mock).toHaveBeenNthCalledWith(e,...this._buildPropsExpectation(t))};assertOnScreen=(t=!0)=>{t?expect(this.mockRoots.length).toBeGreaterThanOrEqual(1):expect(this.mockRoot).toBeInTheDocument()};assertNotOnScreen=()=>{expect((()=>this.mockRoot)).toThrow()};click=async(t=this.mockRoot.firstChild)=>{await o.click(t)};clickInstance=async t=>{await this.click(this.mockRoots[t].firstChild)};type=async(t,e=this.mockRoot.firstChild)=>{await o.type(e,t)};typeInstance=async(t,e)=>{await this.type(t,this.mockRoots[e].firstChild)}}class s extends i{constructor(t){super(),this._mock=jest.mocked(t),this._configureMockImplementation()}_configureMockImplementation=e=>{this._mock.mockImplementation((o=>(this.receivedProps=o,{render:()=>t("div",{"data-testid":this.DATA_TEST_ID,children:e&&e(o)})})))};get __OVERRIDE__mock(){return this._mock}mockRenderReturnValue=t=>{this._configureMockImplementation((()=>t))};mockRenderImplementation=t=>{this._configureMockImplementation((e=>t(e)))}}class c extends i{constructor(t){super(),this._mock=jest.mocked(t),this._configureMockImplementation()}_configureMockImplementation=e=>{this._mock.mockImplementation((o=>(this.receivedProps=o,t("div",{"data-testid":this.DATA_TEST_ID,children:e&&e(o)}))))};get __OVERRIDE__mock(){return this._mock}mockReturnValue=t=>{this._configureMockImplementation((()=>t))};mockImplementation=t=>{this._configureMockImplementation((e=>t(e)))}}export{s as MockClassComponentWrapper,c as MockFunctionComponentWrapper};
 //# sourceMappingURL=index.esm.js.map

package/dist/index.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.esm.js","sources":["../src/jest/index.ts","../src/react/AbstractMockComponentWrapper.tsx","../src/react/MockClassComponentWrapper.tsx","../src/react/MockFunctionComponentWrapper.tsx"],"sourcesContent":[null,null,null,null],"names":["JestUtilities","static","actual","AbstractMockComponentWrapper","_mock","receivedProps","DATA_TEST_ID","constructor","this","Math","random","toString","slice","_buildPropsExpectation","props","expect","objectContaining","anything","mockRoot","screen","getByTestId","mockRoots","getAllByTestId","assertCalledWith","toHaveBeenCalledWith","assertLastCalledWith","toHaveBeenLastCalledWith","assertNthCalledWith","n","toHaveBeenNthCalledWith","assertOnScreen","allowMultiple","length","toBeGreaterThanOrEqual","toBeInTheDocument","assertNotOnScreen","toThrow","MockClassComponentWrapper","super","assertAsMockClass","_configureMockImplementation","valueGenerator","mockImplementation","render","_jsx","children","__OVERRIDE__mock","mockRenderReturnValue","value","mockRenderImplementation","implementation","MockFunctionComponentWrapper","assertAsMockFunction","mockReturnValue"],"mappings":"0HAEA,MAAMA,EACJC,4BACEC,GAEuBA,EAKzBD,yBACEC,GAEoBA,ECRxB,MAAeC,EACHC,MAEVC,cAKAC,aAEAC,cACEC,KAAKF,aAAeG,KAAKC,SAASC,SAAS,IAAIC,MAAM,GAI/CC,uBAA0BC,GAAsB,CACtDC,OAAOC,iBAAiB,IACnBF,IAELC,OAAOE,YASLC,eACF,OAAOC,EAAOC,YAAYZ,KAAKF,cAS7Be,gBACF,OAAOF,EAAOG,eAAed,KAAKF,cAOpCiB,iBAAoBT,IAClBC,OAAOP,KAAKJ,OAAOoB,wBACdhB,KAAKK,uBAAuBC,KAQnCW,qBAAwBX,IACtBC,OAAOP,KAAKJ,OAAOsB,4BACdlB,KAAKK,uBAAuBC,KASnCa,oBAAsB,CAACb,EAAmBc,KACxCb,OAAOP,KAAKJ,OAAOyB,wBACjBD,KACGpB,KAAKK,uBAAuBC,KAWnCgB,eAAiB,CAACC,GAAgB,KAC5BA,EACFhB,OAAOP,KAAKa,UAAUW,QAAQC,uBAAuB,GAErDlB,OAAOP,KAAKU,UAAUgB,qBAO1BC,kBAAoB,KAClBpB,QAAO,IAAMP,KAAKU,WAAUkB,WCrFhC,MAAMC,UAAqClC,EAGzCI,YAAYL,GACVoC,QACA9B,KAAKJ,MAAQJ,EAAcuC,kBAAkBrC,GAE7CM,KAAKgC,+BAGGA,6BACRC,IAIAjC,KAAKJ,MAAMsC,oBAAoB5B,IAC7BN,KAAKH,cAAgBS,EAEd,CACL6B,OAAQ,IACNC,uBAAkBpC,KAAKF,aAAYuC,SAChCJ,GAAkBA,EAAe3B,UAYxCgC,uBACF,OAAOtC,KAAKJ,MAOd2C,sBAAyBC,IACvBxC,KAAKgC,8BAA6B,IAAMQ,KAO1CC,yBACEC,IAEA1C,KAAKgC,8BAA8B1B,GAAUoC,EAAepC,MCpDhE,MAAMqC,UAAwChD,EAK5CI,YAAYL,GACVoC,QACA9B,KAAKJ,MAAQJ,EAAcoD,qBAAqBlD,GAEhDM,KAAKgC,+BAGGA,6BACRC,IAEAjC,KAAKJ,MAAMsC,oBAAoB5B,IAC7BN,KAAKH,cAAgBS,EAGnB8B,EAAA,MAAA,CAAA,cAAkBpC,KAAKF,aACpBuC,SAAAJ,GAAkBA,EAAe3B,SAWtCgC,uBACF,OAAOtC,KAAKJ,MAOdiD,gBAAmBL,IACjBxC,KAAKgC,8BAA6B,IAAMQ,KAO1CN,mBACEQ,IAEA1C,KAAKgC,8BAA8B1B,GAAUoC,EAAepC"}
+{"version":3,"file":"index.esm.js","sources":["../src/AbstractMockComponent.tsx","../src/MockClassComponent.tsx","../src/MockFunctionComponent.tsx"],"sourcesContent":[null,null,null],"names":["AbstractMockComponent","_mock","receivedProps","DATA_TEST_ID","constructor","this","Math","random","toString","slice","_buildPropsExpectation","props","expect","objectContaining","anything","mockRoot","screen","getByTestId","mockRoots","getAllByTestId","assertCalledWith","toHaveBeenCalledWith","assertLastCalledWith","toHaveBeenLastCalledWith","assertNthCalledWith","n","toHaveBeenNthCalledWith","assertOnScreen","allowMultiple","length","toBeGreaterThanOrEqual","toBeInTheDocument","assertNotOnScreen","toThrow","click","async","root","firstChild","userEvent","clickInstance","instanceIndex","type","value","typeInstance","MockClassComponent","actual","super","jest","mocked","_configureMockImplementation","valueGenerator","mockImplementation","render","_jsx","children","__OVERRIDE__mock","mockRenderReturnValue","mockRenderImplementation","implementation","MockFunctionComponent","mockReturnValue"],"mappings":"qKAOA,MAAeA,EACHC,MAEVC,cAKAC,aAEAC,cACEC,KAAKF,aAAeG,KAAKC,SAASC,SAAS,IAAIC,MAAM,GAI/CC,uBAA0BC,GAAsB,CACtDC,OAAOC,iBAAiB,IACnBF,IAELC,OAAOE,YAYLC,eACF,OAAOC,EAAOC,YAAYZ,KAAKF,cAY7Be,gBACF,OAAOF,EAAOG,eAAed,KAAKF,cAOpCiB,iBAAoBT,IAClBC,OAAOP,KAAKJ,OAAOoB,wBACdhB,KAAKK,uBAAuBC,KAQnCW,qBAAwBX,IACtBC,OAAOP,KAAKJ,OAAOsB,4BACdlB,KAAKK,uBAAuBC,KASnCa,oBAAsB,CAACb,EAAmBc,KACxCb,OAAOP,KAAKJ,OAAOyB,wBACjBD,KACGpB,KAAKK,uBAAuBC,KAWnCgB,eAAiB,CAACC,GAAgB,KAC5BA,EACFhB,OAAOP,KAAKa,UAAUW,QAAQC,uBAAuB,GAErDlB,OAAOP,KAAKU,UAAUgB,qBAO1BC,kBAAoB,KAClBpB,QAAO,IAAMP,KAAKU,WAAUkB,WAc9BC,MAAQC,MACNC,EAAO/B,KAAKU,SAASsB,oBAEfC,EAAUJ,MAAME,IAYxBG,cAAgBJ,MAAOK,UACfnC,KAAK6B,MAAM7B,KAAKa,UAAUsB,GAAeH,aAcjDI,KAAON,MACLO,EACAN,EAAO/B,KAAKU,SAASsB,oBAEfC,EAAUG,KAAKL,EAAMM,IAU7BC,aAAeR,MACbO,EACAF,WAEMnC,KAAKoC,KACTC,EACArC,KAAKa,UAAUsB,GAAeH,aC7JpC,MAAMO,UAA8B5C,EAGlCI,YAAYyC,GACVC,QACAzC,KAAKJ,MAAQ8C,KAAKC,OAAOH,GAEzBxC,KAAK4C,+BAGGA,6BACRC,IAIA7C,KAAKJ,MAAMkD,oBAAoBxC,IAC7BN,KAAKH,cAAgBS,EAEd,CACLyC,OAAQ,IACNC,uBAAkBhD,KAAKF,aAAYmD,SAChCJ,GAAkBA,EAAevC,UAYxC4C,uBACF,OAAOlD,KAAKJ,MAOduD,sBAAyBd,IACvBrC,KAAK4C,8BAA6B,IAAMP,KAO1Ce,yBACEC,IAEArD,KAAK4C,8BAA8BtC,GAAU+C,EAAe/C,MCpDhE,MAAMgD,UAAiC3D,EAKrCI,YAAYyC,GACVC,QACAzC,KAAKJ,MAAQ8C,KAAKC,OAAOH,GAEzBxC,KAAK4C,+BAGGA,6BACRC,IAEA7C,KAAKJ,MAAMkD,oBAAoBxC,IAC7BN,KAAKH,cAAgBS,EAGnB0C,EAAA,MAAA,CAAA,cAAkBhD,KAAKF,aACpBmD,SAAAJ,GAAkBA,EAAevC,SAWtC4C,uBACF,OAAOlD,KAAKJ,MAOd2D,gBAAmBlB,IACjBrC,KAAK4C,8BAA6B,IAAMP,KAO1CS,mBACEO,IAEArD,KAAK4C,8BAA8BtC,GAAU+C,EAAe/C"}

package/dist/index.js

@@ -1,2 +1,2 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var e=require("react/jsx-runtime");require("@testing-library/jest-dom");var t=require("@testing-library/react");class o{static assertAsMockFunction=e=>e;static assertAsMockClass=e=>e}class s{_mock;receivedProps;DATA_TEST_ID;constructor(){this.DATA_TEST_ID=Math.random().toString(36).slice(2)}_buildPropsExpectation=e=>[expect.objectContaining({...e}),expect.anything()];get mockRoot(){return t.screen.getByTestId(this.DATA_TEST_ID)}get mockRoots(){return t.screen.getAllByTestId(this.DATA_TEST_ID)}assertCalledWith=e=>{expect(this._mock).toHaveBeenCalledWith(...this._buildPropsExpectation(e))};assertLastCalledWith=e=>{expect(this._mock).toHaveBeenLastCalledWith(...this._buildPropsExpectation(e))};assertNthCalledWith=(e,t)=>{expect(this._mock).toHaveBeenNthCalledWith(t,...this._buildPropsExpectation(e))};assertOnScreen=(e=!0)=>{e?expect(this.mockRoots.length).toBeGreaterThanOrEqual(1):expect(this.mockRoot).toBeInTheDocument()};assertNotOnScreen=()=>{expect((()=>this.mockRoot)).toThrow()}}exports.JestUtilities=o,exports.MockClassComponentWrapper=class extends s{constructor(e){super(),this._mock=o.assertAsMockClass(e),this._configureMockImplementation()}_configureMockImplementation=t=>{this._mock.mockImplementation((o=>(this.receivedProps=o,{render:()=>e.jsx("div",{"data-testid":this.DATA_TEST_ID,children:t&&t(o)})})))};get __OVERRIDE__mock(){return this._mock}mockRenderReturnValue=e=>{this._configureMockImplementation((()=>e))};mockRenderImplementation=e=>{this._configureMockImplementation((t=>e(t)))}},exports.MockFunctionComponentWrapper=class extends s{constructor(e){super(),this._mock=o.assertAsMockFunction(e),this._configureMockImplementation()}_configureMockImplementation=t=>{this._mock.mockImplementation((o=>(this.receivedProps=o,e.jsx("div",{"data-testid":this.DATA_TEST_ID,children:t&&t(o)}))))};get __OVERRIDE__mock(){return this._mock}mockReturnValue=e=>{this._configureMockImplementation((()=>e))};mockImplementation=e=>{this._configureMockImplementation((t=>e(t)))}};
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var t=require("react/jsx-runtime");require("@testing-library/jest-dom");var e=require("@testing-library/react");function o(t){return t&&"object"==typeof t&&"default"in t?t:{default:t}}var i=o(require("@testing-library/user-event"));class s{_mock;receivedProps;DATA_TEST_ID;constructor(){this.DATA_TEST_ID=Math.random().toString(36).slice(2)}_buildPropsExpectation=t=>[expect.objectContaining({...t}),expect.anything()];get mockRoot(){return e.screen.getByTestId(this.DATA_TEST_ID)}get mockRoots(){return e.screen.getAllByTestId(this.DATA_TEST_ID)}assertCalledWith=t=>{expect(this._mock).toHaveBeenCalledWith(...this._buildPropsExpectation(t))};assertLastCalledWith=t=>{expect(this._mock).toHaveBeenLastCalledWith(...this._buildPropsExpectation(t))};assertNthCalledWith=(t,e)=>{expect(this._mock).toHaveBeenNthCalledWith(e,...this._buildPropsExpectation(t))};assertOnScreen=(t=!0)=>{t?expect(this.mockRoots.length).toBeGreaterThanOrEqual(1):expect(this.mockRoot).toBeInTheDocument()};assertNotOnScreen=()=>{expect((()=>this.mockRoot)).toThrow()};click=async(t=this.mockRoot.firstChild)=>{await i.default.click(t)};clickInstance=async t=>{await this.click(this.mockRoots[t].firstChild)};type=async(t,e=this.mockRoot.firstChild)=>{await i.default.type(e,t)};typeInstance=async(t,e)=>{await this.type(t,this.mockRoots[e].firstChild)}}exports.MockClassComponentWrapper=class extends s{constructor(t){super(),this._mock=jest.mocked(t),this._configureMockImplementation()}_configureMockImplementation=e=>{this._mock.mockImplementation((o=>(this.receivedProps=o,{render:()=>t.jsx("div",{"data-testid":this.DATA_TEST_ID,children:e&&e(o)})})))};get __OVERRIDE__mock(){return this._mock}mockRenderReturnValue=t=>{this._configureMockImplementation((()=>t))};mockRenderImplementation=t=>{this._configureMockImplementation((e=>t(e)))}},exports.MockFunctionComponentWrapper=class extends s{constructor(t){super(),this._mock=jest.mocked(t),this._configureMockImplementation()}_configureMockImplementation=e=>{this._mock.mockImplementation((o=>(this.receivedProps=o,t.jsx("div",{"data-testid":this.DATA_TEST_ID,children:e&&e(o)}))))};get __OVERRIDE__mock(){return this._mock}mockReturnValue=t=>{this._configureMockImplementation((()=>t))};mockImplementation=t=>{this._configureMockImplementation((e=>t(e)))}};
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../src/jest/index.ts","../src/react/AbstractMockComponentWrapper.tsx","../src/react/MockClassComponentWrapper.tsx","../src/react/MockFunctionComponentWrapper.tsx"],"sourcesContent":[null,null,null,null],"names":["JestUtilities","static","actual","AbstractMockComponentWrapper","_mock","receivedProps","DATA_TEST_ID","constructor","this","Math","random","toString","slice","_buildPropsExpectation","props","expect","objectContaining","anything","mockRoot","screen","getByTestId","mockRoots","getAllByTestId","assertCalledWith","toHaveBeenCalledWith","assertLastCalledWith","toHaveBeenLastCalledWith","assertNthCalledWith","n","toHaveBeenNthCalledWith","assertOnScreen","allowMultiple","length","toBeGreaterThanOrEqual","toBeInTheDocument","assertNotOnScreen","toThrow","super","assertAsMockClass","_configureMockImplementation","valueGenerator","mockImplementation","render","_jsx","children","__OVERRIDE__mock","mockRenderReturnValue","value","mockRenderImplementation","implementation","assertAsMockFunction","mockReturnValue"],"mappings":"oLAEA,MAAMA,EACJC,4BACEC,GAEuBA,EAKzBD,yBACEC,GAEoBA,ECRxB,MAAeC,EACHC,MAEVC,cAKAC,aAEAC,cACEC,KAAKF,aAAeG,KAAKC,SAASC,SAAS,IAAIC,MAAM,GAI/CC,uBAA0BC,GAAsB,CACtDC,OAAOC,iBAAiB,IACnBF,IAELC,OAAOE,YASLC,eACF,OAAOC,SAAOC,YAAYZ,KAAKF,cAS7Be,gBACF,OAAOF,SAAOG,eAAed,KAAKF,cAOpCiB,iBAAoBT,IAClBC,OAAOP,KAAKJ,OAAOoB,wBACdhB,KAAKK,uBAAuBC,KAQnCW,qBAAwBX,IACtBC,OAAOP,KAAKJ,OAAOsB,4BACdlB,KAAKK,uBAAuBC,KASnCa,oBAAsB,CAACb,EAAmBc,KACxCb,OAAOP,KAAKJ,OAAOyB,wBACjBD,KACGpB,KAAKK,uBAAuBC,KAWnCgB,eAAiB,CAACC,GAAgB,KAC5BA,EACFhB,OAAOP,KAAKa,UAAUW,QAAQC,uBAAuB,GAErDlB,OAAOP,KAAKU,UAAUgB,qBAO1BC,kBAAoB,KAClBpB,QAAO,IAAMP,KAAKU,WAAUkB,qECrFhC,cAA2CjC,EAGzCI,YAAYL,GACVmC,QACA7B,KAAKJ,MAAQJ,EAAcsC,kBAAkBpC,GAE7CM,KAAK+B,+BAGGA,6BACRC,IAIAhC,KAAKJ,MAAMqC,oBAAoB3B,IAC7BN,KAAKH,cAAgBS,EAEd,CACL4B,OAAQ,IACNC,2BAAkBnC,KAAKF,aAAYsC,SAChCJ,GAAkBA,EAAe1B,UAYxC+B,uBACF,OAAOrC,KAAKJ,MAOd0C,sBAAyBC,IACvBvC,KAAK+B,8BAA6B,IAAMQ,KAO1CC,yBACEC,IAEAzC,KAAK+B,8BAA8BzB,GAAUmC,EAAenC,4CCpDhE,cAA8CX,EAK5CI,YAAYL,GACVmC,QACA7B,KAAKJ,MAAQJ,EAAckD,qBAAqBhD,GAEhDM,KAAK+B,+BAGGA,6BACRC,IAEAhC,KAAKJ,MAAMqC,oBAAoB3B,IAC7BN,KAAKH,cAAgBS,EAGnB6B,MAAA,MAAA,CAAA,cAAkBnC,KAAKF,aACpBsC,SAAAJ,GAAkBA,EAAe1B,SAWtC+B,uBACF,OAAOrC,KAAKJ,MAOd+C,gBAAmBJ,IACjBvC,KAAK+B,8BAA6B,IAAMQ,KAO1CN,mBACEQ,IAEAzC,KAAK+B,8BAA8BzB,GAAUmC,EAAenC"}
+{"version":3,"file":"index.js","sources":["../src/AbstractMockComponent.tsx","../src/MockClassComponent.tsx","../src/MockFunctionComponent.tsx"],"sourcesContent":[null,null,null],"names":["AbstractMockComponent","_mock","receivedProps","DATA_TEST_ID","constructor","this","Math","random","toString","slice","_buildPropsExpectation","props","expect","objectContaining","anything","mockRoot","screen","getByTestId","mockRoots","getAllByTestId","assertCalledWith","toHaveBeenCalledWith","assertLastCalledWith","toHaveBeenLastCalledWith","assertNthCalledWith","n","toHaveBeenNthCalledWith","assertOnScreen","allowMultiple","length","toBeGreaterThanOrEqual","toBeInTheDocument","assertNotOnScreen","toThrow","click","async","root","firstChild","userEvent","clickInstance","instanceIndex","type","value","typeInstance","actual","super","jest","mocked","_configureMockImplementation","valueGenerator","mockImplementation","render","_jsx","children","__OVERRIDE__mock","mockRenderReturnValue","mockRenderImplementation","implementation","mockReturnValue"],"mappings":"4SAOA,MAAeA,EACHC,MAEVC,cAKAC,aAEAC,cACEC,KAAKF,aAAeG,KAAKC,SAASC,SAAS,IAAIC,MAAM,GAI/CC,uBAA0BC,GAAsB,CACtDC,OAAOC,iBAAiB,IACnBF,IAELC,OAAOE,YAYLC,eACF,OAAOC,SAAOC,YAAYZ,KAAKF,cAY7Be,gBACF,OAAOF,SAAOG,eAAed,KAAKF,cAOpCiB,iBAAoBT,IAClBC,OAAOP,KAAKJ,OAAOoB,wBACdhB,KAAKK,uBAAuBC,KAQnCW,qBAAwBX,IACtBC,OAAOP,KAAKJ,OAAOsB,4BACdlB,KAAKK,uBAAuBC,KASnCa,oBAAsB,CAACb,EAAmBc,KACxCb,OAAOP,KAAKJ,OAAOyB,wBACjBD,KACGpB,KAAKK,uBAAuBC,KAWnCgB,eAAiB,CAACC,GAAgB,KAC5BA,EACFhB,OAAOP,KAAKa,UAAUW,QAAQC,uBAAuB,GAErDlB,OAAOP,KAAKU,UAAUgB,qBAO1BC,kBAAoB,KAClBpB,QAAO,IAAMP,KAAKU,WAAUkB,WAc9BC,MAAQC,MACNC,EAAO/B,KAAKU,SAASsB,oBAEfC,EAAS,QAACJ,MAAME,IAYxBG,cAAgBJ,MAAOK,UACfnC,KAAK6B,MAAM7B,KAAKa,UAAUsB,GAAeH,aAcjDI,KAAON,MACLO,EACAN,EAAO/B,KAAKU,SAASsB,oBAEfC,UAAUG,KAAKL,EAAMM,IAU7BC,aAAeR,MACbO,EACAF,WAEMnC,KAAKoC,KACTC,EACArC,KAAKa,UAAUsB,GAAeH,+CC7JpC,cAAoCrC,EAGlCI,YAAYwC,GACVC,QACAxC,KAAKJ,MAAQ6C,KAAKC,OAAOH,GAEzBvC,KAAK2C,+BAGGA,6BACRC,IAIA5C,KAAKJ,MAAMiD,oBAAoBvC,IAC7BN,KAAKH,cAAgBS,EAEd,CACLwC,OAAQ,IACNC,2BAAkB/C,KAAKF,aAAYkD,SAChCJ,GAAkBA,EAAetC,UAYxC2C,uBACF,OAAOjD,KAAKJ,MAOdsD,sBAAyBb,IACvBrC,KAAK2C,8BAA6B,IAAMN,KAO1Cc,yBACEC,IAEApD,KAAK2C,8BAA8BrC,GAAU8C,EAAe9C,4CCpDhE,cAAuCX,EAKrCI,YAAYwC,GACVC,QACAxC,KAAKJ,MAAQ6C,KAAKC,OAAOH,GAEzBvC,KAAK2C,+BAGGA,6BACRC,IAEA5C,KAAKJ,MAAMiD,oBAAoBvC,IAC7BN,KAAKH,cAAgBS,EAGnByC,MAAA,MAAA,CAAA,cAAkB/C,KAAKF,aACpBkD,SAAAJ,GAAkBA,EAAetC,SAWtC2C,uBACF,OAAOjD,KAAKJ,MAOdyD,gBAAmBhB,IACjBrC,KAAK2C,8BAA6B,IAAMN,KAO1CQ,mBACEO,IAEApD,KAAK2C,8BAA8BrC,GAAU8C,EAAe9C"}

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@ryanbrandt/react-testing-utils",
-  "version": "0.1.0",
+  "version": "0.4.0",
   "repository": "https://github.com/ryanbrandt/react-testing-utils",
-  "description": "Common Jest/React/RTL testing utilities",
+  "license": "MIT",
+  "description": "Jest/React/RTL component unit testing utilities",
   "author": "Ryan Brandt",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",
@@ -21,10 +22,11 @@
     "@rollup/plugin-commonjs": "^22.0.0",
     "@rollup/plugin-node-resolve": "^13.3.0",
     "@rollup/plugin-typescript": "^8.3.2",
+    "@testing-library/dom": "^8.13.0",
     "@testing-library/jest-dom": "^5.16.4",
     "@testing-library/react": "^13.0.1",
     "@testing-library/user-event": "^14.1.0",
-    "@types/jest": "^27.4.1",
+    "@types/jest": "^27.5.1",
     "@types/node": "^17.0.23",
     "@types/react": "^18.0.1",
     "@typescript-eslint/eslint-plugin": "^5.19.0",
@@ -34,22 +36,28 @@
     "eslint-config-prettier": "^8.5.0",
     "eslint-import-resolver-typescript": "^2.7.1",
     "eslint-plugin-import": "^2.26.0",
-    "jest": "^27.5.1",
+    "jest": "28.1.0",
+    "jest-environment-jsdom": "^28.1.0",
     "prettier": "^2.6.2",
     "react": "^18.0.0",
     "react-dom": "^18.0.0",
     "rollup": "^2.73.0",
     "rollup-plugin-peer-deps-external": "^2.2.4",
     "rollup-plugin-terser": "^7.0.2",
-    "ts-jest": "^27.1.4",
+    "ts-jest": "^28.0.2",
+    "ts-node": "^10.8.0",
+    "tslib": "^2.4.0",
     "ttypescript": "^1.5.13",
     "typescript": "^4.6.3",
     "typescript-transform-paths": "^3.3.1"
   },
   "peerDependencies": {
+    "@testing-library/dom": ">=8.13.0",
     "@testing-library/jest-dom": ">=5.14.1",
     "@testing-library/react": ">=12.1.2",
-    "jest": ">=27.3.1",
+    "@testing-library/user-event": ">=14.1.0",
+    "jest": ">=28.1.0",
+    "jest-environment-jsdom": ">=28.1.0",
     "react": ">=17.0.2",
     "react-dom": ">=17.0.2"
   },

package/dist/@types/jest/index.d.ts

@@ -1,7 +0,0 @@
-/// <reference types="jest" />
-declare type AnyFunction = (...args: any[]) => any;
-declare class JestUtilities {
-    static assertAsMockFunction: <T extends AnyFunction>(actual: T) => jest.MockedFunction<T>;
-    static assertAsMockClass: <T extends jest.Constructable>(actual: T) => jest.MockedClass<T>;
-}
-export default JestUtilities;

package/dist/@types/react/AbstractMockComponentWrapper.d.ts

@@ -1,58 +0,0 @@
-/// <reference types="jest" />
-import "@testing-library/jest-dom";
-/**
- * Abstract base mock component wrapper class
- */
-declare abstract class AbstractMockComponentWrapper<T> {
-    protected _mock: jest.Mocked<unknown>;
-    receivedProps: T;
-    /**
-     * The data-testid applied to the component mocks
-     */
-    DATA_TEST_ID: string;
-    constructor();
-    private _buildPropsExpectation;
-    /**
-     * Retrieves the root element of the mocked component, which will
-     * always be a div with the component data-testid applied
-     *
-     * Should only be used when one instance of the mock component is on the screen
-     */
-    get mockRoot(): HTMLElement;
-    /**
-     * Retrieves the root elements of all of the mocked component instances, which will
-     * always be a div with the component data-testid applied
-     *
-     * Can be used when multiple instances of the mock component are on the screen
-     */
-    get mockRoots(): HTMLElement[];
-    /**
-     * Asserts that the mock component was called with the provided subset of props
-     * @param props The subset of props to match against
-     */
-    assertCalledWith: (props: Partial<T>) => void;
-    /**
-     * Asserts that the mock component was last called with the provided subset of props
-     * @param props The subset of props to match against
-     */
-    assertLastCalledWith: (props: Partial<T>) => void;
-    /**
-     * Asserts that the mock component was nth called with the provided subset of props
-     * @param props The subset of props to match against
-     * @param n The render number to check against
-     */
-    assertNthCalledWith: (props: Partial<T>, n: number) => void;
-    /**
-     * Asserts that an instance of the component exists within the document
-     * @param allowMultiple Optional boolean to allow for multiple instances
-     * of the component to exist. When set false, if more than 1 instance
-     * of the component is on the screen this assertion will fail.
-     * @default true
-     */
-    assertOnScreen: (allowMultiple?: boolean) => void;
-    /**
-     * Asserts that the component is not currently rendered within the document
-     */
-    assertNotOnScreen: () => void;
-}
-export default AbstractMockComponentWrapper;

package/dist/@types/react/MockClassComponentWrapper.d.ts

@@ -1,33 +0,0 @@
-/// <reference types="jest" />
-import "@testing-library/jest-dom";
-import AbstractMockComponentWrapper from "./AbstractMockComponentWrapper";
-declare type ReactClassComponentWithProps<T> = React.ComponentClass<T>;
-/**
- * A standard mock class component wrapper
- *
- * @example
- * jest.mock("path/to/my/class/component");
- * const mockMyClassComponent = new MockClassComponentWrapper(MyClassComponent);
- */
-declare class MockClassComponentWrapper<T> extends AbstractMockComponentWrapper<T> {
-    protected _mock: jest.MockedClass<ReactClassComponentWithProps<T>>;
-    constructor(actual: ReactClassComponentWithProps<T>);
-    protected _configureMockImplementation: (valueGenerator?: (props: T) => JSX.Element | null) => void;
-    /**
-     * Not recommended, retrieves the actual mocked component instance
-     *
-     * Only should be used when truly necessary
-     */
-    get __OVERRIDE__mock(): jest.MockedClass<ReactClassComponentWithProps<T>>;
-    /**
-     * Mocks the return value of the render method
-     * @param value The value render should return
-     */
-    mockRenderReturnValue: (value: JSX.Element | null) => void;
-    /**
-     * Mocks the implementation of the render method
-     * @param implementation The implementation to apply to render
-     */
-    mockRenderImplementation: (implementation: (props: T) => JSX.Element | null) => void;
-}
-export default MockClassComponentWrapper;

package/dist/@types/react/MockFunctionComponentWrapper.d.ts

@@ -1,33 +0,0 @@
-/// <reference types="jest" />
-import "@testing-library/jest-dom";
-import AbstractMockComponentWrapper from "./AbstractMockComponentWrapper";
-declare type ReactFunctionComponentWithProps<T> = React.FunctionComponent<T>;
-/**
- * A standard mock function component wrapper
- *
- * @example
- * jest.mock("path/to/my/function/component");
- * const mockMyFunctionComponent = new MockFunctionComponentWrapper(MyFunctionComponent);
- */
-declare class MockFunctionComponentWrapper<T> extends AbstractMockComponentWrapper<T> {
-    protected _mock: jest.MockedFunction<ReactFunctionComponentWithProps<T>>;
-    constructor(actual: ReactFunctionComponentWithProps<T>);
-    protected _configureMockImplementation: (valueGenerator?: (props: T) => JSX.Element | null) => void;
-    /**
-     * Not recommended, retrieves the actual mocked component instance
-     *
-     * Only should be used when truly necessary
-     */
-    get __OVERRIDE__mock(): jest.MockedFunction<ReactFunctionComponentWithProps<T>>;
-    /**
-     * Mocks the return value of the function component
-     * @param value The value the mocked function component should return
-     */
-    mockReturnValue: (value: JSX.Element | null) => void;
-    /**
-     * Mocks the implementation of the function component
-     * @param implementation The implementation to apply to the mock function component
-     */
-    mockImplementation: (implementation: (props: T) => JSX.Element | null) => void;
-}
-export default MockFunctionComponentWrapper;

package/dist/@types/src/index.d.ts

@@ -1,3 +0,0 @@
-export { default as JestUtilities } from "./jest";
-export { default as MockClassComponentWrapper } from "./react/MockClassComponentWrapper";
-export { default as MockFunctionComponentWrapper } from "./react/MockFunctionComponentWrapper";

package/dist/@types/src/jest/index.d.ts

@@ -1,7 +0,0 @@
-/// <reference types="jest" />
-declare type AnyFunction = (...args: any[]) => any;
-declare class JestUtilities {
-    static assertAsMockFunction: <T extends AnyFunction>(actual: T) => jest.MockedFunction<T>;
-    static assertAsMockClass: <T extends jest.Constructable>(actual: T) => jest.MockedClass<T>;
-}
-export default JestUtilities;

package/dist/@types/src/react/AbstractMockComponentWrapper.d.ts

@@ -1,58 +0,0 @@
-/// <reference types="jest" />
-import "@testing-library/jest-dom";
-/**
- * Abstract base mock component wrapper class
- */
-declare abstract class AbstractMockComponentWrapper<T> {
-    protected _mock: jest.Mocked<unknown>;
-    receivedProps: T;
-    /**
-     * The data-testid applied to the component mocks
-     */
-    DATA_TEST_ID: string;
-    constructor();
-    private _buildPropsExpectation;
-    /**
-     * Retrieves the root element of the mocked component, which will
-     * always be a div with the component data-testid applied
-     *
-     * Should only be used when one instance of the mock component is on the screen
-     */
-    get mockRoot(): HTMLElement;
-    /**
-     * Retrieves the root elements of all of the mocked component instances, which will
-     * always be a div with the component data-testid applied
-     *
-     * Can be used when multiple instances of the mock component are on the screen
-     */
-    get mockRoots(): HTMLElement[];
-    /**
-     * Asserts that the mock component was called with the provided subset of props
-     * @param props The subset of props to match against
-     */
-    assertCalledWith: (props: Partial<T>) => void;
-    /**
-     * Asserts that the mock component was last called with the provided subset of props
-     * @param props The subset of props to match against
-     */
-    assertLastCalledWith: (props: Partial<T>) => void;
-    /**
-     * Asserts that the mock component was nth called with the provided subset of props
-     * @param props The subset of props to match against
-     * @param n The render number to check against
-     */
-    assertNthCalledWith: (props: Partial<T>, n: number) => void;
-    /**
-     * Asserts that an instance of the component exists within the document
-     * @param allowMultiple Optional boolean to allow for multiple instances
-     * of the component to exist. When set false, if more than 1 instance
-     * of the component is on the screen this assertion will fail.
-     * @default true
-     */
-    assertOnScreen: (allowMultiple?: boolean) => void;
-    /**
-     * Asserts that the component is not currently rendered within the document
-     */
-    assertNotOnScreen: () => void;
-}
-export default AbstractMockComponentWrapper;