@trackunit/react-core-contexts-test 0.1.56 → 0.1.57

package/HookRenderer.cjs

@@ -20,7 +20,7 @@ require('graphql');
  *
  * @param callback The callback to render the hook.
  * @param getMockedCompositionRoot A function that will return the mocked composition root.
- * @returns The rendered hook.
+ * @returns { Promise<RenderHookResult> } The rendered hook.
  */
 const reactHooksRenderHook = (callback, getMockedCompositionRoot) => index.__awaiter(void 0, void 0, void 0, function* () {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any

package/HookRenderer.js

@@ -18,7 +18,7 @@ import 'graphql';
  *
  * @param callback The callback to render the hook.
  * @param getMockedCompositionRoot A function that will return the mocked composition root.
- * @returns The rendered hook.
+ * @returns { Promise<RenderHookResult> } The rendered hook.
  */
 const reactHooksRenderHook = (callback, getMockedCompositionRoot) => __awaiter(void 0, void 0, void 0, function* () {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any

package/index.cjs

@@ -21,6 +21,7 @@ exports.MockContextProviderBuilder = index.MockContextProviderBuilder;
 exports.doNothing = index.doNothing;
 exports.flushPromises = index.flushPromises;
 exports.flushPromisesInAct = index.flushPromisesInAct;
+exports.mockAnalyticsContext = index.mockAnalyticsContext;
 exports.mockCurrentUserContext = index.mockCurrentUserContext;
 exports.mockEnvironmentContext = index.mockEnvironmentContext;
 exports.queryFor = index.queryFor;

package/index.js

@@ -1,4 +1,4 @@
-export { M as MockContextProviderBuilder, d as doNothing, f as flushPromises, b as flushPromisesInAct, m as mockCurrentUserContext, a as mockEnvironmentContext, q as queryFor, r as rootContext, u as useLogPropsChanged, v as validateIrisApp } from './index2.js';
+export { M as MockContextProviderBuilder, d as doNothing, f as flushPromises, c as flushPromisesInAct, m as mockAnalyticsContext, a as mockCurrentUserContext, b as mockEnvironmentContext, q as queryFor, r as rootContext, u as useLogPropsChanged, v as validateIrisApp } from './index2.js';
 import 'react/jsx-runtime';
 import '@testing-library/react';
 import '@trackunit/react-core-contexts-api';

package/index2.cjs

@@ -93,6 +93,13 @@ const doNothing = () => {
     /* Do nothing */
 };
 
+const mockAnalyticsContext = {
+    logEvent: doNothing,
+    logError: doNothing,
+    logPageView: doNothing,
+    setUserProperty: doNothing,
+};
+
 const mockAssetSortingContext = {
     setSortBy: doNothing,
     sortingState: {
@@ -148,7 +155,7 @@ const mockToastContext = {
  *
  * @param features - array of features
  * @param packageType - package type
- * @returns IUserSubscriptionContext
+ * @returns { IUserSubscriptionContext }- mock for the UserSubscriptionContext
  */
 const mockUserSubscriptionProviderValue = (features, packageType) => {
     return {
@@ -217,11 +224,23 @@ class MockContextProviderBuilder {
         this.selectedGlobalSelection = { selection: null };
         this.selectedAssetSortingContext = mockAssetSortingContext;
         this.selectedCurrentUserContext = mockCurrentUserContext();
+        this.selectedAnalyticsContext = mockAnalyticsContext;
+    }
+    /**
+     * Use this Analytics Context.
+     *
+     * @param analyticsContext - The analytics context to use.
+     * @returns { MockContextProviderBuilder } - The builder.
+     */
+    analytics(analyticsContext) {
+        this.selectedAnalyticsContext = analyticsContext;
+        return this;
     }
     /**
      * Use this Environment Context.
      *
      * @param environmentContext - The environment context to use.
+     * @returns { MockContextProviderBuilder } - The builder.
      */
     environment(environmentContext) {
         this.selectedEnvironmentContext = environmentContext || mockEnvironmentContext;
@@ -231,6 +250,7 @@ class MockContextProviderBuilder {
      * Use this token.
      *
      * @param token - The token to use.
+     * @returns { MockContextProviderBuilder } - The builder.
      */
     token(token) {
         this.selectedTokenContext = { token };
@@ -238,6 +258,8 @@ class MockContextProviderBuilder {
     }
     /**
      * User this to pass in a differerent current user.
+     *
+     * @returns { MockContextProviderBuilder } - The builder.
      */
     currentUser(currentUserContext) {
         this.selectedCurrentUserContext = currentUserContext;
@@ -247,6 +269,7 @@ class MockContextProviderBuilder {
      * Use this to pass in userSubscriptionPackage.
      *
      * @param userSubscriptionPackage - The developer settings context to use.
+     * @returns { MockContextProviderBuilder } - The builder.
      */
     userSubscriptionPackage(userSubscriptionPackage) {
         if (userSubscriptionPackage) {
@@ -258,6 +281,7 @@ class MockContextProviderBuilder {
      * Use this to pass in SupportedFeatures.
      *
      * @param features - The developer settings context to use.
+     * @returns { MockContextProviderBuilder } - The builder.
      */
     supportedFeatures(features) {
         if (features) {
@@ -274,6 +298,7 @@ class MockContextProviderBuilder {
      * Use this Router Props with the given mocks.
      *
      * @param routerProps - The router props to use.
+     * @returns { MockContextProviderBuilder } - The builder.
      */
     routerProps(routerProps) {
         this.selectedRouterProps = routerProps || {};
@@ -283,6 +308,7 @@ class MockContextProviderBuilder {
      * Use this global selection.
      *
      * @param globalSelection - The global selection to use.
+     * @returns { MockContextProviderBuilder } - The builder.
      */
     globalSelection(globalSelection) {
         this.selectedGlobalSelection = { selection: globalSelection };
@@ -292,6 +318,7 @@ class MockContextProviderBuilder {
      * Set global asset sorting context.
      *
      * @param overrides - Override the default context.
+     * @returns { MockContextProviderBuilder } - The builder.
      */
     assetSorting(overrides) {
         this.selectedAssetSortingContext = Object.assign(Object.assign({}, mockAssetSortingContext), overrides);
@@ -354,7 +381,7 @@ class MockContextProviderBuilder {
      * Validate the mocks that has been supplied to make sure they make sense.
      * Note: This function is overriden in builders extending this one.
      *
-     * @returns true or throws error if any invalid mocks
+     * @returns {boolean} true or throws error if any invalid mocks
      */
     validateSuppliedMocks() {
         return true;
@@ -366,7 +393,7 @@ class MockContextProviderBuilder {
      * @param addTestRootContainer - if you want to add a root container to the test.
      */
     getMockedCompositionRoot(testChildren, addTestRootContainer = true) {
-        return (jsxRuntime.jsx(reactCoreHooks.EnvironmentContextProvider, Object.assign({ value: this.selectedEnvironmentContext }, { children: jsxRuntime.jsx(reactRouterDom.MemoryRouter, Object.assign({}, this.selectedRouterProps, { children: jsxRuntime.jsx(reactCoreHooks.CurrentUserProvider, Object.assign({ value: this.selectedCurrentUserContext }, { children: jsxRuntime.jsx(reactCoreHooks.UserSubscriptionProvider, Object.assign({ value: mockUserSubscriptionProviderValue(this.features, this.userSubscriptionPackageType) }, { children: jsxRuntime.jsx(reactCoreHooks.TokenProvider, Object.assign({ value: this.selectedTokenContext }, { children: jsxRuntime.jsx(reactCoreHooks.ToastProvider, Object.assign({ value: this.selectedToastContext }, { children: jsxRuntime.jsx(reactCoreHooks.GlobalSelectionProvider, Object.assign({ value: this.selectedGlobalSelection }, { children: jsxRuntime.jsx(reactCoreHooks.AssetSortingProvider, Object.assign({ value: this.selectedAssetSortingContext }, { children: jsxRuntime.jsx(ApolloMockedProviderWithError, Object.assign({ mocks: this.selectedApolloMocks, addTypename: false }, { children: addTestRootContainer ? (jsxRuntime.jsx(TestRoot, Object.assign({ "data-testid": "testRoot" }, { children: testChildren }))) : (jsxRuntime.jsx("div", { children: testChildren })) })) })) })) })) })) })) })) })) })));
+        return (jsxRuntime.jsx(reactCoreHooks.EnvironmentContextProvider, Object.assign({ value: this.selectedEnvironmentContext }, { children: jsxRuntime.jsx(reactRouterDom.MemoryRouter, Object.assign({}, this.selectedRouterProps, { children: jsxRuntime.jsx(reactCoreHooks.CurrentUserProvider, Object.assign({ value: this.selectedCurrentUserContext }, { children: jsxRuntime.jsx(reactCoreHooks.AnalyticsContext.Provider, Object.assign({ value: this.selectedAnalyticsContext }, { children: jsxRuntime.jsx(reactCoreHooks.UserSubscriptionProvider, Object.assign({ value: mockUserSubscriptionProviderValue(this.features, this.userSubscriptionPackageType) }, { children: jsxRuntime.jsx(reactCoreHooks.TokenProvider, Object.assign({ value: this.selectedTokenContext }, { children: jsxRuntime.jsx(reactCoreHooks.ToastProvider, Object.assign({ value: this.selectedToastContext }, { children: jsxRuntime.jsx(reactCoreHooks.GlobalSelectionProvider, Object.assign({ value: this.selectedGlobalSelection }, { children: jsxRuntime.jsx(reactCoreHooks.AssetSortingProvider, Object.assign({ value: this.selectedAssetSortingContext }, { children: jsxRuntime.jsx(ApolloMockedProviderWithError, Object.assign({ mocks: this.selectedApolloMocks, addTypename: false }, { children: addTestRootContainer ? (jsxRuntime.jsx(TestRoot, Object.assign({ "data-testid": "testRoot" }, { children: testChildren }))) : (jsxRuntime.jsx("div", { children: testChildren })) })) })) })) })) })) })) })) })) })) })));
     }
 }
 /**
@@ -403,6 +430,7 @@ const useLogPropsChanged = (propsToWatch) => {
         if (Object.keys(changedProps).length > 0) {
             // eslint-disable-next-line no-console
             Object.keys(changedProps).forEach(changedProp => {
+                // eslint-disable-next-line no-console
                 console.log("Props changed:", changedProp, parentCaller);
                 // JSON stringify is used to avoid console.table from logging the object reference
                 const result = JSON.parse(JSON.stringify(changedProps[changedProp]));
@@ -416,8 +444,10 @@ const useLogPropsChanged = (propsToWatch) => {
                     Object.keys(result1).forEach(prop => {
                         result1[prop] = JSON.stringify(result1[prop]);
                     });
+                // eslint-disable-next-line no-console
                 console.table([result0, result1]);
             });
+            // eslint-disable-next-line no-console
             console.dir(changedProps);
         }
         prevPropsRef.current = propsToWatch;
@@ -508,6 +538,7 @@ exports.__awaiter = __awaiter;
 exports.doNothing = doNothing;
 exports.flushPromises = flushPromises;
 exports.flushPromisesInAct = flushPromisesInAct;
+exports.mockAnalyticsContext = mockAnalyticsContext;
 exports.mockCurrentUserContext = mockCurrentUserContext;
 exports.mockEnvironmentContext = mockEnvironmentContext;
 exports.queryFor = queryFor;

package/index2.js

@@ -1,7 +1,7 @@
 import { jsx } from 'react/jsx-runtime';
 import { act, render } from '@testing-library/react';
 import { AssetSortByProperty, SortOrder, UserSubscriptionPackage } from '@trackunit/react-core-contexts-api';
-import { EnvironmentContextProvider, CurrentUserProvider, UserSubscriptionProvider, TokenProvider, ToastProvider, GlobalSelectionProvider, AssetSortingProvider } from '@trackunit/react-core-hooks';
+import { EnvironmentContextProvider, CurrentUserProvider, AnalyticsContext, UserSubscriptionProvider, TokenProvider, ToastProvider, GlobalSelectionProvider, AssetSortingProvider } from '@trackunit/react-core-hooks';
 import { tw } from '@trackunit/tailwind-styled-components';
 import { MemoryRouter } from 'react-router-dom';
 import { ApolloLink } from '@apollo/client';
@@ -91,6 +91,13 @@ const doNothing = () => {
     /* Do nothing */
 };
 
+const mockAnalyticsContext = {
+    logEvent: doNothing,
+    logError: doNothing,
+    logPageView: doNothing,
+    setUserProperty: doNothing,
+};
+
 const mockAssetSortingContext = {
     setSortBy: doNothing,
     sortingState: {
@@ -146,7 +153,7 @@ const mockToastContext = {
  *
  * @param features - array of features
  * @param packageType - package type
- * @returns IUserSubscriptionContext
+ * @returns { IUserSubscriptionContext }- mock for the UserSubscriptionContext
  */
 const mockUserSubscriptionProviderValue = (features, packageType) => {
     return {
@@ -215,11 +222,23 @@ class MockContextProviderBuilder {
         this.selectedGlobalSelection = { selection: null };
         this.selectedAssetSortingContext = mockAssetSortingContext;
         this.selectedCurrentUserContext = mockCurrentUserContext();
+        this.selectedAnalyticsContext = mockAnalyticsContext;
+    }
+    /**
+     * Use this Analytics Context.
+     *
+     * @param analyticsContext - The analytics context to use.
+     * @returns { MockContextProviderBuilder } - The builder.
+     */
+    analytics(analyticsContext) {
+        this.selectedAnalyticsContext = analyticsContext;
+        return this;
     }
     /**
      * Use this Environment Context.
      *
      * @param environmentContext - The environment context to use.
+     * @returns { MockContextProviderBuilder } - The builder.
      */
     environment(environmentContext) {
         this.selectedEnvironmentContext = environmentContext || mockEnvironmentContext;
@@ -229,6 +248,7 @@ class MockContextProviderBuilder {
      * Use this token.
      *
      * @param token - The token to use.
+     * @returns { MockContextProviderBuilder } - The builder.
      */
     token(token) {
         this.selectedTokenContext = { token };
@@ -236,6 +256,8 @@ class MockContextProviderBuilder {
     }
     /**
      * User this to pass in a differerent current user.
+     *
+     * @returns { MockContextProviderBuilder } - The builder.
      */
     currentUser(currentUserContext) {
         this.selectedCurrentUserContext = currentUserContext;
@@ -245,6 +267,7 @@ class MockContextProviderBuilder {
      * Use this to pass in userSubscriptionPackage.
      *
      * @param userSubscriptionPackage - The developer settings context to use.
+     * @returns { MockContextProviderBuilder } - The builder.
      */
     userSubscriptionPackage(userSubscriptionPackage) {
         if (userSubscriptionPackage) {
@@ -256,6 +279,7 @@ class MockContextProviderBuilder {
      * Use this to pass in SupportedFeatures.
      *
      * @param features - The developer settings context to use.
+     * @returns { MockContextProviderBuilder } - The builder.
      */
     supportedFeatures(features) {
         if (features) {
@@ -272,6 +296,7 @@ class MockContextProviderBuilder {
      * Use this Router Props with the given mocks.
      *
      * @param routerProps - The router props to use.
+     * @returns { MockContextProviderBuilder } - The builder.
      */
     routerProps(routerProps) {
         this.selectedRouterProps = routerProps || {};
@@ -281,6 +306,7 @@ class MockContextProviderBuilder {
      * Use this global selection.
      *
      * @param globalSelection - The global selection to use.
+     * @returns { MockContextProviderBuilder } - The builder.
      */
     globalSelection(globalSelection) {
         this.selectedGlobalSelection = { selection: globalSelection };
@@ -290,6 +316,7 @@ class MockContextProviderBuilder {
      * Set global asset sorting context.
      *
      * @param overrides - Override the default context.
+     * @returns { MockContextProviderBuilder } - The builder.
      */
     assetSorting(overrides) {
         this.selectedAssetSortingContext = Object.assign(Object.assign({}, mockAssetSortingContext), overrides);
@@ -352,7 +379,7 @@ class MockContextProviderBuilder {
      * Validate the mocks that has been supplied to make sure they make sense.
      * Note: This function is overriden in builders extending this one.
      *
-     * @returns true or throws error if any invalid mocks
+     * @returns {boolean} true or throws error if any invalid mocks
      */
     validateSuppliedMocks() {
         return true;
@@ -364,7 +391,7 @@ class MockContextProviderBuilder {
      * @param addTestRootContainer - if you want to add a root container to the test.
      */
     getMockedCompositionRoot(testChildren, addTestRootContainer = true) {
-        return (jsx(EnvironmentContextProvider, Object.assign({ value: this.selectedEnvironmentContext }, { children: jsx(MemoryRouter, Object.assign({}, this.selectedRouterProps, { children: jsx(CurrentUserProvider, Object.assign({ value: this.selectedCurrentUserContext }, { children: jsx(UserSubscriptionProvider, Object.assign({ value: mockUserSubscriptionProviderValue(this.features, this.userSubscriptionPackageType) }, { children: jsx(TokenProvider, Object.assign({ value: this.selectedTokenContext }, { children: jsx(ToastProvider, Object.assign({ value: this.selectedToastContext }, { children: jsx(GlobalSelectionProvider, Object.assign({ value: this.selectedGlobalSelection }, { children: jsx(AssetSortingProvider, Object.assign({ value: this.selectedAssetSortingContext }, { children: jsx(ApolloMockedProviderWithError, Object.assign({ mocks: this.selectedApolloMocks, addTypename: false }, { children: addTestRootContainer ? (jsx(TestRoot, Object.assign({ "data-testid": "testRoot" }, { children: testChildren }))) : (jsx("div", { children: testChildren })) })) })) })) })) })) })) })) })) })));
+        return (jsx(EnvironmentContextProvider, Object.assign({ value: this.selectedEnvironmentContext }, { children: jsx(MemoryRouter, Object.assign({}, this.selectedRouterProps, { children: jsx(CurrentUserProvider, Object.assign({ value: this.selectedCurrentUserContext }, { children: jsx(AnalyticsContext.Provider, Object.assign({ value: this.selectedAnalyticsContext }, { children: jsx(UserSubscriptionProvider, Object.assign({ value: mockUserSubscriptionProviderValue(this.features, this.userSubscriptionPackageType) }, { children: jsx(TokenProvider, Object.assign({ value: this.selectedTokenContext }, { children: jsx(ToastProvider, Object.assign({ value: this.selectedToastContext }, { children: jsx(GlobalSelectionProvider, Object.assign({ value: this.selectedGlobalSelection }, { children: jsx(AssetSortingProvider, Object.assign({ value: this.selectedAssetSortingContext }, { children: jsx(ApolloMockedProviderWithError, Object.assign({ mocks: this.selectedApolloMocks, addTypename: false }, { children: addTestRootContainer ? (jsx(TestRoot, Object.assign({ "data-testid": "testRoot" }, { children: testChildren }))) : (jsx("div", { children: testChildren })) })) })) })) })) })) })) })) })) })) })));
     }
 }
 /**
@@ -401,6 +428,7 @@ const useLogPropsChanged = (propsToWatch) => {
         if (Object.keys(changedProps).length > 0) {
             // eslint-disable-next-line no-console
             Object.keys(changedProps).forEach(changedProp => {
+                // eslint-disable-next-line no-console
                 console.log("Props changed:", changedProp, parentCaller);
                 // JSON stringify is used to avoid console.table from logging the object reference
                 const result = JSON.parse(JSON.stringify(changedProps[changedProp]));
@@ -414,8 +442,10 @@ const useLogPropsChanged = (propsToWatch) => {
                     Object.keys(result1).forEach(prop => {
                         result1[prop] = JSON.stringify(result1[prop]);
                     });
+                // eslint-disable-next-line no-console
                 console.table([result0, result1]);
             });
+            // eslint-disable-next-line no-console
             console.dir(changedProps);
         }
         prevPropsRef.current = propsToWatch;
@@ -501,4 +531,4 @@ const validateIrisApp = (irisApp) => __awaiter(void 0, void 0, void 0, function*
     return null;
 });
 
-export { MockContextProviderBuilder as M, __awaiter as _, mockEnvironmentContext as a, flushPromisesInAct as b, doNothing as d, flushPromises as f, mockCurrentUserContext as m, queryFor as q, rootContext as r, useLogPropsChanged as u, validateIrisApp as v };
+export { MockContextProviderBuilder as M, __awaiter as _, mockCurrentUserContext as a, mockEnvironmentContext as b, flushPromisesInAct as c, doNothing as d, flushPromises as f, mockAnalyticsContext as m, queryFor as q, rootContext as r, useLogPropsChanged as u, validateIrisApp as v };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-contexts-test",
-  "version": "0.1.56",
+  "version": "0.1.57",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "module": "./index.js",
@@ -9,8 +9,8 @@
   "types": "./src/index.d.ts",
   "dependencies": {
     "@apollo/client": "3.7.10",
-    "@trackunit/react-core-contexts-api": "0.2.29",
-    "@trackunit/react-core-hooks": "0.2.51",
+    "@trackunit/react-core-contexts-api": "0.2.30",
+    "@trackunit/react-core-hooks": "0.2.52",
     "@trackunit/tailwind-styled-components": "0.0.56",
     "graphql": "15.8.0",
     "react": "18.2.0",

package/src/HookRenderer.d.ts

@@ -6,6 +6,6 @@ import * as React from "react";
  *
  * @param callback The callback to render the hook.
  * @param getMockedCompositionRoot A function that will return the mocked composition root.
- * @returns The rendered hook.
+ * @returns { Promise<RenderHookResult> } The rendered hook.
  */
 export declare const reactHooksRenderHook: <TProps, TResult>(callback: (props: TProps) => TResult, getMockedCompositionRoot: (children: React.ReactElement) => React.ReactElement) => Promise<RenderHookResult<TResult, TProps>>;

package/src/MockContextProviderBuilder.d.ts

@@ -1,6 +1,6 @@
 import { MockedResponse } from "@apollo/client/testing";
 import { RenderResult } from "@testing-library/react";
-import { IAssetSortingContext, ICurrentUserContext, IEnvironmentContext, IFeature, IGlobalSelectionContext, IToastContext, ITokenContext, UserSubscriptionPackageType } from "@trackunit/react-core-contexts-api";
+import { IAnalyticsContext, IAssetSortingContext, ICurrentUserContext, IEnvironmentContext, IFeature, IGlobalSelectionContext, IToastContext, ITokenContext, UserSubscriptionPackageType } from "@trackunit/react-core-contexts-api";
 import * as React from "react";
 import { MemoryRouterProps } from "react-router-dom";
 /**
@@ -19,50 +19,67 @@ export declare class MockContextProviderBuilder {
     protected selectedGlobalSelection: IGlobalSelectionContext;
     protected selectedAssetSortingContext: IAssetSortingContext;
     protected selectedCurrentUserContext: ICurrentUserContext;
+    protected selectedAnalyticsContext: IAnalyticsContext<{}>;
+    /**
+     * Use this Analytics Context.
+     *
+     * @param analyticsContext - The analytics context to use.
+     * @returns { MockContextProviderBuilder } - The builder.
+     */
+    analytics(analyticsContext: IAnalyticsContext<{}>): this;
     /**
      * Use this Environment Context.
      *
      * @param environmentContext - The environment context to use.
+     * @returns { MockContextProviderBuilder } - The builder.
      */
     environment(environmentContext?: IEnvironmentContext): this;
     /**
      * Use this token.
      *
      * @param token - The token to use.
+     * @returns { MockContextProviderBuilder } - The builder.
      */
     token(token: string): this;
     /**
      * User this to pass in a differerent current user.
+     *
+     * @returns { MockContextProviderBuilder } - The builder.
      */
     currentUser(currentUserContext: ICurrentUserContext): this;
     /**
      * Use this to pass in userSubscriptionPackage.
      *
      * @param userSubscriptionPackage - The developer settings context to use.
+     * @returns { MockContextProviderBuilder } - The builder.
      */
     userSubscriptionPackage(userSubscriptionPackage?: UserSubscriptionPackageType): this;
     /**
      * Use this to pass in SupportedFeatures.
      *
      * @param features - The developer settings context to use.
+     * @returns { MockContextProviderBuilder } - The builder.
      */
     supportedFeatures(features?: string[]): this;
     /**
      * Use this Router Props with the given mocks.
      *
      * @param routerProps - The router props to use.
+     * @returns { MockContextProviderBuilder } - The builder.
      */
     routerProps(routerProps?: MemoryRouterProps): this;
     /**
      * Use this global selection.
      *
      * @param globalSelection - The global selection to use.
+     * @returns { MockContextProviderBuilder } - The builder.
      */
     globalSelection(globalSelection: IGlobalSelectionContext["selection"]): this;
     /**
      * Set global asset sorting context.
      *
      * @param overrides - Override the default context.
+     * @returns { MockContextProviderBuilder } - The builder.
      */
     assetSorting(overrides: Partial<IAssetSortingContext>): this;
     /**
@@ -91,7 +108,7 @@ export declare class MockContextProviderBuilder {
      * Validate the mocks that has been supplied to make sure they make sense.
      * Note: This function is overriden in builders extending this one.
      *
-     * @returns true or throws error if any invalid mocks
+     * @returns {boolean} true or throws error if any invalid mocks
      */
     protected validateSuppliedMocks(): true | never;
     /**

package/src/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./MockContextProviderBuilder";
+export * from "./mocks/mockAnalyticsContext";
 export * from "./mocks/mockCurrentUserContext";
 export * from "./mocks/mockEnvironmentContext";
 export * from "./useLogPropsChanged";

package/src/mocks/mockAnalyticsContext.d.ts

@@ -0,0 +1,2 @@
+import { IAnalyticsContext } from "@trackunit/react-core-contexts-api";
+export declare const mockAnalyticsContext: IAnalyticsContext<{}>;

package/src/mocks/mockUserSubscriptionContext.d.ts

@@ -4,6 +4,6 @@ import { IFeature, IUserSubscriptionContext, UserSubscriptionPackageType } from
  *
  * @param features - array of features
  * @param packageType - package type
- * @returns IUserSubscriptionContext
+ * @returns { IUserSubscriptionContext }- mock for the UserSubscriptionContext
  */
 export declare const mockUserSubscriptionProviderValue: (features: IFeature[], packageType: UserSubscriptionPackageType) => IUserSubscriptionContext;