@trackunit/react-core-contexts-test 1.12.0 → 1.12.2

package/index.cjs2.js

@@ -13548,9 +13548,10 @@ const RootRouteDebugger = () => {
 /**
  * This component is used to wrap the children of the RouterContainer to add a test root container.
  *
- * @param addTestRootContainer boolean to add test root container
- * @param children children to be wrapped
- * @returns {ReactNode} children component wrapped in a test root container
+ * @param props - The component props.
+ * @param props.addTestRootContainer - Boolean to add test root container.
+ * @param props.children - Children to be wrapped.
+ * @returns {ReactNode} Children component wrapped in a test root container.
  */
 const TestRenderChildren = ({ addTestRootContainer, children }) => {
     return addTestRootContainer ? (jsxRuntime.jsx("div", { className: "inline-block h-[1000px] w-[1024px] scale-[.99]", "data-testid": "testRoot", style: {
@@ -13561,11 +13562,12 @@ const TestRenderChildren = ({ addTestRootContainer, children }) => {
 /**
  * This component is used to wrap the children of the RouterContainer to add a test root container.
  *
- * @param addTestRootContainer boolean to add test root container
- * @param selectedRouterProps selected router props
- * @param rootRoute root route
- * @param children children to be wrapped
- * @returns {ReactElement} children component wrapped in a test root container
+ * @param props - The component props.
+ * @param props.addTestRootContainer - Boolean to add test root container.
+ * @param props.selectedRouterProps - Selected router props.
+ * @param props.rootRoute - Root route.
+ * @param props.children - Children to be wrapped.
+ * @returns {ReactElement} Children component wrapped in a test root container.
  */
 const RouterContainer = ({ addTestRootContainer, selectedRouterProps, rootRoute, children, }) => {
     const client = react.useApolloClient();
@@ -14291,8 +14293,8 @@ const useIsFirstRender = () => {
  * This is a hook version of the class component lifecycle method `componentDidUpdate`.
  * ALWAYS wrap in your own object.
  *
- * @param id optional id to use for logging or it will guess the id from the stack trace
  * @param propsToWatch all the props to watch for changes
+ * @param id optional id to use for logging or it will guess the id from the stack trace
  * @param dontLogReRender if true, will not log the re-render message nice if you have a lot of re-renders
  * @example
  * const propsToWatch = { foo: props.foo, bar: props.bar };
@@ -14364,10 +14366,12 @@ const useDebugger = (propsToWatch, id, dontLogReRender) => {
  * This component will log when it is mounted, re-renders or unmounted.
  * It will also log when any of its props change.
  *
- * @param id optional id to use for logging
- * @param stop if true, will stop execution and open debugger
- * @param logPropsChanges optional object with props to watch for changes
- * @param children the children to render
+ * @param props - The component props.
+ * @param props.id - Optional id to use for logging.
+ * @param props.stop - If true, will stop execution and open debugger.
+ * @param props.logPropsChanges - Optional object with props to watch for changes.
+ * @param props.children - The children to render.
+ * @returns {ReactElement} The rendered debugger component.
  */
 const Debugger = ({ id, logPropsChanges, stop, children, }) => {
     const uniqueId = id ||
@@ -14464,16 +14468,18 @@ const queryFor = (document, variables, data, error, maxUsageCount = 1) => {
     };
 };
 /**
+ * Creates a mocked response for a hook query.
  *
- * @param document Document that represents the specific GQL query / mutation schema.
- * @param variables Variables that should be passed to the query / mutation.
+ * @param hookFn - The hook function that executes the query.
+ * @param document - Document that represents the specific GQL query / mutation schema.
+ * @param variables - Variables that should be passed to the query / mutation.
  * Note that an *exact* match between the mock and operation is necessary.
- * @param data Data object to be returned.
+ * @param data - Data object to be returned.
  * 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.
- * @see [Testing React components using MockedProvider and associated APIs](https://www.apollographql.com/docs/react/development-testing/testing/)
+ * @param error - ApolloError object to be returned.
+ * @returns {MockedResponse} 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 queryForHook = (hookFn, document, variables, data, error) => {
     return {

package/index.esm2.js

@@ -13526,9 +13526,10 @@ const RootRouteDebugger = () => {
 /**
  * This component is used to wrap the children of the RouterContainer to add a test root container.
  *
- * @param addTestRootContainer boolean to add test root container
- * @param children children to be wrapped
- * @returns {ReactNode} children component wrapped in a test root container
+ * @param props - The component props.
+ * @param props.addTestRootContainer - Boolean to add test root container.
+ * @param props.children - Children to be wrapped.
+ * @returns {ReactNode} Children component wrapped in a test root container.
  */
 const TestRenderChildren = ({ addTestRootContainer, children }) => {
     return addTestRootContainer ? (jsx("div", { className: "inline-block h-[1000px] w-[1024px] scale-[.99]", "data-testid": "testRoot", style: {
@@ -13539,11 +13540,12 @@ const TestRenderChildren = ({ addTestRootContainer, children }) => {
 /**
  * This component is used to wrap the children of the RouterContainer to add a test root container.
  *
- * @param addTestRootContainer boolean to add test root container
- * @param selectedRouterProps selected router props
- * @param rootRoute root route
- * @param children children to be wrapped
- * @returns {ReactElement} children component wrapped in a test root container
+ * @param props - The component props.
+ * @param props.addTestRootContainer - Boolean to add test root container.
+ * @param props.selectedRouterProps - Selected router props.
+ * @param props.rootRoute - Root route.
+ * @param props.children - Children to be wrapped.
+ * @returns {ReactElement} Children component wrapped in a test root container.
  */
 const RouterContainer = ({ addTestRootContainer, selectedRouterProps, rootRoute, children, }) => {
     const client = useApolloClient();
@@ -14269,8 +14271,8 @@ const useIsFirstRender = () => {
  * This is a hook version of the class component lifecycle method `componentDidUpdate`.
  * ALWAYS wrap in your own object.
  *
- * @param id optional id to use for logging or it will guess the id from the stack trace
  * @param propsToWatch all the props to watch for changes
+ * @param id optional id to use for logging or it will guess the id from the stack trace
  * @param dontLogReRender if true, will not log the re-render message nice if you have a lot of re-renders
  * @example
  * const propsToWatch = { foo: props.foo, bar: props.bar };
@@ -14342,10 +14344,12 @@ const useDebugger = (propsToWatch, id, dontLogReRender) => {
  * This component will log when it is mounted, re-renders or unmounted.
  * It will also log when any of its props change.
  *
- * @param id optional id to use for logging
- * @param stop if true, will stop execution and open debugger
- * @param logPropsChanges optional object with props to watch for changes
- * @param children the children to render
+ * @param props - The component props.
+ * @param props.id - Optional id to use for logging.
+ * @param props.stop - If true, will stop execution and open debugger.
+ * @param props.logPropsChanges - Optional object with props to watch for changes.
+ * @param props.children - The children to render.
+ * @returns {ReactElement} The rendered debugger component.
  */
 const Debugger = ({ id, logPropsChanges, stop, children, }) => {
     const uniqueId = id ||
@@ -14442,16 +14446,18 @@ const queryFor = (document, variables, data, error, maxUsageCount = 1) => {
     };
 };
 /**
+ * Creates a mocked response for a hook query.
  *
- * @param document Document that represents the specific GQL query / mutation schema.
- * @param variables Variables that should be passed to the query / mutation.
+ * @param hookFn - The hook function that executes the query.
+ * @param document - Document that represents the specific GQL query / mutation schema.
+ * @param variables - Variables that should be passed to the query / mutation.
  * Note that an *exact* match between the mock and operation is necessary.
- * @param data Data object to be returned.
+ * @param data - Data object to be returned.
  * 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.
- * @see [Testing React components using MockedProvider and associated APIs](https://www.apollographql.com/docs/react/development-testing/testing/)
+ * @param error - ApolloError object to be returned.
+ * @returns {MockedResponse} 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 queryForHook = (hookFn, document, variables, data, error) => {
     return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-contexts-test",
-  "version": "1.12.0",
+  "version": "1.12.2",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -10,11 +10,11 @@
     "@apollo/client": "3.13.8",
     "react": "19.0.0",
     "@tanstack/react-router": "1.114.29",
-    "@trackunit/shared-utils": "1.13.19",
+    "@trackunit/shared-utils": "1.13.21",
     "graphql": "^16.10.0",
     "@tanstack/router-core": "1.114.29",
-    "@trackunit/iris-app-runtime-core-api": "1.12.0",
-    "@trackunit/react-core-contexts-api": "1.13.0",
+    "@trackunit/iris-app-runtime-core-api": "1.12.2",
+    "@trackunit/react-core-contexts-api": "1.13.2",
     "es-toolkit": "^1.39.10"
   },
   "module": "./index.esm.js",

package/src/useDebugger.d.ts

@@ -1,4 +1,4 @@
-import { ReactNode } from "react";
+import { ReactElement, ReactNode } from "react";
 type PropsToWatch<TProps> = TProps extends object ? TProps : never;
 /**
  * Logs props that have changed.
@@ -6,8 +6,8 @@ type PropsToWatch<TProps> = TProps extends object ? TProps : never;
  * This is a hook version of the class component lifecycle method `componentDidUpdate`.
  * ALWAYS wrap in your own object.
  *
- * @param id optional id to use for logging or it will guess the id from the stack trace
  * @param propsToWatch all the props to watch for changes
+ * @param id optional id to use for logging or it will guess the id from the stack trace
  * @param dontLogReRender if true, will not log the re-render message nice if you have a lot of re-renders
  * @example
  * const propsToWatch = { foo: props.foo, bar: props.bar };
@@ -20,15 +20,17 @@ export declare const useDebugger: <TProps extends object>(propsToWatch: PropsToW
  * This component will log when it is mounted, re-renders or unmounted.
  * It will also log when any of its props change.
  *
- * @param id optional id to use for logging
- * @param stop if true, will stop execution and open debugger
- * @param logPropsChanges optional object with props to watch for changes
- * @param children the children to render
+ * @param props - The component props.
+ * @param props.id - Optional id to use for logging.
+ * @param props.stop - If true, will stop execution and open debugger.
+ * @param props.logPropsChanges - Optional object with props to watch for changes.
+ * @param props.children - The children to render.
+ * @returns {ReactElement} The rendered debugger component.
  */
 export declare const Debugger: ({ id, logPropsChanges, stop, children, }: {
     children?: ReactNode;
     id?: string;
     stop?: boolean;
     logPropsChanges?: Record<string, unknown>;
-}) => import("react/jsx-runtime").JSX.Element;
+}) => ReactElement;
 export {};

package/src/utils/queryFor.d.ts

@@ -36,16 +36,18 @@ export declare const queryFor: <TData, TVariables extends OperationVariables = O
 type QueryReturn<TData, TVariables extends OperationVariables = OperationVariables> = ReturnType<typeof useQuery<TData, TVariables>>;
 type QueryLazyReturn<TData, TVariables extends OperationVariables = OperationVariables> = ReturnType<typeof useLazyQuery<TData, TVariables>>;
 /**
+ * Creates a mocked response for a hook query.
  *
- * @param document Document that represents the specific GQL query / mutation schema.
- * @param variables Variables that should be passed to the query / mutation.
+ * @param hookFn - The hook function that executes the query.
+ * @param document - Document that represents the specific GQL query / mutation schema.
+ * @param variables - Variables that should be passed to the query / mutation.
  * Note that an *exact* match between the mock and operation is necessary.
- * @param data Data object to be returned.
+ * @param data - Data object to be returned.
  * 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.
- * @see [Testing React components using MockedProvider and associated APIs](https://www.apollographql.com/docs/react/development-testing/testing/)
+ * @param error - ApolloError object to be returned.
+ * @returns {MockedResponse} 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 queryForHook: <TData, TVariables extends OperationVariables = OperationVariables>(hookFn: (baseOptions: QueryHookOptions<TData, TVariables>) => QueryReturn<TData, TVariables> | QueryLazyReturn<TData, TVariables>, document: TypedDocumentNode<TData, TVariables>, variables: TVariables, data: TData | null, error?: ApolloError | Error) => MockedResponse;
 export {};

package/src/utils/routingUtils.d.ts

@@ -24,11 +24,12 @@ export interface TestRenderChildrenProps {
 /**
  * This component is used to wrap the children of the RouterContainer to add a test root container.
  *
- * @param addTestRootContainer boolean to add test root container
- * @param children children to be wrapped
- * @returns {ReactNode} children component wrapped in a test root container
+ * @param props - The component props.
+ * @param props.addTestRootContainer - Boolean to add test root container.
+ * @param props.children - Children to be wrapped.
+ * @returns {ReactNode} Children component wrapped in a test root container.
  */
-export declare const TestRenderChildren: ({ addTestRootContainer, children }: TestRenderChildrenProps) => import("react/jsx-runtime").JSX.Element;
+export declare const TestRenderChildren: ({ addTestRootContainer, children }: TestRenderChildrenProps) => ReactNode;
 export interface RouterContainerProps<TRoute extends AnyRoute = AnyRoute> {
     addTestRootContainer: boolean;
     rootRoute?: TRoute | null;
@@ -38,10 +39,11 @@ export interface RouterContainerProps<TRoute extends AnyRoute = AnyRoute> {
 /**
  * This component is used to wrap the children of the RouterContainer to add a test root container.
  *
- * @param addTestRootContainer boolean to add test root container
- * @param selectedRouterProps selected router props
- * @param rootRoute root route
- * @param children children to be wrapped
- * @returns {ReactElement} children component wrapped in a test root container
+ * @param props - The component props.
+ * @param props.addTestRootContainer - Boolean to add test root container.
+ * @param props.selectedRouterProps - Selected router props.
+ * @param props.rootRoute - Root route.
+ * @param props.children - Children to be wrapped.
+ * @returns {ReactElement} Children component wrapped in a test root container.
  */
 export declare const RouterContainer: ({ addTestRootContainer, selectedRouterProps, rootRoute, children, }: RouterContainerProps) => ReactElement;