@trackunit/react-core-contexts-test 0.1.38-alpha-beca370860.0 → 0.1.42

package/HookRenderer.cjs

@@ -13,6 +13,14 @@ require('@apollo/client/link/error');
 require('@apollo/client/testing');
 require('graphql');
 
+/**
+ * This is a wrapper around the react testing library renderHook function.
+ * It will make sure that the act function is called and that the promises are flushed.
+ *
+ * @param callback The callback to render the hook.
+ * @param getMockedCompositionRoot A function that will return the mocked composition root.
+ * @returns 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
     const wrapper = ({ children }) => {

package/HookRenderer.js

@@ -11,6 +11,14 @@ import '@apollo/client/link/error';
 import '@apollo/client/testing';
 import 'graphql';
 
+/**
+ * This is a wrapper around the react testing library renderHook function.
+ * It will make sure that the act function is called and that the promises are flushed.
+ *
+ * @param callback The callback to render the hook.
+ * @param getMockedCompositionRoot A function that will return the mocked composition root.
+ * @returns The rendered hook.
+ */
 const reactHooksRenderHook = (callback, getMockedCompositionRoot) => __awaiter(void 0, void 0, void 0, function* () {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const wrapper = ({ children }) => {

package/index2.cjs

@@ -56,6 +56,9 @@ const defaultOptions = {
         errorPolicy: "all",
     },
 };
+/**
+ * This is a wrapper around the MockedProvider that logs errors to the console.
+ */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function ApolloMockedProviderWithError(props) {
     const { mocks } = props, otherProps = __rest(props, ["mocks"]);
@@ -64,14 +67,14 @@ function ApolloMockedProviderWithError(props) {
         if (graphQLErrors) {
             // eslint-disable-next-line array-callback-return
             graphQLErrors.map(({ message, locations, path }) => {
-                if (process.env["VSCODE_INSPECTOR_OPTIONS"] || process.env["DEBUG"]) {
+                if (process.env.VSCODE_INSPECTOR_OPTIONS || process.env.DEBUG) {
                     // eslint-disable-next-line no-console
                     console.log(`[GraphQL error]: Message: ${message}, Location: ${locations}, Path: ${path}`);
                 }
             });
         }
         if (networkError) {
-            if (process.env["VSCODE_INSPECTOR_OPTIONS"] || process.env["DEBUG"]) {
+            if (process.env.VSCODE_INSPECTOR_OPTIONS || process.env.DEBUG) {
                 // eslint-disable-next-line no-console
                 console.log(`[Network error]: ${networkError}`);
             }
@@ -81,6 +84,9 @@ function ApolloMockedProviderWithError(props) {
     return (jsxRuntime.jsx(testing.MockedProvider, Object.assign({}, otherProps, { link: link, defaultOptions: Object.assign(Object.assign({}, defaultOptions), { watchQuery: { fetchPolicy: "no-cache" } }) })));
 }
 
+/**
+ * Do nothing
+ */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const doNothing = () => {
     /* Do nothing */
@@ -94,6 +100,12 @@ const mockAssetSortingContext = {
     },
 };
 
+/**
+ * Mocks the current user context
+ *
+ * @param overrides - The overrides to apply to the mock
+ * @returns {ICurrentUserContext} - Returns the mocked current user context
+ */
 const mockCurrentUserContext = (overrides = {}) => (Object.assign({ userName: "", userRole: "", customerId: 12345, userId: 154312, tasUserId: "751ea227-f199-4d00-925f-a608312c5e45", email: "", name: "", accountId: "", assumedUser: null, jobTitle: "", isAuthenticated: true, isVerified: true, isAccountOwner: true, subscriptionPackage: "EXPAND_FLEET_OWNER" }, overrides));
 
 const mockEnvironmentContext = {
@@ -131,6 +143,13 @@ const mockToastContext = {
     setIsManifestError: doNothing,
 };
 
+/**
+ * This is a mock for the UserSubscriptionContext.
+ *
+ * @param features - array of features
+ * @param packageType - package type
+ * @returns IUserSubscriptionContext
+ */
 const mockUserSubscriptionProviderValue = (features, packageType) => {
     return {
         numberOfDaysWithAccessToHistoricalData: 30,
@@ -140,6 +159,13 @@ const mockUserSubscriptionProviderValue = (features, packageType) => {
     };
 };
 
+/**
+ * Flushes all promises in the queue.
+ * This is useful when testing async code.
+ *
+ * @param waitTimeInMS - The amount of time to wait before resolving the promise.
+ * @returns {Promise<void>} - Returns a promise that resolves after the wait time.
+ */
 const flushPromises = (waitTimeInMS = 0) => {
     return new Promise(resolve => {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -152,6 +178,13 @@ const flushPromises = (waitTimeInMS = 0) => {
         }
     });
 };
+/**
+ * Flushes all promises in the queue.
+ * This is useful when testing async code.
+ *
+ * @param waitTimeInMS - The amount of time to wait before resolving the promise.
+ * @returns {Promise<void>} - Returns a promise that resolves after the wait time.
+ */
 const flushPromisesInAct = (waitTimeInMS = 0) => {
     return react.act(() => {
         return new Promise(resolve => {
@@ -188,7 +221,7 @@ class MockContextProviderBuilder {
     /**
      * Use this Environment Context.
      *
-     * @param environmentContext
+     * @param environmentContext - The environment context to use.
      */
     environment(environmentContext) {
         this.selectedEnvironmentContext = environmentContext || mockEnvironmentContext;
@@ -197,7 +230,7 @@ class MockContextProviderBuilder {
     /**
      * Use this token.
      *
-     * @param token
+     * @param token - The token to use.
      */
     token(token) {
         this.selectedTokenContext = { token };
@@ -206,7 +239,7 @@ class MockContextProviderBuilder {
     /**
      * Use this to pass in userSubscriptionPackage.
      *
-     * @param developerSettingsContext
+     * @param developerSettingsContext - The developer settings context to use.
      */
     userSubscriptionPackage(userSubscriptionPackage) {
         if (userSubscriptionPackage) {
@@ -217,7 +250,7 @@ class MockContextProviderBuilder {
     /**
      * Use this to pass in SupportedFeatures.
      *
-     * @param developerSettingsContext
+     * @param developerSettingsContext - The developer settings context to use.
      */
     supportedFeatures(features) {
         if (features) {
@@ -233,7 +266,7 @@ class MockContextProviderBuilder {
     /**
      * Assume this user
      *
-     * @param assumeUser
+     * @param assumeUser - The user to assume.
      */
     assumeUser(assumeUser) {
         this.selectedAssumedUser = assumeUser;
@@ -242,7 +275,7 @@ class MockContextProviderBuilder {
     /**
      * Use this Router Props with the given mocks.
      *
-     * @param routerProps
+     * @param routerProps - The router props to use.
      */
     routerProps(routerProps) {
         this.selectedRouterProps = routerProps || {};
@@ -251,7 +284,7 @@ class MockContextProviderBuilder {
     /**
      * Use this global selection.
      *
-     * @param globalSelection
+     * @param globalSelection - The global selection to use.
      */
     globalSelection(globalSelection) {
         this.selectedGlobalSelection = { selection: globalSelection };
@@ -266,6 +299,9 @@ class MockContextProviderBuilder {
         this.selectedAssetSortingContext = Object.assign(Object.assign({}, mockAssetSortingContext), overrides);
         return this;
     }
+    /**
+     * This will return the mocked composition root.
+     */
     renderHook(callback, parentElement) {
         return __awaiter(this, void 0, void 0, function* () {
             this.validateSuppliedMocks();
@@ -277,7 +313,7 @@ class MockContextProviderBuilder {
     /**
      * Use this Manager Apollo Context Provider with the given mocks.
      *
-     * @param apolloMocks
+     * @param apolloMocks - The mocks to use for the ApolloProvider.
      */
     apollo(apolloMocks) {
         this.selectedApolloMocks = apolloMocks || [];
@@ -335,6 +371,9 @@ class MockContextProviderBuilder {
         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: mockCurrentUserContext({ assumedUser: this.selectedAssumedUser }) }, { 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 })) })) })) })) })) })) })) })) })) })));
     }
 }
+/**
+ *
+ */
 const rootContext = () => new MockContextProviderBuilder();
 const TestRoot = tailwindStyledComponents.tw.div `
   --tw-scale-x: 0.99;
@@ -353,7 +392,7 @@ const TestRoot = tailwindStyledComponents.tw.div `
  * Note that *all* properties should be given a value, use `null` in place of `undefined`,
  * otherwise nothing will be returned.
  * @param error ApolloError object to be returned.
- * @returns MockedResponse that can be passed to the mocked ApolloProvider.
+ * @returns {MockedResponse} that can be passed to the mocked ApolloProvider.
  * @see [Testing React components using MockedProvider and associated APIs](https://www.apollographql.com/docs/react/development-testing/testing/)
  */
 const queryFor = (document, variables, data, error) => {
@@ -363,7 +402,7 @@ const queryFor = (document, variables, data, error) => {
             variables,
         },
         newData: () => {
-            if (process.env["VSCODE_INSPECTOR_OPTIONS"] || process.env["DEBUG"]) {
+            if (process.env.VSCODE_INSPECTOR_OPTIONS || process.env.DEBUG) {
                 // eslint-disable-next-line @typescript-eslint/no-explicit-any
                 const name = document.definitions[0].name.value;
                 // eslint-disable-next-line no-console
@@ -394,6 +433,7 @@ const queryFor = (document, variables, data, error) => {
  * According to the single spa spec.
  *
  * Your test could look like this
+ *
  * @example
  * import * as IrisApp from "./index";
     describe("App", () => {
@@ -402,9 +442,8 @@ const queryFor = (document, variables, data, error) => {
         expect(result).toBeNull();
       });
     });
- *
  * @param irisApp Import the index ts(x) file as above and pass it in.
- * @returns null if everything is good - otherwise a string telling you what is wrong.
+ * @returns {null|string} if everything is good - otherwise a string telling you what is wrong.
  */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const validateIrisApp = (irisApp) => __awaiter(void 0, void 0, void 0, function* () {

package/index2.js

@@ -54,6 +54,9 @@ const defaultOptions = {
         errorPolicy: "all",
     },
 };
+/**
+ * This is a wrapper around the MockedProvider that logs errors to the console.
+ */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function ApolloMockedProviderWithError(props) {
     const { mocks } = props, otherProps = __rest(props, ["mocks"]);
@@ -62,14 +65,14 @@ function ApolloMockedProviderWithError(props) {
         if (graphQLErrors) {
             // eslint-disable-next-line array-callback-return
             graphQLErrors.map(({ message, locations, path }) => {
-                if (process.env["VSCODE_INSPECTOR_OPTIONS"] || process.env["DEBUG"]) {
+                if (process.env.VSCODE_INSPECTOR_OPTIONS || process.env.DEBUG) {
                     // eslint-disable-next-line no-console
                     console.log(`[GraphQL error]: Message: ${message}, Location: ${locations}, Path: ${path}`);
                 }
             });
         }
         if (networkError) {
-            if (process.env["VSCODE_INSPECTOR_OPTIONS"] || process.env["DEBUG"]) {
+            if (process.env.VSCODE_INSPECTOR_OPTIONS || process.env.DEBUG) {
                 // eslint-disable-next-line no-console
                 console.log(`[Network error]: ${networkError}`);
             }
@@ -79,6 +82,9 @@ function ApolloMockedProviderWithError(props) {
     return (jsx(MockedProvider, Object.assign({}, otherProps, { link: link, defaultOptions: Object.assign(Object.assign({}, defaultOptions), { watchQuery: { fetchPolicy: "no-cache" } }) })));
 }
 
+/**
+ * Do nothing
+ */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const doNothing = () => {
     /* Do nothing */
@@ -92,6 +98,12 @@ const mockAssetSortingContext = {
     },
 };
 
+/**
+ * Mocks the current user context
+ *
+ * @param overrides - The overrides to apply to the mock
+ * @returns {ICurrentUserContext} - Returns the mocked current user context
+ */
 const mockCurrentUserContext = (overrides = {}) => (Object.assign({ userName: "", userRole: "", customerId: 12345, userId: 154312, tasUserId: "751ea227-f199-4d00-925f-a608312c5e45", email: "", name: "", accountId: "", assumedUser: null, jobTitle: "", isAuthenticated: true, isVerified: true, isAccountOwner: true, subscriptionPackage: "EXPAND_FLEET_OWNER" }, overrides));
 
 const mockEnvironmentContext = {
@@ -129,6 +141,13 @@ const mockToastContext = {
     setIsManifestError: doNothing,
 };
 
+/**
+ * This is a mock for the UserSubscriptionContext.
+ *
+ * @param features - array of features
+ * @param packageType - package type
+ * @returns IUserSubscriptionContext
+ */
 const mockUserSubscriptionProviderValue = (features, packageType) => {
     return {
         numberOfDaysWithAccessToHistoricalData: 30,
@@ -138,6 +157,13 @@ const mockUserSubscriptionProviderValue = (features, packageType) => {
     };
 };
 
+/**
+ * Flushes all promises in the queue.
+ * This is useful when testing async code.
+ *
+ * @param waitTimeInMS - The amount of time to wait before resolving the promise.
+ * @returns {Promise<void>} - Returns a promise that resolves after the wait time.
+ */
 const flushPromises = (waitTimeInMS = 0) => {
     return new Promise(resolve => {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -150,6 +176,13 @@ const flushPromises = (waitTimeInMS = 0) => {
         }
     });
 };
+/**
+ * Flushes all promises in the queue.
+ * This is useful when testing async code.
+ *
+ * @param waitTimeInMS - The amount of time to wait before resolving the promise.
+ * @returns {Promise<void>} - Returns a promise that resolves after the wait time.
+ */
 const flushPromisesInAct = (waitTimeInMS = 0) => {
     return act(() => {
         return new Promise(resolve => {
@@ -186,7 +219,7 @@ class MockContextProviderBuilder {
     /**
      * Use this Environment Context.
      *
-     * @param environmentContext
+     * @param environmentContext - The environment context to use.
      */
     environment(environmentContext) {
         this.selectedEnvironmentContext = environmentContext || mockEnvironmentContext;
@@ -195,7 +228,7 @@ class MockContextProviderBuilder {
     /**
      * Use this token.
      *
-     * @param token
+     * @param token - The token to use.
      */
     token(token) {
         this.selectedTokenContext = { token };
@@ -204,7 +237,7 @@ class MockContextProviderBuilder {
     /**
      * Use this to pass in userSubscriptionPackage.
      *
-     * @param developerSettingsContext
+     * @param developerSettingsContext - The developer settings context to use.
      */
     userSubscriptionPackage(userSubscriptionPackage) {
         if (userSubscriptionPackage) {
@@ -215,7 +248,7 @@ class MockContextProviderBuilder {
     /**
      * Use this to pass in SupportedFeatures.
      *
-     * @param developerSettingsContext
+     * @param developerSettingsContext - The developer settings context to use.
      */
     supportedFeatures(features) {
         if (features) {
@@ -231,7 +264,7 @@ class MockContextProviderBuilder {
     /**
      * Assume this user
      *
-     * @param assumeUser
+     * @param assumeUser - The user to assume.
      */
     assumeUser(assumeUser) {
         this.selectedAssumedUser = assumeUser;
@@ -240,7 +273,7 @@ class MockContextProviderBuilder {
     /**
      * Use this Router Props with the given mocks.
      *
-     * @param routerProps
+     * @param routerProps - The router props to use.
      */
     routerProps(routerProps) {
         this.selectedRouterProps = routerProps || {};
@@ -249,7 +282,7 @@ class MockContextProviderBuilder {
     /**
      * Use this global selection.
      *
-     * @param globalSelection
+     * @param globalSelection - The global selection to use.
      */
     globalSelection(globalSelection) {
         this.selectedGlobalSelection = { selection: globalSelection };
@@ -264,6 +297,9 @@ class MockContextProviderBuilder {
         this.selectedAssetSortingContext = Object.assign(Object.assign({}, mockAssetSortingContext), overrides);
         return this;
     }
+    /**
+     * This will return the mocked composition root.
+     */
     renderHook(callback, parentElement) {
         return __awaiter(this, void 0, void 0, function* () {
             this.validateSuppliedMocks();
@@ -275,7 +311,7 @@ class MockContextProviderBuilder {
     /**
      * Use this Manager Apollo Context Provider with the given mocks.
      *
-     * @param apolloMocks
+     * @param apolloMocks - The mocks to use for the ApolloProvider.
      */
     apollo(apolloMocks) {
         this.selectedApolloMocks = apolloMocks || [];
@@ -333,6 +369,9 @@ class MockContextProviderBuilder {
         return (jsx(EnvironmentContextProvider, Object.assign({ value: this.selectedEnvironmentContext }, { children: jsx(MemoryRouter, Object.assign({}, this.selectedRouterProps, { children: jsx(CurrentUserProvider, Object.assign({ value: mockCurrentUserContext({ assumedUser: this.selectedAssumedUser }) }, { 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 })) })) })) })) })) })) })) })) })) })));
     }
 }
+/**
+ *
+ */
 const rootContext = () => new MockContextProviderBuilder();
 const TestRoot = tw.div `
   --tw-scale-x: 0.99;
@@ -351,7 +390,7 @@ const TestRoot = tw.div `
  * Note that *all* properties should be given a value, use `null` in place of `undefined`,
  * otherwise nothing will be returned.
  * @param error ApolloError object to be returned.
- * @returns MockedResponse that can be passed to the mocked ApolloProvider.
+ * @returns {MockedResponse} that can be passed to the mocked ApolloProvider.
  * @see [Testing React components using MockedProvider and associated APIs](https://www.apollographql.com/docs/react/development-testing/testing/)
  */
 const queryFor = (document, variables, data, error) => {
@@ -361,7 +400,7 @@ const queryFor = (document, variables, data, error) => {
             variables,
         },
         newData: () => {
-            if (process.env["VSCODE_INSPECTOR_OPTIONS"] || process.env["DEBUG"]) {
+            if (process.env.VSCODE_INSPECTOR_OPTIONS || process.env.DEBUG) {
                 // eslint-disable-next-line @typescript-eslint/no-explicit-any
                 const name = document.definitions[0].name.value;
                 // eslint-disable-next-line no-console
@@ -392,6 +431,7 @@ const queryFor = (document, variables, data, error) => {
  * According to the single spa spec.
  *
  * Your test could look like this
+ *
  * @example
  * import * as IrisApp from "./index";
     describe("App", () => {
@@ -400,9 +440,8 @@ const queryFor = (document, variables, data, error) => {
         expect(result).toBeNull();
       });
     });
- *
  * @param irisApp Import the index ts(x) file as above and pass it in.
- * @returns null if everything is good - otherwise a string telling you what is wrong.
+ * @returns {null|string} if everything is good - otherwise a string telling you what is wrong.
  */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const validateIrisApp = (irisApp) => __awaiter(void 0, void 0, void 0, function* () {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-contexts-test",
-  "version": "0.1.38-alpha-beca370860.0",
+  "version": "0.1.42",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "module": "./index.js",
@@ -10,9 +10,9 @@
   "dependencies": {
     "@apollo/client": "3.7.10",
     "react": "18.2.0",
-    "@trackunit/react-core-contexts-api": "0.2.22-alpha-beca370860.0",
-    "@trackunit/react-core-hooks": "0.2.35-alpha-beca370860.0",
-    "@trackunit/tailwind-styled-components": "0.0.55-alpha-beca370860.0",
+    "@trackunit/react-core-contexts-api": "0.2.23",
+    "@trackunit/react-core-hooks": "0.2.38",
+    "@trackunit/tailwind-styled-components": "0.0.55",
     "react-router-dom": "6.4.5",
     "graphql": "15.8.0"
   },

package/src/ApolloMockedProviderWithError.d.ts

@@ -1,2 +1,5 @@
 /// <reference types="react" />
+/**
+ * This is a wrapper around the MockedProvider that logs errors to the console.
+ */
 export declare function ApolloMockedProviderWithError(props: any): JSX.Element;

package/src/HookRenderer.d.ts

@@ -1,3 +1,11 @@
 import { RenderHookResult } from "@testing-library/react/pure";
 import * as React from "react";
+/**
+ * This is a wrapper around the react testing library renderHook function.
+ * It will make sure that the act function is called and that the promises are flushed.
+ *
+ * @param callback The callback to render the hook.
+ * @param getMockedCompositionRoot A function that will return the mocked composition root.
+ * @returns 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

@@ -22,43 +22,43 @@ export declare class MockContextProviderBuilder {
     /**
      * Use this Environment Context.
      *
-     * @param environmentContext
+     * @param environmentContext - The environment context to use.
      */
     environment(environmentContext?: IEnvironmentContext): this;
     /**
      * Use this token.
      *
-     * @param token
+     * @param token - The token to use.
      */
     token(token: string): this;
     /**
      * Use this to pass in userSubscriptionPackage.
      *
-     * @param developerSettingsContext
+     * @param developerSettingsContext - The developer settings context to use.
      */
     userSubscriptionPackage(userSubscriptionPackage?: UserSubscriptionPackageType): this;
     /**
      * Use this to pass in SupportedFeatures.
      *
-     * @param developerSettingsContext
+     * @param developerSettingsContext - The developer settings context to use.
      */
     supportedFeatures(features?: string[]): this;
     /**
      * Assume this user
      *
-     * @param assumeUser
+     * @param assumeUser - The user to assume.
      */
     assumeUser(assumeUser: ICurrentUserContext["assumedUser"]): this;
     /**
      * Use this Router Props with the given mocks.
      *
-     * @param routerProps
+     * @param routerProps - The router props to use.
      */
     routerProps(routerProps?: MemoryRouterProps): this;
     /**
      * Use this global selection.
      *
-     * @param globalSelection
+     * @param globalSelection - The global selection to use.
      */
     globalSelection(globalSelection: IGlobalSelectionContext["selection"]): this;
     /**
@@ -67,11 +67,14 @@ export declare class MockContextProviderBuilder {
      * @param overrides - Override the default context.
      */
     assetSorting(overrides: Partial<IAssetSortingContext>): this;
+    /**
+     * 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>>;
     /**
      * Use this Manager Apollo Context Provider with the given mocks.
      *
-     * @param apolloMocks
+     * @param apolloMocks - The mocks to use for the ApolloProvider.
      */
     apollo(apolloMocks?: MockedResponse[]): this;
     /**
@@ -101,4 +104,7 @@ export declare class MockContextProviderBuilder {
      */
     protected getMockedCompositionRoot(testChildren: React.ReactNode, addTestRootContainer?: boolean): JSX.Element;
 }
+/**
+ *
+ */
 export declare const rootContext: () => MockContextProviderBuilder;

package/src/mocks/mockCurrentUserContext.d.ts

@@ -1,2 +1,8 @@
 import { ICurrentUserContext } from "@trackunit/react-core-contexts-api";
+/**
+ * Mocks the current user context
+ *
+ * @param overrides - The overrides to apply to the mock
+ * @returns {ICurrentUserContext} - Returns the mocked current user context
+ */
 export declare const mockCurrentUserContext: (overrides?: Partial<ICurrentUserContext>) => ICurrentUserContext;

package/src/mocks/mockUserSubscriptionContext.d.ts

@@ -1,2 +1,9 @@
 import { IFeature, IUserSubscriptionContext, UserSubscriptionPackageType } from "@trackunit/react-core-contexts-api";
+/**
+ * This is a mock for the UserSubscriptionContext.
+ *
+ * @param features - array of features
+ * @param packageType - package type
+ * @returns IUserSubscriptionContext
+ */
 export declare const mockUserSubscriptionProviderValue: (features: IFeature[], packageType: UserSubscriptionPackageType) => IUserSubscriptionContext;

package/src/utils/doNothing.d.ts

@@ -1 +1,4 @@
+/**
+ * Do nothing
+ */
 export declare const doNothing: () => any | void;

package/src/utils/queryFor.d.ts

@@ -10,7 +10,7 @@ import { DocumentNode } from "graphql";
  * Note that *all* properties should be given a value, use `null` in place of `undefined`,
  * otherwise nothing will be returned.
  * @param error ApolloError object to be returned.
- * @returns MockedResponse that can be passed to the mocked ApolloProvider.
+ * @returns {MockedResponse} that can be passed to the mocked ApolloProvider.
  * @see [Testing React components using MockedProvider and associated APIs](https://www.apollographql.com/docs/react/development-testing/testing/)
  */
 export declare const queryFor: <Result extends {

package/src/utils/validateIrisApp.d.ts

@@ -6,6 +6,7 @@
  * According to the single spa spec.
  *
  * Your test could look like this
+ *
  * @example
  * import * as IrisApp from "./index";
     describe("App", () => {
@@ -14,8 +15,7 @@
         expect(result).toBeNull();
       });
     });
- *
  * @param irisApp Import the index ts(x) file as above and pass it in.
- * @returns null if everything is good - otherwise a string telling you what is wrong.
+ * @returns {null|string} if everything is good - otherwise a string telling you what is wrong.
  */
 export declare const validateIrisApp: (irisApp: any) => Promise<"Missing a bootstrap function" | "Missing a mount function" | "Missing an unmount function" | "Update must be a function" | null>;

package/src/utils/wait.d.ts

@@ -1,2 +1,16 @@
+/**
+ * Flushes all promises in the queue.
+ * This is useful when testing async code.
+ *
+ * @param waitTimeInMS - The amount of time to wait before resolving the promise.
+ * @returns {Promise<void>} - Returns a promise that resolves after the wait time.
+ */
 export declare const flushPromises: (waitTimeInMS?: number) => Promise<unknown>;
+/**
+ * Flushes all promises in the queue.
+ * This is useful when testing async code.
+ *
+ * @param waitTimeInMS - The amount of time to wait before resolving the promise.
+ * @returns {Promise<void>} - Returns a promise that resolves after the wait time.
+ */
 export declare const flushPromisesInAct: (waitTimeInMS?: number) => Promise<unknown>;