@khanacademy/wonder-blocks-testing 7.1.10 → 7.1.12

package/dist/harness/adapters/router.js.flow

@@ -0,0 +1,122 @@
+/**
+ * Flowtype definitions for router
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+
+import * as React from "react";
+import { MemoryRouter } from "react-router-dom";
+import type { LocationShape, Location } from "react-router-dom";
+import type { TestHarnessAdapter } from "../types";
+declare type MemoryRouterProps = JSX.LibraryManagedAttributes<
+  typeof MemoryRouter,
+  React.ComponentProps<typeof MemoryRouter>
+>;
+/**
+ * Configuration for the withLocation test harness adapter.
+ */
+declare type Config =
+  | $ReadOnly<
+      | {
+          /**
+           * See MemoryRouter prop for initialEntries.
+           */
+          initialEntries: $PropertyType<MemoryRouterProps, "initialEntries">,
+
+          /**
+           * See MemoryRouter prop for initialIndex.
+           */
+          initialIndex?: $PropertyType<MemoryRouterProps, "initialIndex">,
+
+          /**
+           * See MemoryRouter prop for getUserConfirmation.
+           */
+          getUserConfirmation?: $PropertyType<
+            MemoryRouterProps,
+            "getUserConfirmation"
+          >,
+
+          /**
+           * A path match to use.
+           *
+           * When this is specified, the harnessed component will be
+           * rendered inside a `Route` handler with this path.
+           *
+           * If the path matches the location, then the route will
+           * render the component.
+           *
+           * If the path does not match the location, then the route
+           * will not render the component.
+           */
+          path?: string,
+          ...
+        }
+      | {
+          /**
+           * The location to use.
+           */
+          location: string | Location,
+
+          /**
+           * Force the use of a StaticRouter, instead of MemoryRouter.
+           */
+          forceStatic: true,
+
+          /**
+           * A path match to use.
+           *
+           * When this is specified, the harnessed component will be
+           * rendered inside a `Route` handler with this path.
+           *
+           * If the path matches the location, then the route will
+           * render the component.
+           *
+           * If the path does not match the location, then the route
+           * will not render the component.
+           */
+          path?: string,
+          ...
+        }
+      | {
+          /**
+           * The initial location to use.
+           */
+          location: string | LocationShape,
+
+          /**
+           * A path match to use.
+           *
+           * When this is specified, the harnessed component will be
+           * rendered inside a `Route` handler with this path.
+           *
+           * If the path matches the location, then the route will
+           * render the component.
+           *
+           * If the path does not match the location, then the route
+           * will not render the component.
+           */
+          path?: string,
+          ...
+        }
+    >
+  | string;
+/**
+ * The default configuration for this adapter.
+ */
+declare export var defaultConfig: {
+  +location: "/",
+  ...
+};
+/**
+ * Adapter that sets up a router and AppShell location-specific contexts.
+ *
+ * This allows you to ensure that components are being tested in the
+ * AppShell world.
+ *
+ * NOTE(somewhatabstract): The AppShell component itself already does
+ * the work of setting up routing and the AppShellContext and so using this
+ * adapter with the App component will have zero-effect since AppShell will
+ * override it.
+ */
+declare export var adapter: TestHarnessAdapter<Config>;

package/dist/harness/hook-harness.d.ts

@@ -0,0 +1,13 @@
+import * as React from "react";
+import { DefaultAdapters } from "./adapters/adapters";
+import type { TestHarnessConfigs } from "./types";
+/**
+ * Create test wrapper for hook testing with Wonder Blocks default adapters.
+ *
+ * This is primarily useful for tests within Wonder Blocks.
+ *
+ * If you want to expand the range of adapters or change the default
+ * configurations, use `makeHookHarness` to create a new `hookHarness`
+ * function.
+ */
+export declare const hookHarness: (configs?: Partial<TestHarnessConfigs<typeof DefaultAdapters>>) => React.ForwardRefExoticComponent<any>;

package/dist/harness/hook-harness.js.flow

@@ -0,0 +1,23 @@
+/**
+ * Flowtype definitions for hook-harness
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+
+import * as React from "react";
+import { DefaultAdapters } from "./adapters/adapters";
+import type { TestHarnessConfigs } from "./types";
+
+/**
+ * Create test wrapper for hook testing with Wonder Blocks default adapters.
+ *
+ * This is primarily useful for tests within Wonder Blocks.
+ *
+ * If you want to expand the range of adapters or change the default
+ * configurations, use `makeHookHarness` to create a new `hookHarness`
+ * function.
+ */
+declare export var hookHarness: (
+  configs?: $Rest<TestHarnessConfigs<typeof DefaultAdapters>, { ... }>
+) => React.ForwardRefExoticComponent<any>;

package/dist/harness/make-hook-harness.d.ts

@@ -0,0 +1,17 @@
+import * as React from "react";
+import type { TestHarnessAdapters, TestHarnessConfigs } from "./types";
+/**
+ * Create a test harness method for use with React hooks.
+ *
+ * This returns a test harness method that applies the default configurations
+ * to the given adapters, wrapping a given component.
+ *
+ * @param {TAdapters} adapters All the adapters to be supported by the returned
+ * test harness.
+ * @param {TestHarnessConfigs<TAdapters>} defaultConfigs Default configuration values for
+ * the adapters.
+ * @returns {(
+ *     configs?: $Shape<TestHarnessConfigs<TAdapters>>,
+ * ) => React.AbstractComponent<any, any>} A test harness.
+ */
+export declare const makeHookHarness: <TAdapters extends TestHarnessAdapters>(adapters: TAdapters, defaultConfigs: ObjMap<TAdapters, <TConfig>(arg1: import("./types").TestHarnessAdapter<TConfig>) => TConfig | null | undefined>) => (configs?: Partial<ObjMap<TAdapters, <TConfig>(arg1: import("./types").TestHarnessAdapter<TConfig>) => TConfig | null | undefined>> | undefined) => React.ForwardRefExoticComponent<any>;

package/dist/harness/make-hook-harness.js.flow

@@ -0,0 +1,42 @@
+/**
+ * Flowtype definitions for make-hook-harness
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+
+import * as $Flowgen$Import$_2e__2f_types from "./types";
+import * as React from "react";
+import type { TestHarnessAdapters, TestHarnessConfigs } from "./types";
+
+/**
+ * Create a test harness method for use with React hooks.
+ * 
+ * This returns a test harness method that applies the default configurations
+ * to the given adapters, wrapping a given component.
+ * @param {TAdapters} adapters All the adapters to be supported by the returned
+ * test harness.
+ * @param {TestHarnessConfigs<TAdapters>} defaultConfigs Default configuration values for
+ * the adapters.
+ * @returns {(
+configs?: $Shape<TestHarnessConfigs<TAdapters>>) => React.AbstractComponent<any, any>} A test harness.
+ */
+declare export var makeHookHarness: <TAdapters: TestHarnessAdapters>(
+  adapters: TAdapters,
+  defaultConfigs: ObjMap<
+    TAdapters,
+    <TConfig>(
+      arg1: $Flowgen$Import$_2e__2f_types.TestHarnessAdapter<TConfig>
+    ) => TConfig | null | void
+  >
+) => (
+  configs?: $Rest<
+    ObjMap<
+      TAdapters,
+      <TConfig>(
+        arg1: $Flowgen$Import$_2e__2f_types.TestHarnessAdapter<TConfig>
+      ) => TConfig | null | void
+    >,
+    { ... }
+  > | void
+) => React.ForwardRefExoticComponent<any>;

package/dist/harness/make-test-harness.d.ts

@@ -0,0 +1,18 @@
+import * as React from "react";
+import type { TestHarnessAdapters, TestHarnessConfigs } from "./types";
+/**
+ * Create a test harness method for use with React components.
+ *
+ * This returns a test harness method that applies the default configurations
+ * to the given adapters, wrapping a given component.
+ *
+ * @param {TAdapters} adapters All the adapters to be supported by the returned
+ * test harness.
+ * @param {Configs<TAdapters>} defaultConfigs Default configuration values for
+ * the adapters.
+ * @returns {<-TProps, +Instance = mixed>(
+ *     Component: React.AbstractComponent<TProps, Instance>,
+ *     configs?: $Shape<Configs<TAdapters>>,
+ * ) => React.AbstractComponent<TProps, Instance>} A test harness.
+ */
+export declare const makeTestHarness: <TAdapters extends TestHarnessAdapters>(adapters: TAdapters, defaultConfigs: ObjMap<TAdapters, <TConfig>(arg1: import("./types").TestHarnessAdapter<TConfig>) => TConfig | null | undefined>) => <TProps extends object>(Component: React.ComponentType<TProps>, configs?: Partial<ObjMap<TAdapters, <TConfig>(arg1: import("./types").TestHarnessAdapter<TConfig>) => TConfig | null | undefined>> | undefined) => React.ForwardRefExoticComponent<React.PropsWithoutRef<TProps> & React.RefAttributes<unknown>>;

package/dist/harness/make-test-harness.js.flow

@@ -0,0 +1,48 @@
+/**
+ * Flowtype definitions for make-test-harness
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+
+import * as $Flowgen$Import$_2e__2f_types from "./types";
+import * as React from "react";
+import type { TestHarnessAdapters, TestHarnessConfigs } from "./types";
+
+/**
+ * Create a test harness method for use with React components.
+ *
+ * This returns a test harness method that applies the default configurations
+ * to the given adapters, wrapping a given component.
+ * @param {TAdapters} adapters All the adapters to be supported by the returned
+ * test harness.
+ * @param {Configs<TAdapters>} defaultConfigs Default configuration values for
+ * the adapters.
+ * @returns {<>() => } -TProps, +Instance = mixed>(
+ * Component: React.AbstractComponent<TProps, Instance>,
+ * configs?: $Shape<Configs<TAdapters>>,
+ * ) => React.AbstractComponent<TProps, Instance>} A test harness.
+ */
+declare export var makeTestHarness: <TAdapters: TestHarnessAdapters>(
+  adapters: TAdapters,
+  defaultConfigs: ObjMap<
+    TAdapters,
+    <TConfig>(
+      arg1: $Flowgen$Import$_2e__2f_types.TestHarnessAdapter<TConfig>
+    ) => TConfig | null | void
+  >
+) => <TProps: { [key: string]: any }>(
+  Component: React.ComponentType<TProps>,
+  configs?: $Rest<
+    ObjMap<
+      TAdapters,
+      <TConfig>(
+        arg1: $Flowgen$Import$_2e__2f_types.TestHarnessAdapter<TConfig>
+      ) => TConfig | null | void
+    >,
+    { ... }
+  > | void
+) => React.ForwardRefExoticComponent<{
+  ...React.PropsWithoutRef<TProps>,
+  ...React.RefAttributes<mixed>,
+}>;

package/dist/harness/render-adapters.d.ts

@@ -0,0 +1,6 @@
+import * as React from "react";
+import type { TestHarnessConfigs, TestHarnessAdapters } from "./types";
+/**
+ * Render test adapters around a child component.
+ */
+export declare const renderAdapters: <TAdapters extends TestHarnessAdapters>(adapters: TAdapters, configs: ObjMap<TAdapters, <TConfig>(arg1: import("./types").TestHarnessAdapter<TConfig>) => TConfig | null | undefined>, children: React.ReactNode) => React.ReactElement;

package/dist/harness/render-adapters.js.flow

@@ -0,0 +1,24 @@
+/**
+ * Flowtype definitions for render-adapters
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+
+import * as $Flowgen$Import$_2e__2f_types from "./types";
+import * as React from "react";
+import type { TestHarnessConfigs, TestHarnessAdapters } from "./types";
+
+/**
+ * Render test adapters around a child component.
+ */
+declare export var renderAdapters: <TAdapters: TestHarnessAdapters>(
+  adapters: TAdapters,
+  configs: ObjMap<
+    TAdapters,
+    <TConfig>(
+      arg1: $Flowgen$Import$_2e__2f_types.TestHarnessAdapter<TConfig>
+    ) => TConfig | null | void
+  >,
+  children: React.Node
+) => React.Element<>;

package/dist/harness/test-harness.d.ts

@@ -0,0 +1,32 @@
+/// <reference path="../../types/aphrodite.d.ts" />
+/// <reference types="react" />
+/**
+ * Wrap a component with a test harness using Wonder Blocks default adapters.
+ *
+ * This is primarily useful for tests within Wonder Blocks.
+ *
+ * If you want to expand the range of adapters or change the default
+ * configurations, use `makeTestHarness` to create a new `testHarness`
+ * function.
+ */
+export declare const testHarness: <TProps extends object>(Component: import("react").ComponentType<TProps>, configs?: Partial<ObjMap<{
+    readonly css: import("./types").TestHarnessAdapter<string | string[] | import("aphrodite").CSSProperties | {
+        classes: string[];
+        style: import("aphrodite").CSSProperties;
+    }>;
+    readonly data: import("./types").TestHarnessAdapter<((requestId: string) => Promise<any> | null | undefined) | ((requestId: string) => Promise<any> | null | undefined)[]>;
+    readonly portal: import("./types").TestHarnessAdapter<string>;
+    readonly router: import("./types").TestHarnessAdapter<string | Readonly<{
+        initialEntries: import("history").LocationDescriptor<unknown>[] | undefined;
+        initialIndex?: number | undefined;
+        getUserConfirmation?: ((message: string, callback: (ok: boolean) => void) => void) | undefined;
+        path?: string | undefined;
+    } | {
+        location: any;
+        forceStatic: true;
+        path?: string | undefined;
+    } | {
+        location: any;
+        path?: string | undefined;
+    }>>;
+}, <TConfig>(arg1: import("./types").TestHarnessAdapter<TConfig>) => TConfig | null | undefined>> | undefined) => import("react").ForwardRefExoticComponent<import("react").PropsWithoutRef<TProps> & import("react").RefAttributes<unknown>>;

package/dist/harness/test-harness.js.flow

@@ -0,0 +1,83 @@
+/**
+ * Flowtype definitions for test-harness
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+
+import * as $Flowgen$Import$react from "react";
+import * as $Flowgen$Import$_2e__2f_types from "./types";
+import * as $Flowgen$Import$aphrodite from "aphrodite";
+import * as $Flowgen$Import$history from "history";
+
+/**
+ * Wrap a component with a test harness using Wonder Blocks default adapters.
+ *
+ * This is primarily useful for tests within Wonder Blocks.
+ *
+ * If you want to expand the range of adapters or change the default
+ * configurations, use `makeTestHarness` to create a new `testHarness`
+ * function.
+ */
+declare export var testHarness: <TProps: { [key: string]: any }>(
+  Component: $Flowgen$Import$react.ComponentType<TProps>,
+  configs?: $Rest<
+    ObjMap<
+      {
+        +css: $Flowgen$Import$_2e__2f_types.TestHarnessAdapter<
+          | string
+          | string[]
+          | $Flowgen$Import$aphrodite.CSSProperties
+          | {
+              classes: string[],
+              style: $Flowgen$Import$aphrodite.CSSProperties,
+              ...
+            }
+        >,
+        +data: $Flowgen$Import$_2e__2f_types.TestHarnessAdapter<
+          | ((requestId: string) => Promise<any> | null | void)
+          | ((requestId: string) => Promise<any> | null | void)[]
+        >,
+        +portal: $Flowgen$Import$_2e__2f_types.TestHarnessAdapter<string>,
+        +router: $Flowgen$Import$_2e__2f_types.TestHarnessAdapter<
+          | string
+          | $ReadOnly<
+              | {
+                  initialEntries:
+                    | $Flowgen$Import$history.LocationDescriptor<mixed>[]
+                    | void,
+                  initialIndex?: number | void,
+                  getUserConfirmation?:
+                    | ((
+                        message: string,
+                        callback: (ok: boolean) => void
+                      ) => void)
+                    | void,
+                  path?: string | void,
+                  ...
+                }
+              | {
+                  location: any,
+                  forceStatic: true,
+                  path?: string | void,
+                  ...
+                }
+              | {
+                  location: any,
+                  path?: string | void,
+                  ...
+                }
+            >
+        >,
+        ...
+      },
+      <TConfig>(
+        arg1: $Flowgen$Import$_2e__2f_types.TestHarnessAdapter<TConfig>
+      ) => TConfig | null | void
+    >,
+    { ... }
+  > | void
+) => $Flowgen$Import$react.ForwardRefExoticComponent<{
+  ...$Flowgen$Import$react.PropsWithoutRef<TProps>,
+  ...$Flowgen$Import$react.RefAttributes<mixed>,
+}>;

package/dist/harness/types.d.ts

@@ -0,0 +1,46 @@
+import * as React from "react";
+/**
+ * A adapter to be composed with our test harnass infrastructure.
+ */
+export type TestHarnessAdapter<TConfig> = (children: React.ReactNode, config: TConfig) => React.ReactElement<any>;
+/**
+ * A general map of adapters by their identifiers.
+ *
+ * It's OK that this has `any` for the config type as this is the very base
+ * version of a adapter set. In reality, a more specific type will be used
+ * with the harness functions that use more specific definitions of known
+ * adapters. This is just to support the base reality of not knowing.
+ *
+ * Use this on input positions only. Output positions for adapters
+ * should infer their type in most cases to ensure the strongest typing of
+ * the adapters.
+ */
+export type TestHarnessAdapters = {
+    [adapterID: string]: TestHarnessAdapter<any>;
+};
+/**
+ * Mapping functions from a adapter-like function to config type.
+ */
+type ExtractConfig = <TConfig>(arg1: TestHarnessAdapter<TConfig>) => TConfig;
+type ExtractMaybeConfig = <TConfig>(arg1: TestHarnessAdapter<TConfig>) => TConfig | null | undefined;
+/**
+ * Type for easily defining an adapter's config type.
+ *
+ * This is the `TestHarnessAdapter` equivalent of `React.ElementConfig`.
+ */
+export type TestHarnessConfig<TAdapter> = ReturnType<ExtractConfig>;
+/**
+ * The `TestHarnessConfigs` type as defined by parsing a given set of adapters.
+ *
+ * NOTE: This only works if the properties of the passed `TAdapters` type
+ * are explicitly typed as `TestHarnessAdapter<TConfig>` so if passing in a
+ * non-Adapters type (which we should be, to get strong `TConfig` types instead
+ * of `any`), then that object should make sure that each adapter is strongly
+ * marked as `TestHarnessAdapter<TConfig>` - TypeScript does not appear to pattern
+ * match against the type definition when invoking the `ExtractConfig` type and I
+ * haven't worked out how to get it to multi-dispatch so that it matches
+ * functions too. Even worse, if the type doesn't match, it just allows `any`
+ * in the `Configs` object, rather than indicating any kind of problem.
+ */
+export type TestHarnessConfigs<TAdapters extends TestHarnessAdapters> = ObjMap<TAdapters, ExtractMaybeConfig>;
+export {};

package/dist/harness/types.js.flow

@@ -0,0 +1,66 @@
+/**
+ * Flowtype definitions for types
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+
+import * as React from "react";
+
+/**
+ * A adapter to be composed with our test harnass infrastructure.
+ */
+export type TestHarnessAdapter<TConfig> = (
+  children: React.Node,
+  config: TConfig
+) => React.Element<any>;
+/**
+ * A general map of adapters by their identifiers.
+ *
+ * It's OK that this has `any` for the config type as this is the very base
+ * version of a adapter set. In reality, a more specific type will be used
+ * with the harness functions that use more specific definitions of known
+ * adapters. This is just to support the base reality of not knowing.
+ *
+ * Use this on input positions only. Output positions for adapters
+ * should infer their type in most cases to ensure the strongest typing of
+ * the adapters.
+ */
+export type TestHarnessAdapters = {
+  [adapterID: string]: TestHarnessAdapter<any>,
+};
+/**
+ * Mapping functions from a adapter-like function to config type.
+ */
+declare type ExtractConfig = <TConfig>(
+  arg1: TestHarnessAdapter<TConfig>
+) => TConfig;
+declare type ExtractMaybeConfig = <TConfig>(
+  arg1: TestHarnessAdapter<TConfig>
+) => TConfig | null | void;
+/**
+ * Type for easily defining an adapter's config type.
+ *
+ * This is the `TestHarnessAdapter` equivalent of `React.ElementConfig`.
+ */
+export type TestHarnessConfig<TAdapter> = $Call<
+  <R>((...args: any[]) => R) => R,
+  ExtractConfig
+>;
+/**
+ * The `TestHarnessConfigs` type as defined by parsing a given set of adapters.
+ *
+ * NOTE: This only works if the properties of the passed `TAdapters` type
+ * are explicitly typed as `TestHarnessAdapter<TConfig>` so if passing in a
+ * non-Adapters type (which we should be, to get strong `TConfig` types instead
+ * of `any`), then that object should make sure that each adapter is strongly
+ * marked as `TestHarnessAdapter<TConfig>` - TypeScript does not appear to pattern
+ * match against the type definition when invoking the `ExtractConfig` type and I
+ * haven't worked out how to get it to multi-dispatch so that it matches
+ * functions too. Even worse, if the type doesn't match, it just allows `any`
+ * in the `Configs` object, rather than indicating any kind of problem.
+ */
+export type TestHarnessConfigs<TAdapters: TestHarnessAdapters> = ObjMap<
+  TAdapters,
+  ExtractMaybeConfig
+>;

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+export { fixtures } from "./fixtures/fixtures";
+export type { FixtureFn, FixtureProps, GetPropsOptions } from "./fixtures/types";
+export { mockFetch } from "./fetch/mock-fetch";
+export { mockGqlFetch } from "./gql/mock-gql-fetch";
+export { RespondWith } from "./respond-with";
+export { SettleController } from "./settle-controller";
+export type { MockResponse } from "./respond-with";
+export type { FetchMockFn, FetchMockOperation } from "./fetch/types";
+export type { GqlFetchMockFn, GqlMockOperation } from "./gql/types";
+export * from "./harness/types";
+export * as harnessAdapters from "./harness/adapters/adapters";
+export { makeHookHarness } from "./harness/make-hook-harness";
+export { makeTestHarness } from "./harness/make-test-harness";
+export { hookHarness } from "./harness/hook-harness";
+export { testHarness } from "./harness/test-harness";