@trackunit/react-core-contexts-test 0.1.75 → 0.1.77

package/src/TrackunitProvidersMockBuilder.d.ts

@@ -1,304 +1,326 @@
-import { MockedResponse } from "@apollo/client/testing";
-import { RenderResult } from "@testing-library/react";
-import { IAnalyticsContext, IAssetSortingContext, ICurrentUserContext, IEnvironmentContext, IGlobalSelectionContext, IOemBrandingContext, IToastContext, ITokenContext, IUserSubscriptionContext } from "@trackunit/react-core-contexts-api";
-import * as React from "react";
-import { MemoryRouterProps } from "react-router-dom";
-/**
- * This builder allows you to enable trackunit providers using the builder pattern, and then call 1 of either:
- * For React Components:
- * - render
- * For React Hooks:
- * - renderHook
- * For Storybook:
- * - storybook
- */
-export declare class TrackunitProvidersMockBuilder {
-    protected selectedEnvironmentContext: IEnvironmentContext;
-    protected selectedTokenContext: ITokenContext;
-    protected selectedApolloMocks: MockedResponse[];
-    protected selectedRouterProps: MemoryRouterProps;
-    protected selectedToastContext: IToastContext;
-    protected selectedGlobalSelection: IGlobalSelectionContext;
-    protected selectedAssetSortingContext: IAssetSortingContext;
-    protected selectedCurrentUserContext: ICurrentUserContext;
-    protected selectedAnalyticsContext: IAnalyticsContext<{}>;
-    protected selectedOemBrandingContext: IOemBrandingContext;
-    protected selectedUserSubscriptionContext: IUserSubscriptionContext;
-    /**
-     * Use this Analytics Context.
-     * Defaults to mockAnalyticsContext.
-     *
-     * @see mockAnalyticsContext
-     * @example
-     * ...
-     * it("should allow render", async () => {
-     *   await trackunitProviders().analytics(yourPartialAnalyticsMock).render(<YourTestComponent data-testid="yourTestId" />);
-     *   expect(screen.getByTestId("yourTestId")).toBeInTheDocument();
-     * });
-     * ...
-     * @example
-     * ...
-     * it("should allow renderHook", async () => {
-     *   const { result } = await trackunitProviders().analytics(yourPartialAnalyticsMock).renderHook(() => useYourTestHook());
-     *   expect(result.current).toEqual(anything());
-     * });
-     * ...
-     * @param analyticsContext - The analytics context to use.
-     * @returns { TrackunitProvidersMockBuilder } - The builder.
-     */
-    analytics(analyticsContext: Partial<IAnalyticsContext<any>>): this;
-    /**
-     * Use this Environment Context.
-     * Defaults to mockEnvironmentContext.
-     *
-     * @see mockEnvironmentContext
-     * @example
-     * ...
-     * it("should allow render", async () => {
-     *   await trackunitProviders().environment(yourPartialEnvironmentsMock).render(<YourTestComponent data-testid="yourTestId" />);
-     *   expect(screen.getByTestId("yourTestId")).toBeInTheDocument();
-     * });
-     * ...
-     * @example
-     * ...
-     * it("should allow renderHook", async () => {
-     *   const { result } = await trackunitProviders().environment(yourPartialEnvironmentMock).renderHook(() => useYourTestHook());
-     *   expect(result.current).toEqual(anything());
-     * });
-     * ...
-     * @param environmentContext - The environment context to use.
-     * @returns { TrackunitProvidersMockBuilder } - The builder.
-     */
-    environment(environmentContext: Partial<IEnvironmentContext>): this;
-    /**
-     * Use this to pass in a differerent current user.
-     * Defaults to mockCurrentUserContext.
-     *
-     * @see mockCurrentUserContext
-     * @example
-     * ...
-     * it("should allow render", async () => {
-     *   await trackunitProviders().currentUser(yourPartialCurrentUserMock).render(<YourTestComponent data-testid="yourTestId" />);
-     *   expect(screen.getByTestId("yourTestId")).toBeInTheDocument();
-     * });
-     * ...
-     * @example
-     * ...
-     * it("should allow renderHook", async () => {
-     *   const { result } = await trackunitProviders().currentUser(yourPartialCurrentUserMock).renderHook(() => useYourTestHook());
-     *   expect(result.current).toEqual(anything());
-     * });
-     * ...
-     * @returns { TrackunitProvidersMockBuilder } - The builder.
-     */
-    currentUser(currentUserContext: Partial<ICurrentUserContext>): this;
-    /**
-     * Use this to pass in a differerent current user subscription.
-     * Defaults to mockUserSubscriptionContext.
-     *
-     * @see mockUserSubscriptionContext
-     * @example
-     * ...
-     * it("should allow render", async () => {
-     *   await trackunitProviders().userSubscription(yourPartialUserSubscriptionMock).render(<YourTestComponent data-testid="yourTestId" />);
-     *   expect(screen.getByTestId("yourTestId")).toBeInTheDocument();
-     * });
-     * ...
-     * @example
-     * ...
-     * it("should allow renderHook", async () => {
-     *   const { result } = await trackunitProviders().userSubscription(yourPartialUserSubscriptionMock).renderHook(() => useYourTestHook());
-     *   expect(result.current).toEqual(anything());
-     * });
-     * ...
-     * @returns { TrackunitProvidersMockBuilder } - The builder.
-     */
-    userSubscription(userSubscription: Partial<IUserSubscriptionContext> | {
-        features: string[];
-    }): this;
-    /**
-     * Set global asset sorting context.
-     * Defaults to mockAssetSortingContext.
-     *
-     * @see mockAssetSortingContext
-     * @example
-     * ...
-     * it("should allow render", async () => {
-     *   await trackunitProviders().assetSorting(yourPartialAssetSortingMock).render(<YourTestComponent data-testid="yourTestId" />);
-     *   expect(screen.getByTestId("yourTestId")).toBeInTheDocument();
-     * });
-     * ...
-     * @example
-     * ...
-     * it("should allow renderHook", async () => {
-     *   const { result } = await trackunitProviders().assetSorting(yourPartialAssetSortingMock).renderHook(() => useYourTestHook());
-     *   expect(result.current).toEqual(anything());
-     * });
-     * ...
-     * @param assetSortingContext - Override the default context.
-     * @returns { TrackunitProvidersMockBuilder } - The builder.
-     */
-    assetSorting(assetSortingContext: Partial<IAssetSortingContext>): this;
-    /**
-     * Set OEM Branding context.
-     * Defaults to mockOemBrandingContext.
-     *
-     * @see mockOemBrandingContext
-     * @example
-     * ...
-     * it("should allow render", async () => {
-     *   await trackunitProviders().oemBrandingContext(yourPartialOemBrandingMock).render(<YourTestComponent data-testid="yourTestId" />);
-     *   expect(screen.getByTestId("yourTestId")).toBeInTheDocument();
-     * });
-     * ...
-     * @example
-     * ...
-     * it("should allow renderHook", async () => {
-     *   const { result } = await trackunitProviders().oemBrandingContext(yourPartialOemBrandingMock).renderHook(() => useYourTestHook());
-     *   expect(result.current).toEqual(anything());
-     * });
-     * ...
-     * @param oemBrandingContext - Override the default context.
-     */
-    oemBrandingContext(oemBrandingContext: Partial<IOemBrandingContext>): this;
-    /**
-     * Use this ToastContext with the given mocks.
-     * Defaults to mockToastContext.
-     *
-     * @see mockToastContext
-     * @example
-     * ...
-     * it("should allow render", async () => {
-     *   await trackunitProviders().toast(yourPartialToastMock).render(<YourTestComponent data-testid="yourTestId" />);
-     *   expect(screen.getByTestId("yourTestId")).toBeInTheDocument();
-     * });
-     * ...
-     * @example
-     * ...
-     * it("should allow renderHook", async () => {
-     *   const { result } = await trackunitProviders().toast(yourPartialToastMock).renderHook(() => useYourTestHook());
-     *   expect(result.current).toEqual(anything());
-     * });
-     * ...
-     * @param toastContext - Override the default toast context.
-     */
-    toast(toastContext: Partial<IToastContext>): this;
-    /**
-     * Use this global selection.
-     * Defaults to null.
-     *
-     * @example
-     * ...
-     * it("should allow render", async () => {
-     *   await trackunitProviders().globalSelection(yourGlobalSelectionMock).render(<YourTestComponent data-testid="yourTestId" />);
-     *   expect(screen.getByTestId("yourTestId")).toBeInTheDocument();
-     * });
-     * ...
-     * @example
-     * ...
-     * it("should allow renderHook", async () => {
-     *   const { result } = await trackunitProviders().globalSelection(yourGlobalSelectionMock).renderHook(() => useYourTestHook());
-     *   expect(result.current).toEqual(anything());
-     * });
-     * ...
-     * @param globalSelection - The global selection to use.
-     * @returns { TrackunitProvidersMockBuilder } - The builder.
-     */
-    globalSelection(globalSelection: IGlobalSelectionContext["selection"]): this;
-    /**
-     * Use this token.
-     *
-     * @example
-     * ...
-     * it("should allow render", async () => {
-     *   await trackunitProviders().token(yourMockedToken).render(<YourTestComponent data-testid="yourTestId" />);
-     *   expect(screen.getByTestId("yourTestId")).toBeInTheDocument();
-     * });
-     * ...
-     * @example
-     * ...
-     * it("should allow renderHook", async () => {
-     *   const { result } = await trackunitProviders().token(yourMockedToken).renderHook(() => useYourTestHook());
-     *   expect(result.current).toEqual(anything());
-     * });
-     * ...
-     * @param token - The token to use.
-     * @returns { TrackunitProvidersMockBuilder } - The builder.
-     */
-    token(token: string): this;
-    /**
-     * Use this Router Props with the given mocks.
-     *
-     * @example
-     * ...
-     * it("should allow render", async () => {
-     *   await trackunitProviders().routerProps(yourRouterPropsMock).render(<YourTestComponent data-testid="yourTestId" />);
-     *   expect(screen.getByTestId("yourTestId")).toBeInTheDocument();
-     * });
-     * ...
-     * @example
-     * ...
-     * it("should allow renderHook", async () => {
-     *   const { result } = await trackunitProviders().routerProps(yourRouterPropsMock).renderHook(() => useYourTestHook());
-     *   expect(result.current).toEqual(anything());
-     * });
-     * ...
-     * @param routerProps - The router props to use.
-     * @returns { TrackunitProvidersMockBuilder } - The builder.
-     */
-    routerProps(routerProps: MemoryRouterProps): this;
-    /**
-     * Use this Manager Apollo Context Provider with the given mocks.
-     *
-     * @see https://www.apollographql.com/docs/react/development-testing/testing
-     * @example
-     * ...
-     * it("should allow render", async () => {
-     *   await trackunitProviders().apollo([yourApolloMocks]).render(<YourTestComponent data-testid="yourTestId" />);
-     *   expect(screen.getByTestId("yourTestId")).toBeInTheDocument();
-     * });
-     * ...
-     * @example
-     * ...
-     * it("should allow renderHook", async () => {
-     *   const { result } = await trackunitProviders().apollo([yourApolloMocks]).renderHook(() => useYourTestHook());
-     *   expect(result.current).toEqual(anything());
-     * });
-     * ...
-     * @param apolloMocks - The mocks to use for the ApolloProvider.
-     */
-    apollo(apolloMocks?: MockedResponse[]): this;
-    /**
-     * Validate the mocks that has been supplied to make sure they make sense.
-     * Note: This function is overriden in builders extending this one.
-     *
-     * @returns {boolean} true or throws error if any invalid mocks
-     */
-    protected validateSuppliedMocks(): true | never;
-    /**
-     * Make sure this represent the same structure as the main index.tsx does.
-     *
-     * @param testChildren - the child element being tested.
-     * @param addTestRootContainer - if you want to add a root container to the test.
-     */
-    protected getMockedCompositionRoot(testChildren: React.ReactNode, addTestRootContainer?: boolean): JSX.Element;
-    /**
-     * This will return the mocked composition root.
-     */
-    renderHook<TProps, TResult>(callback: (props: TProps) => TResult, parentElement?: (children: React.ReactElement) => React.ReactElement): Promise<import("@testing-library/react").RenderHookResult<TResult, TProps>>;
-    /**
-     * This will use react-testing-library.render the child in the correct mocked hierarchy of context providers.
-     *
-     * @see https://testing-library.com/docs/react-testing-library/api#render
-     * @param child - the child element being tested.
-     */
-    render(child: React.ReactElement): Promise<RenderResult<typeof import("@testing-library/dom/types/queries"), HTMLElement, HTMLElement>>;
-    /**
-     *  This will return the children in the correct mocked hierarchy of context providers.
-     */
-    storybook(child: React.ReactNode): JSX.Element;
-}
-/**
- * This is the default mock builder for the TrackunitProviders.
- */
-export declare const trackunitProviders: () => TrackunitProvidersMockBuilder;
+import { MockedResponse } from "@apollo/client/testing";
+import { RenderResult } from "@testing-library/react";
+import { IAnalyticsContext, IAssetSortingContext, ICurrentUserContext, IEnvironmentContext, IGlobalSelectionContext, IOemBrandingContext, IToastContext, ITokenContext, IUserSubscriptionContext } from "@trackunit/react-core-contexts-api";
+import * as React from "react";
+import { MemoryRouterProps } from "react-router-dom";
+/**
+ * This builder allows you to enable trackunit providers using the builder pattern, and then call 1 of either:
+ * For React Components:
+ * - render
+ * For React Hooks:
+ * - renderHook
+ * For Storybook:
+ * - storybook
+ */
+export declare class TrackunitProvidersMockBuilder {
+    protected selectedEnvironmentContext: IEnvironmentContext;
+    protected selectedTokenContext: ITokenContext;
+    protected selectedApolloMocks: MockedResponse[];
+    protected selectedRouterProps: MemoryRouterProps;
+    protected selectedToastContext: IToastContext;
+    protected selectedGlobalSelection: IGlobalSelectionContext;
+    protected selectedAssetSortingContext: IAssetSortingContext;
+    protected selectedCurrentUserContext: ICurrentUserContext;
+    protected selectedAnalyticsContext: IAnalyticsContext<{}>;
+    protected selectedOemBrandingContext: IOemBrandingContext;
+    protected selectedUserSubscriptionContext: IUserSubscriptionContext;
+    /**
+     * Use this Analytics Context.
+     * Defaults to mockAnalyticsContext.
+     *
+     * This context is used by the useAnalytics hook from lib "@trackunit/react-core-hooks"
+     *
+     * @see mockAnalyticsContext
+     * @example
+     * ...
+     * it("should allow render", async () => {
+     *   await trackunitProviders().analytics(yourPartialAnalyticsMock).render(<YourTestComponent data-testid="yourTestId" />);
+     *   expect(screen.getByTestId("yourTestId")).toBeInTheDocument();
+     * });
+     * ...
+     * @example
+     * ...
+     * it("should allow renderHook", async () => {
+     *   const { result } = await trackunitProviders().analytics(yourPartialAnalyticsMock).renderHook(() => useYourTestHook());
+     *   expect(result.current).toEqual(anything());
+     * });
+     * ...
+     * @param analyticsContext - The analytics context to use.
+     * @returns { TrackunitProvidersMockBuilder } - The builder.
+     */
+    analytics(analyticsContext: Partial<IAnalyticsContext<any>>): this;
+    /**
+     * Use this Environment Context.
+     * Defaults to mockEnvironmentContext.
+     *
+     * This context is used by the useEnvironment hook from lib "@trackunit/react-core-hooks"
+     *
+     * @see mockEnvironmentContext
+     * @example
+     * ...
+     * it("should allow render", async () => {
+     *   await trackunitProviders().environment(yourPartialEnvironmentsMock).render(<YourTestComponent data-testid="yourTestId" />);
+     *   expect(screen.getByTestId("yourTestId")).toBeInTheDocument();
+     * });
+     * ...
+     * @example
+     * ...
+     * it("should allow renderHook", async () => {
+     *   const { result } = await trackunitProviders().environment(yourPartialEnvironmentMock).renderHook(() => useYourTestHook());
+     *   expect(result.current).toEqual(anything());
+     * });
+     * ...
+     * @param environmentContext - The environment context to use.
+     * @returns { TrackunitProvidersMockBuilder } - The builder.
+     */
+    environment(environmentContext: Partial<IEnvironmentContext>): this;
+    /**
+     * Use this to pass in a differerent current user.
+     * Defaults to mockCurrentUserContext.
+     *
+     * This context is used by the useCurrentUser hook from lib "@trackunit/react-core-hooks"
+     *
+     * @see mockCurrentUserContext
+     * @example
+     * ...
+     * it("should allow render", async () => {
+     *   await trackunitProviders().currentUser(yourPartialCurrentUserMock).render(<YourTestComponent data-testid="yourTestId" />);
+     *   expect(screen.getByTestId("yourTestId")).toBeInTheDocument();
+     * });
+     * ...
+     * @example
+     * ...
+     * it("should allow renderHook", async () => {
+     *   const { result } = await trackunitProviders().currentUser(yourPartialCurrentUserMock).renderHook(() => useYourTestHook());
+     *   expect(result.current).toEqual(anything());
+     * });
+     * ...
+     * @returns { TrackunitProvidersMockBuilder } - The builder.
+     */
+    currentUser(currentUserContext: Partial<ICurrentUserContext>): this;
+    /**
+     * Use this to pass in a differerent current user subscription.
+     * Defaults to mockUserSubscriptionContext.
+     *
+     * This context is used by the useUserSubscription hook from lib "@trackunit/react-core-hooks"
+     *
+     * @see mockUserSubscriptionContext
+     * @example
+     * ...
+     * it("should allow render", async () => {
+     *   await trackunitProviders().userSubscription(yourPartialUserSubscriptionMock).render(<YourTestComponent data-testid="yourTestId" />);
+     *   expect(screen.getByTestId("yourTestId")).toBeInTheDocument();
+     * });
+     * ...
+     * @example
+     * ...
+     * it("should allow renderHook", async () => {
+     *   const { result } = await trackunitProviders().userSubscription(yourPartialUserSubscriptionMock).renderHook(() => useYourTestHook());
+     *   expect(result.current).toEqual(anything());
+     * });
+     * ...
+     * @returns { TrackunitProvidersMockBuilder } - The builder.
+     */
+    userSubscription(userSubscription: Partial<IUserSubscriptionContext> | {
+        features: string[];
+    }): this;
+    /**
+     * Set global asset sorting context.
+     * Defaults to mockAssetSortingContext.
+     *
+     * This context is used by the useAssetSorting hook from lib "@trackunit/react-core-hooks"
+     *
+     * @see mockAssetSortingContext
+     * @example
+     * ...
+     * it("should allow render", async () => {
+     *   await trackunitProviders().assetSorting(yourPartialAssetSortingMock).render(<YourTestComponent data-testid="yourTestId" />);
+     *   expect(screen.getByTestId("yourTestId")).toBeInTheDocument();
+     * });
+     * ...
+     * @example
+     * ...
+     * it("should allow renderHook", async () => {
+     *   const { result } = await trackunitProviders().assetSorting(yourPartialAssetSortingMock).renderHook(() => useYourTestHook());
+     *   expect(result.current).toEqual(anything());
+     * });
+     * ...
+     * @param assetSortingContext - Override the default context.
+     * @returns { TrackunitProvidersMockBuilder } - The builder.
+     */
+    assetSorting(assetSortingContext: Partial<IAssetSortingContext>): this;
+    /**
+     * Set OEM Branding context.
+     * Defaults to mockOemBrandingContext.
+     *
+     * This context is used by the useAssetSorting hook from lib "@trackunit/react-core-hooks"
+     *
+     * @see mockOemBrandingContext
+     * @example
+     * ...
+     * it("should allow render", async () => {
+     *   await trackunitProviders().oemBrandingContext(yourPartialOemBrandingMock).render(<YourTestComponent data-testid="yourTestId" />);
+     *   expect(screen.getByTestId("yourTestId")).toBeInTheDocument();
+     * });
+     * ...
+     * @example
+     * ...
+     * it("should allow renderHook", async () => {
+     *   const { result } = await trackunitProviders().oemBrandingContext(yourPartialOemBrandingMock).renderHook(() => useYourTestHook());
+     *   expect(result.current).toEqual(anything());
+     * });
+     * ...
+     * @param oemBrandingContext - Override the default context.
+     */
+    oemBrandingContext(oemBrandingContext: Partial<IOemBrandingContext>): this;
+    /**
+     * Use this ToastContext with the given mocks.
+     * Defaults to mockToastContext.
+     *
+     * This context is used by the useToast hook from lib "@trackunit/react-core-hooks"
+     *
+     * @see mockToastContext
+     * @example
+     * ...
+     * it("should allow render", async () => {
+     *   await trackunitProviders().toast(yourPartialToastMock).render(<YourTestComponent data-testid="yourTestId" />);
+     *   expect(screen.getByTestId("yourTestId")).toBeInTheDocument();
+     * });
+     * ...
+     * @example
+     * ...
+     * it("should allow renderHook", async () => {
+     *   const { result } = await trackunitProviders().toast(yourPartialToastMock).renderHook(() => useYourTestHook());
+     *   expect(result.current).toEqual(anything());
+     * });
+     * ...
+     * @param toastContext - Override the default toast context.
+     */
+    toast(toastContext: Partial<IToastContext>): this;
+    /**
+     * Use this global selection.
+     * Defaults to null.
+     *
+     * This context is used by the useGlobalSelection hook from lib "@trackunit/react-core-hooks"
+     *
+     * @example
+     * ...
+     * it("should allow render", async () => {
+     *   await trackunitProviders().globalSelection(yourGlobalSelectionMock).render(<YourTestComponent data-testid="yourTestId" />);
+     *   expect(screen.getByTestId("yourTestId")).toBeInTheDocument();
+     * });
+     * ...
+     * @example
+     * ...
+     * it("should allow renderHook", async () => {
+     *   const { result } = await trackunitProviders().globalSelection(yourGlobalSelectionMock).renderHook(() => useYourTestHook());
+     *   expect(result.current).toEqual(anything());
+     * });
+     * ...
+     * @param globalSelection - The global selection to use.
+     * @returns { TrackunitProvidersMockBuilder } - The builder.
+     */
+    globalSelection(globalSelection: IGlobalSelectionContext["selection"]): this;
+    /**
+     * Use this token.
+     *
+     * This context is used by the useToken hook from lib "@trackunit/react-core-hooks"
+     *
+     * @example
+     * ...
+     * it("should allow render", async () => {
+     *   await trackunitProviders().token(yourMockedToken).render(<YourTestComponent data-testid="yourTestId" />);
+     *   expect(screen.getByTestId("yourTestId")).toBeInTheDocument();
+     * });
+     * ...
+     * @example
+     * ...
+     * it("should allow renderHook", async () => {
+     *   const { result } = await trackunitProviders().token(yourMockedToken).renderHook(() => useYourTestHook());
+     *   expect(result.current).toEqual(anything());
+     * });
+     * ...
+     * @param token - The token to use.
+     * @returns { TrackunitProvidersMockBuilder } - The builder.
+     */
+    token(token: string): this;
+    /**
+     * Use this Router Props with the given mocks.
+     *
+     * This is used to provide a MemoryRouter from lib "react-router-dom"
+     *
+     * @example
+     * ...
+     * it("should allow render", async () => {
+     *   await trackunitProviders().routerProps(yourRouterPropsMock).render(<YourTestComponent data-testid="yourTestId" />);
+     *   expect(screen.getByTestId("yourTestId")).toBeInTheDocument();
+     * });
+     * ...
+     * @example
+     * ...
+     * it("should allow renderHook", async () => {
+     *   const { result } = await trackunitProviders().routerProps(yourRouterPropsMock).renderHook(() => useYourTestHook());
+     *   expect(result.current).toEqual(anything());
+     * });
+     * ...
+     * @param routerProps - The router props to use.
+     * @returns { TrackunitProvidersMockBuilder } - The builder.
+     */
+    routerProps(routerProps: MemoryRouterProps): this;
+    /**
+     * Use this Manager Apollo Context Provider with the given mocks.
+     *
+     * This context is used by the useQuery and useLazyQuery hook from lib "@apollo/client"
+     *
+     * @see https://www.apollographql.com/docs/react/development-testing/testing
+     * @example
+     * ...
+     * it("should allow render", async () => {
+     *   await trackunitProviders().apollo([yourApolloMocks]).render(<YourTestComponent data-testid="yourTestId" />);
+     *   expect(screen.getByTestId("yourTestId")).toBeInTheDocument();
+     * });
+     * ...
+     * @example
+     * ...
+     * it("should allow renderHook", async () => {
+     *   const { result } = await trackunitProviders().apollo([yourApolloMocks]).renderHook(() => useYourTestHook());
+     *   expect(result.current).toEqual(anything());
+     * });
+     * ...
+     * @param apolloMocks - The mocks to use for the ApolloProvider.
+     */
+    apollo(apolloMocks?: MockedResponse[]): this;
+    /**
+     * Validate the mocks that has been supplied to make sure they make sense.
+     * Note: This function is overriden in builders extending this one.
+     *
+     * @returns {boolean} true or throws error if any invalid mocks
+     */
+    protected validateSuppliedMocks(): true | never;
+    /**
+     * Make sure this represent the same structure as the main index.tsx does.
+     *
+     * @param testChildren - the child element being tested.
+     * @param addTestRootContainer - if you want to add a root container to the test.
+     */
+    protected getMockedCompositionRoot(testChildren: React.ReactNode, addTestRootContainer?: boolean): JSX.Element;
+    /**
+     * This will return the mocked composition root.
+     */
+    renderHook<TProps, TResult>(callback: (props: TProps) => TResult, parentElement?: (children: React.ReactElement) => React.ReactElement): Promise<import("@testing-library/react").RenderHookResult<TResult, TProps>>;
+    /**
+     * This will use react-testing-library.render the child in the correct mocked hierarchy of context providers.
+     *
+     * @see https://testing-library.com/docs/react-testing-library/api#render
+     * @param child - the child element being tested.
+     */
+    render(child: React.ReactElement): Promise<RenderResult>;
+    /**
+     *  This will return the children in the correct mocked hierarchy of context providers.
+     */
+    storybook(child: React.ReactNode): JSX.Element;
+}
+/**
+ * This is the default mock builder for the TrackunitProviders.
+ */
+export declare const trackunitProviders: () => TrackunitProvidersMockBuilder;