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

package/index2.cjs

@@ -160,6 +160,7 @@ const mockEnvironmentContext = {
     managerClassicUrl: "https://sso.trackunit.com",
     googleMapsApiKey: "",
     amplitudeApiKey: "",
+    amplitudeApiEndpoint: "",
     graphqlPublicUrl: "",
     graphqlManagerUrl: "",
     graphqlManagerImageUploadUrl: "",
@@ -345,6 +346,20 @@ class TrackunitProvidersMockBuilder {
      * 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.
      */
@@ -358,6 +373,20 @@ class TrackunitProvidersMockBuilder {
      * 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.
      */
@@ -370,6 +399,20 @@ class TrackunitProvidersMockBuilder {
      * 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) {
@@ -381,6 +424,20 @@ class TrackunitProvidersMockBuilder {
      * 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) {
@@ -400,6 +457,20 @@ class TrackunitProvidersMockBuilder {
      * 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.
      */
@@ -412,6 +483,20 @@ class TrackunitProvidersMockBuilder {
      * 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) {
@@ -423,6 +508,20 @@ class TrackunitProvidersMockBuilder {
      * 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) {
@@ -433,6 +532,20 @@ class TrackunitProvidersMockBuilder {
      * 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.
      */
@@ -443,6 +556,20 @@ class TrackunitProvidersMockBuilder {
     /**
      * 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.
      */
@@ -453,6 +580,20 @@ class TrackunitProvidersMockBuilder {
     /**
      * 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.
      */
@@ -463,6 +604,21 @@ class TrackunitProvidersMockBuilder {
     /**
      * 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) {

package/index2.js

@@ -154,6 +154,7 @@ const mockEnvironmentContext = {
     managerClassicUrl: "https://sso.trackunit.com",
     googleMapsApiKey: "",
     amplitudeApiKey: "",
+    amplitudeApiEndpoint: "",
     graphqlPublicUrl: "",
     graphqlManagerUrl: "",
     graphqlManagerImageUploadUrl: "",
@@ -339,6 +340,20 @@ class TrackunitProvidersMockBuilder {
      * 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.
      */
@@ -352,6 +367,20 @@ class TrackunitProvidersMockBuilder {
      * 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.
      */
@@ -364,6 +393,20 @@ class TrackunitProvidersMockBuilder {
      * 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) {
@@ -375,6 +418,20 @@ class TrackunitProvidersMockBuilder {
      * 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) {
@@ -394,6 +451,20 @@ class TrackunitProvidersMockBuilder {
      * 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.
      */
@@ -406,6 +477,20 @@ class TrackunitProvidersMockBuilder {
      * 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) {
@@ -417,6 +502,20 @@ class TrackunitProvidersMockBuilder {
      * 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) {
@@ -427,6 +526,20 @@ class TrackunitProvidersMockBuilder {
      * 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.
      */
@@ -437,6 +550,20 @@ class TrackunitProvidersMockBuilder {
     /**
      * 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.
      */
@@ -447,6 +574,20 @@ class TrackunitProvidersMockBuilder {
     /**
      * 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.
      */
@@ -457,6 +598,21 @@ class TrackunitProvidersMockBuilder {
     /**
      * 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) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-contexts-test",
-  "version": "0.1.73",
+  "version": "0.1.75",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -12,8 +12,8 @@
   "types": "./src/index.d.ts",
   "dependencies": {
     "@apollo/client": "3.7.10",
-    "@trackunit/react-core-contexts-api": "0.2.39",
-    "@trackunit/react-core-hooks": "0.2.63",
+    "@trackunit/react-core-contexts-api": "0.2.40",
+    "@trackunit/react-core-hooks": "0.2.64",
     "@trackunit/tailwind-styled-components": "0.0.57",
     "graphql": "15.8.0",
     "lodash": "4.17.21",

package/src/TrackunitProvidersMockBuilder.d.ts

@@ -29,6 +29,20 @@ export declare class TrackunitProvidersMockBuilder {
      * 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.
      */
@@ -38,6 +52,20 @@ export declare class TrackunitProvidersMockBuilder {
      * 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.
      */
@@ -47,6 +75,20 @@ export declare class TrackunitProvidersMockBuilder {
      * 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;
@@ -55,6 +97,20 @@ export declare class TrackunitProvidersMockBuilder {
      * 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> | {
@@ -65,6 +121,20 @@ export declare class TrackunitProvidersMockBuilder {
      * 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.
      */
@@ -74,6 +144,20 @@ export declare class TrackunitProvidersMockBuilder {
      * 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;
@@ -82,6 +166,20 @@ export declare class TrackunitProvidersMockBuilder {
      * 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;
@@ -89,6 +187,20 @@ export declare class TrackunitProvidersMockBuilder {
      * 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.
      */
@@ -96,6 +208,20 @@ export declare class TrackunitProvidersMockBuilder {
     /**
      * 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.
      */
@@ -103,6 +229,20 @@ export declare class TrackunitProvidersMockBuilder {
     /**
      * 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.
      */
@@ -110,6 +250,21 @@ export declare class TrackunitProvidersMockBuilder {
     /**
      * 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;