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

package/src/debugger.d.ts

@@ -1,36 +1,36 @@
-import React from "react";
-type PropsToWatch<P> = P extends object ? P : never;
-/**
- * Logs props that have changed.
- * Use this for debugging which props force a component to re-render.
- * 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
- * @example
- * const propsToWatch = { foo: props.foo, bar: props.bar };
- * useDebugger({ id: "MyComponent", propsToWatch });
- */
-export declare const useDebugger: <P extends object>({ id, propsToWatch, }: {
-    id?: string | undefined;
-    propsToWatch: PropsToWatch<P> | null;
-}) => void;
-/**
- * Debugger component for debugging state changes and re-renders.
- *
- * 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
- */
-export declare const Debugger: ({ id, logPropsChanges, stop, children, }: {
-    children: React.ReactNode;
-    id?: string | undefined;
-    stop?: boolean | undefined;
-    logPropsChanges?: {} | undefined;
-}) => JSX.Element;
-export {};
+import React from "react";
+type PropsToWatch<P> = P extends object ? P : never;
+/**
+ * Logs props that have changed.
+ * Use this for debugging which props force a component to re-render.
+ * 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
+ * @example
+ * const propsToWatch = { foo: props.foo, bar: props.bar };
+ * useDebugger({ id: "MyComponent", propsToWatch });
+ */
+export declare const useDebugger: <P extends object>({ id, propsToWatch, }: {
+    id?: string | undefined;
+    propsToWatch: PropsToWatch<P> | null;
+}) => void;
+/**
+ * Debugger component for debugging state changes and re-renders.
+ *
+ * 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
+ */
+export declare const Debugger: ({ id, logPropsChanges, stop, children, }: {
+    children: React.ReactNode;
+    id?: string | undefined;
+    stop?: boolean | undefined;
+    logPropsChanges?: {} | undefined;
+}) => JSX.Element;
+export {};

package/src/index.d.ts

@@ -1,13 +1,13 @@
-export * from "./debugger";
-export * from "./mocks/mockAnalyticsContext";
-export * from "./mocks/mockAssetSortingContext";
-export * from "./mocks/mockCurrentUserContext";
-export * from "./mocks/mockEnvironmentContext";
-export * from "./mocks/mockOemBrandingContext";
-export * from "./mocks/mockToastContext";
-export * from "./mocks/mockUserSubscriptionContext";
-export * from "./TrackunitProvidersMockBuilder";
-export * from "./utils/doNothing";
-export * from "./utils/queryFor";
-export * from "./utils/validateIrisApp";
-export * from "./utils/wait";
+export * from "./debugger";
+export * from "./mocks/mockAnalyticsContext";
+export * from "./mocks/mockAssetSortingContext";
+export * from "./mocks/mockCurrentUserContext";
+export * from "./mocks/mockEnvironmentContext";
+export * from "./mocks/mockOemBrandingContext";
+export * from "./mocks/mockToastContext";
+export * from "./mocks/mockUserSubscriptionContext";
+export * from "./TrackunitProvidersMockBuilder";
+export * from "./utils/doNothing";
+export * from "./utils/queryFor";
+export * from "./utils/validateIrisApp";
+export * from "./utils/wait";

package/src/mocks/mockAnalyticsContext.d.ts

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

package/src/mocks/mockAssetSortingContext.d.ts

@@ -1,2 +1,2 @@
-import { IAssetSortingContext } from "@trackunit/react-core-contexts-api";
-export declare const mockAssetSortingContext: IAssetSortingContext;
+import { IAssetSortingContext } from "@trackunit/react-core-contexts-api";
+export declare const mockAssetSortingContext: IAssetSortingContext;

package/src/mocks/mockCurrentUserContext.d.ts

@@ -1,7 +1,7 @@
-import { ICurrentUserContext } from "@trackunit/react-core-contexts-api";
-/**
- * Mocks the current user context
- *
- * @returns {ICurrentUserContext} - Returns the mocked current user context
- */
-export declare const mockCurrentUserContext: ICurrentUserContext;
+import { ICurrentUserContext } from "@trackunit/react-core-contexts-api";
+/**
+ * Mocks the current user context
+ *
+ * @returns {ICurrentUserContext} - Returns the mocked current user context
+ */
+export declare const mockCurrentUserContext: ICurrentUserContext;

package/src/mocks/mockEnvironmentContext.d.ts

@@ -1,2 +1,2 @@
-import { IEnvironmentContext } from "@trackunit/react-core-contexts-api";
-export declare const mockEnvironmentContext: IEnvironmentContext;
+import { IEnvironmentContext } from "@trackunit/react-core-contexts-api";
+export declare const mockEnvironmentContext: IEnvironmentContext;

package/src/mocks/mockOemBrandingContext.d.ts

@@ -1,2 +1,2 @@
-import { IOemBrandingContext } from "@trackunit/react-core-contexts-api";
-export declare const mockOemBrandingContext: IOemBrandingContext;
+import { IOemBrandingContext } from "@trackunit/react-core-contexts-api";
+export declare const mockOemBrandingContext: IOemBrandingContext;

package/src/mocks/mockToastContext.d.ts

@@ -1,2 +1,2 @@
-import { IToastContext } from "@trackunit/react-core-contexts-api";
-export declare const mockToastContext: IToastContext;
+import { IToastContext } from "@trackunit/react-core-contexts-api";
+export declare const mockToastContext: IToastContext;

package/src/mocks/mockUserSubscriptionContext.d.ts

@@ -1,7 +1,7 @@
-import { IUserSubscriptionContext } from "@trackunit/react-core-contexts-api";
-/**
- * This is a mock for the UserSubscriptionContext.
- *
- * @returns { IUserSubscriptionContext }- mock for the UserSubscriptionContext
- */
-export declare const mockUserSubscriptionContext: IUserSubscriptionContext;
+import { IUserSubscriptionContext } from "@trackunit/react-core-contexts-api";
+/**
+ * This is a mock for the UserSubscriptionContext.
+ *
+ * @returns { IUserSubscriptionContext }- mock for the UserSubscriptionContext
+ */
+export declare const mockUserSubscriptionContext: IUserSubscriptionContext;

package/src/utils/doNothing.d.ts

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

package/src/utils/queryFor.d.ts

@@ -1,18 +1,18 @@
-import { ApolloError } from "@apollo/client";
-import { MockedResponse } from "@apollo/client/testing";
-import { DocumentNode } from "graphql";
-/**
- *
- * @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.
- * 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/)
- */
-export declare const queryFor: <Result extends {
-    __typename?: unknown;
-}, Variables>(document: DocumentNode, variables: Variables, data: Result | null, error?: ApolloError | Error) => MockedResponse;
+import { ApolloError } from "@apollo/client";
+import { MockedResponse } from "@apollo/client/testing";
+import { DocumentNode } from "graphql";
+/**
+ *
+ * @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.
+ * 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/)
+ */
+export declare const queryFor: <Result extends {
+    __typename?: unknown;
+}, Variables>(document: DocumentNode, variables: Variables, data: Result | null, error?: ApolloError | Error) => MockedResponse;

package/src/utils/validateIrisApp.d.ts

@@ -1,21 +1,21 @@
-/**
- * This helps validate the IrisApp is exposed correctly it must expose:
- * - bootstrap
- * - mount
- * - unmount
- * According to the single spa spec.
- *
- * Your test could look like this
- *
- * @example
- * import * as IrisApp from "./index";
-    describe("App", () => {
-      it("Should validate", async () => {
-        const result = await validateIrisApp(IrisApp);
-        expect(result).toBeNull();
-      });
-    });
- * @param irisApp Import the index ts(x) file as above and pass it in.
- * @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>;
+/**
+ * This helps validate the IrisApp is exposed correctly it must expose:
+ * - bootstrap
+ * - mount
+ * - unmount
+ * According to the single spa spec.
+ *
+ * Your test could look like this
+ *
+ * @example
+ * import * as IrisApp from "./index";
+    describe("App", () => {
+      it("Should validate", async () => {
+        const result = await validateIrisApp(IrisApp);
+        expect(result).toBeNull();
+      });
+    });
+ * @param irisApp Import the index ts(x) file as above and pass it in.
+ * @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,16 +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>;
+/**
+ * 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>;