@trackunit/react-core-contexts-test 0.1.69 → 0.1.70

package/src/{MockContextProviderBuilder.d.ts → TrackunitProvidersMockBuilder.d.ts}

@@ -1,18 +1,20 @@
 import { MockedResponse } from "@apollo/client/testing";
 import { RenderResult } from "@testing-library/react";
-import { IAnalyticsContext, IAssetSortingContext, ICurrentUserContext, IEnvironmentContext, IFeature, IGlobalSelectionContext, IOemBrandingContext, IToastContext, ITokenContext, UserSubscriptionPackageType } from "@trackunit/react-core-contexts-api";
+import { IAnalyticsContext, IAssetSortingContext, ICurrentUserContext, IEnvironmentContext, IGlobalSelectionContext, IOemBrandingContext, IToastContext, ITokenContext, IUserSubscriptionContext } from "@trackunit/react-core-contexts-api";
 import * as React from "react";
 import { MemoryRouterProps } from "react-router-dom";
 /**
- * This builder allows you to enable providers using the builder pattern, and then call 1 of either:
+ * This builder allows you to enable trackunit providers using the builder pattern, and then call 1 of either:
+ * For React Components:
  * - render
- * - mount
+ * For React Hooks:
+ * - renderHook
+ * For Storybook:
+ * - storybook
  */
-export declare class MockContextProviderBuilder {
+export declare class TrackunitProvidersMockBuilder {
     protected selectedEnvironmentContext: IEnvironmentContext;
     protected selectedTokenContext: ITokenContext;
-    protected userSubscriptionPackageType: UserSubscriptionPackageType;
-    protected features: IFeature[];
     protected selectedApolloMocks: MockedResponse[];
     protected selectedRouterProps: MemoryRouterProps;
     protected selectedToastContext: IToastContext;
@@ -21,96 +23,96 @@ export declare class MockContextProviderBuilder {
     protected selectedCurrentUserContext: ICurrentUserContext;
     protected selectedAnalyticsContext: IAnalyticsContext<{}>;
     protected selectedOemBrandingContext: IOemBrandingContext;
+    protected selectedUserSubscriptionContext: IUserSubscriptionContext;
     /**
      * Use this Analytics Context.
+     * Defaults to mockAnalyticsContext.
      *
+     * @see mockAnalyticsContext
      * @param analyticsContext - The analytics context to use.
-     * @returns { MockContextProviderBuilder } - The builder.
+     * @returns { TrackunitProvidersMockBuilder } - The builder.
      */
-    analytics(analyticsContext: IAnalyticsContext<{}>): this;
+    analytics(analyticsContext: Partial<IAnalyticsContext<any>>): this;
     /**
      * Use this Environment Context.
+     * Defaults to mockEnvironmentContext.
      *
+     * @see mockEnvironmentContext
      * @param environmentContext - The environment context to use.
-     * @returns { MockContextProviderBuilder } - The builder.
+     * @returns { TrackunitProvidersMockBuilder } - The builder.
      */
-    environment(environmentContext?: IEnvironmentContext): this;
+    environment(environmentContext: Partial<IEnvironmentContext>): this;
     /**
-     * Use this token.
+     * Use this to pass in a differerent current user.
+     * Defaults to mockCurrentUserContext.
      *
-     * @param token - The token to use.
-     * @returns { MockContextProviderBuilder } - The builder.
+     * @see mockCurrentUserContext
+     * @returns { TrackunitProvidersMockBuilder } - The builder.
      */
-    token(token: string): this;
+    currentUser(currentUserContext: Partial<ICurrentUserContext>): this;
     /**
-     * User this to pass in a differerent current user.
+     * Use this to pass in a differerent current user subscription.
+     * Defaults to mockUserSubscriptionContext.
      *
-     * @returns { MockContextProviderBuilder } - The builder.
+     * @see mockUserSubscriptionContext
+     * @returns { TrackunitProvidersMockBuilder } - The builder.
      */
-    currentUser(currentUserContext: ICurrentUserContext): this;
+    userSubscription(userSubscription: Partial<IUserSubscriptionContext> | {
+        features: string[];
+    }): this;
     /**
-     * Use this to pass in userSubscriptionPackage.
+     * Set global asset sorting context.
+     * Defaults to mockAssetSortingContext.
      *
-     * @param userSubscriptionPackage - The developer settings context to use.
-     * @returns { MockContextProviderBuilder } - The builder.
+     * @see mockAssetSortingContext
+     * @param assetSortingContext - Override the default context.
+     * @returns { TrackunitProvidersMockBuilder } - The builder.
      */
-    userSubscriptionPackage(userSubscriptionPackage?: UserSubscriptionPackageType): this;
+    assetSorting(assetSortingContext: Partial<IAssetSortingContext>): this;
     /**
-     * Use this to pass in SupportedFeatures.
+     * Set OEM Branding context.
+     * Defaults to mockOemBrandingContext.
      *
-     * @param features - The developer settings context to use.
-     * @returns { MockContextProviderBuilder } - The builder.
+     * @see mockOemBrandingContext
+     * @param oemBrandingContext - Override the default context.
      */
-    supportedFeatures(features?: string[]): this;
+    oemBrandingContext(oemBrandingContext: Partial<IOemBrandingContext>): this;
     /**
-     * Use this Router Props with the given mocks.
+     * Use this ToastContext with the given mocks.
+     * Defaults to mockToastContext.
      *
-     * @param routerProps - The router props to use.
-     * @returns { MockContextProviderBuilder } - The builder.
+     * @see mockToastContext
+     * @param toastContext - Override the default toast context.
      */
-    routerProps(routerProps?: MemoryRouterProps): this;
+    toast(toastContext: Partial<IToastContext>): this;
     /**
      * Use this global selection.
+     * Defaults to null.
      *
      * @param globalSelection - The global selection to use.
-     * @returns { MockContextProviderBuilder } - The builder.
+     * @returns { TrackunitProvidersMockBuilder } - The builder.
      */
     globalSelection(globalSelection: IGlobalSelectionContext["selection"]): this;
     /**
-     * Set global asset sorting context.
+     * Use this token.
      *
-     * @param overrides - Override the default context.
-     * @returns { MockContextProviderBuilder } - The builder.
+     * @param token - The token to use.
+     * @returns { TrackunitProvidersMockBuilder } - The builder.
      */
-    assetSorting(overrides: Partial<IAssetSortingContext>): this;
+    token(token: string): this;
     /**
-     * This will return the mocked composition root.
+     * Use this Router Props with the given mocks.
+     *
+     * @param routerProps - The router props to use.
+     * @returns { TrackunitProvidersMockBuilder } - The builder.
      */
-    renderHook<TProps, TResult>(callback: (props: TProps) => TResult, parentElement?: (children: React.ReactElement) => React.ReactElement): Promise<import("@testing-library/react").RenderHookResult<TResult, TProps>>;
+    routerProps(routerProps: MemoryRouterProps): this;
     /**
      * Use this Manager Apollo Context Provider with the given mocks.
      *
      * @param apolloMocks - The mocks to use for the ApolloProvider.
      */
     apollo(apolloMocks?: MockedResponse[]): this;
-    /**
-     * Use this ToastContext with the given mocks.
-     *
-     * @param toastContext - Override the default toast context.
-     */
-    toast(toastContext?: Partial<IToastContext>): this;
-    /**
-     * Set irisOemApp SDK context.
-     *
-     * @param overrides - Override the default context.
-     */
-    oemBrandingContext(overrides: Partial<IOemBrandingContext>): this;
-    /**
-     * This will use RTL.render the child in the correct mocked hierarchy of context providers.
-     *
-     * @param child - the child element being tested.
-     */
-    render(child: React.ReactElement): Promise<RenderResult<typeof import("@testing-library/dom/types/queries"), HTMLElement, HTMLElement>>;
     /**
      * Validate the mocks that has been supplied to make sure they make sense.
      * Note: This function is overriden in builders extending this one.
@@ -125,8 +127,23 @@ export declare class MockContextProviderBuilder {
      * @param addTestRootContainer - if you want to add a root container to the test.
      */
     protected getMockedCompositionRoot(testChildren: React.ReactNode, addTestRootContainer?: boolean): JSX.Element;
+    /**
+     * 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>>;
+    /**
+     * This will use react-testing-library.render the child in the correct mocked hierarchy of context providers.
+     *
+     * @see https://testing-library.com/docs/react-testing-library/api#render
+     * @param child - the child element being tested.
+     */
+    render(child: React.ReactElement): Promise<RenderResult<typeof import("@testing-library/dom/types/queries"), HTMLElement, HTMLElement>>;
+    /**
+     *  This will return the children in the correct mocked hierarchy of context providers.
+     */
+    storybook(child: React.ReactNode): JSX.Element;
 }
 /**
- *
+ * This is the default mock builder for the TrackunitProviders.
  */
-export declare const trackunitProviders: () => MockContextProviderBuilder;
+export declare const trackunitProviders: () => TrackunitProvidersMockBuilder;

package/src/index.d.ts

@@ -1,8 +1,12 @@
 export * from "./debugger";
-export * from "./MockContextProviderBuilder";
 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";

package/src/mocks/mockCurrentUserContext.d.ts

@@ -2,7 +2,6 @@ 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;
+export declare const mockCurrentUserContext: ICurrentUserContext;

package/src/mocks/mockUserSubscriptionContext.d.ts

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