@khanacademy/wonder-blocks-testing 8.0.20 → 8.0.21

package/dist/fixtures/types.js.flow

@@ -1,35 +0,0 @@
-/**
- * Flowtype definitions for data
- * Generated by Flowgen from a Typescript Definition
- * Flowgen v1.21.0
- * @flow
- */
-import * as React from "react";
-
-/**
- * Options injected to the function that returns the fixture props.
- */
-export type GetPropsOptions = {|
-  /**
-   * A function to call that will log output.
-   */
-  log: (message: string, ...args: Array<any>) => void,
-
-  /**
-   * A function to make a handler that will log all arguments with the given
-   * name or message. Useful for logging events as it avoids the boilerplate
-   * of the `log` function.
-   */
-  logHandler: (name: string) => (...args: Array<any>) => void,
-|};
-export type FixtureProps<TProps: { ... }> =
-  | $ReadOnly<TProps>
-  | ((options: $ReadOnly<GetPropsOptions>) => $ReadOnly<TProps>);
-/**
- * A function for defining a fixture.
- */
-export type FixtureFn<TProps: { ... }> = (
-  description: string,
-  props: FixtureProps<TProps>,
-  wrapper?: React.ComponentType<TProps>
-) => mixed;

package/dist/gql/gql-request-matches-mock.js.flow

@@ -1,14 +0,0 @@
-/**
- * Flowtype definitions for data
- * Generated by Flowgen from a Typescript Definition
- * Flowgen v1.21.0
- * @flow
- */
-import type { GqlOperation, GqlContext } from "@khanacademy/wonder-blocks-data";
-import type { GqlMockOperation } from "./types";
-declare export var gqlRequestMatchesMock: (
-  mock: GqlMockOperation<any, any, any>,
-  operation: GqlOperation<any, any>,
-  variables: { [key: any]: any } | null | void,
-  context: GqlContext
-) => boolean;

package/dist/gql/mock-gql-fetch.js.flow

@@ -1,12 +0,0 @@
-/**
- * Flowtype definitions for data
- * Generated by Flowgen from a Typescript Definition
- * Flowgen v1.21.0
- * @flow
- */
-import type { GqlFetchMockFn } from "./types";
-
-/**
- * A mock for the fetch function passed to GqlRouter.
- */
-declare export var mockGqlFetch: () => GqlFetchMockFn;

package/dist/gql/types.js.flow

@@ -1,36 +0,0 @@
-/**
- * Flowtype definitions for data
- * Generated by Flowgen from a Typescript Definition
- * Flowgen v1.21.0
- * @flow
- */
-import type { GqlOperation, GqlContext } from "@khanacademy/wonder-blocks-data";
-import type { GraphQLJson } from "../types";
-import type { MockResponse } from "../respond-with";
-export type GqlMockOperation<
-  TData: { [key: any]: any },
-  TVariables: { [key: any]: any },
-  TContext: GqlContext
-> = {|
-  operation: GqlOperation<TData, TVariables>,
-  variables?: TVariables,
-  context?: TContext,
-|};
-declare type GqlMockOperationFn = <
-  TData: { [key: any]: any },
-  TVariables: { [key: any]: any },
-  TContext: GqlContext,
-  TResponseData: GraphQLJson<TData>
->(
-  operation: GqlMockOperation<TData, TVariables, TContext>,
-  response: MockResponse<TResponseData>
-) => GqlFetchMockFn;
-export type GqlFetchMockFn = {|
-  (
-    operation: GqlOperation<any, any>,
-    variables: { [key: any]: any } | null | void,
-    context: GqlContext
-  ): Promise<Response>,
-  mockOperation: GqlMockOperationFn,
-  mockOperationOnce: GqlMockOperationFn,
-|};

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

@@ -1,28 +0,0 @@
-/**
- * @flow
- */
-import * as css from "./css";
-import * as data from "./data";
-import * as portal from "./portal";
-import * as router from "./router";
-
-import type { TestHarnessConfigs, TestHarnessConfig } from "../types";
-
-/**
- * NOTE: We do not type `DefaultAdapters` with `Adapters` here because we want
- * the individual config types of each adapter to remain intact rather than
- * getting changed to `any`.
- */
-/**
- * The default adapters provided by Wonder Blocks.
- */
-declare export var DefaultAdapters: {|
-  +css: typeof css.adapter,
-  +data: typeof data.adapter,
-  +portal: typeof portal.adapter,
-  +router: typeof router.adapter,
-|};
-/**
- * The default configurations to use with the `DefaultAdapters`.
- */
-declare export var DefaultConfigs: TestHarnessConfigs<typeof DefaultAdapters>;

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

@@ -1,21 +0,0 @@
-/**
- * Flowtype definitions for data
- * Generated by Flowgen from a Typescript Definition
- * Flowgen v1.21.0
- * @flow
- */
-import type { CSSProperties } from "aphrodite";
-import type { TestHarnessAdapter } from "../types";
-declare type Config =
-  | string
-  | Array<string>
-  | CSSProperties
-  | {|
-      classes: Array<string>,
-      style: CSSProperties,
-    |};
-declare export var defaultConfig: Config | null | void;
-/**
- * Test harness adapter for adding CSS to the harnessed component wrapper.
- */
-declare export var adapter: TestHarnessAdapter<Config>;

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

@@ -1,29 +0,0 @@
-/**
- * Flowtype definitions for data
- * Generated by Flowgen from a Typescript Definition
- * Flowgen v1.21.0
- * @flow
- */
-import * as $Flowgen$Import$_40_khanacademy_2f_wonder_2d_blocks_2d_data from "@khanacademy/wonder-blocks-data";
-import * as React from "react";
-import { InterceptRequests } from "@khanacademy/wonder-blocks-data";
-import type { TestHarnessAdapter } from "../types";
-declare type Interceptor = $PropertyType<
-  React.ElementConfig<typeof InterceptRequests>,
-  "interceptor"
->;
-declare type Config = Interceptor | Array<Interceptor>;
-/**
- * Default configuration for the Wonder Blocks Data adapter.
- */
-declare export var defaultConfig: ((
-  requestId: string
-) => Promise<$Flowgen$Import$_40_khanacademy_2f_wonder_2d_blocks_2d_data.ValidCacheData> | null | void)[];
-/**
- * Test harness adapter to mock Wonder Blocks Data usage.
- *
- * NOTE: Consumers are responsible for properly defining their intercepts.
- * This component does not validate the configuration to ensure interceptors
- * are not overriding one another.
- */
-declare export var adapter: TestHarnessAdapter<Config>;

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

@@ -1,17 +0,0 @@
-/**
- * Flowtype definitions for data
- * Generated by Flowgen from a Typescript Definition
- * Flowgen v1.21.0
- * @flow
- */
-import type { TestHarnessAdapter } from "../types";
-declare type Config = string;
-declare export var defaultConfig: Config | null | void;
-/**
- * Test harness adapter for supporting portals.
- *
- * Some components rely on rendering with a React Portal. This adapter ensures
- * that the DOM contains a mounting point for the portal with the expected
- * identifier.
- */
-declare export var adapter: TestHarnessAdapter<Config>;

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

@@ -1,114 +0,0 @@
-/**
- * Flowtype definitions for data
- * 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 { LocationDescriptor } from "history";
-import type { TestHarnessAdapter } from "../types";
-declare type MemoryRouterProps = React.ElementConfig<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: LocationDescriptor,
-
-          /**
-           * 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: LocationDescriptor,
-
-          /**
-           * 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.js.flow

@@ -1,22 +0,0 @@
-/**
- * Flowtype definitions for data
- * 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.AbstractComponent<any, any>;

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

@@ -1,27 +0,0 @@
-/**
- * Flowtype definitions for data
- * Generated by Flowgen from a Typescript Definition
- * Flowgen v1.21.0
- * @flow
- */
-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: TestHarnessConfigs<TAdapters>
-) => (
-  configs?: $Rest<TestHarnessConfigs<TAdapters>, {}> | void
-) => React.AbstractComponent<any, any>;

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

@@ -1,22 +0,0 @@
-// @flow
-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 A test harness.
- */
-declare export var makeTestHarness: <TAdapters: TestHarnessAdapters>(
-    adapters: TAdapters,
-    defaultConfigs: TestHarnessConfigs<TAdapters>,
-) => <-TProps, +Instance = mixed>(
-    Component: React.AbstractComponent<TProps, Instance>,
-    configs?: $Shape<TestHarnessConfigs<TAdapters>>,
-) => React.AbstractComponent<TProps, Instance>;

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

@@ -1,17 +0,0 @@
-/**
- * Flowtype definitions for data
- * Generated by Flowgen from a Typescript Definition
- * Flowgen v1.21.0
- * @flow
- */
-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: TestHarnessConfigs<TAdapters>,
-  children: React.Node
-) => React.Element<any>;

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

@@ -1,74 +0,0 @@
-/**
- * Flowtype definitions for data
- * 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$_40_khanacademy_2f_wonder_2d_blocks_2d_data from "@khanacademy/wonder-blocks-data";
-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: { ... }>(
-  Component: $Flowgen$Import$react.ComponentType<TProps>,
-  configs?: $Rest<
-    $Flowgen$Import$_2e__2f_types.TestHarnessConfigs<{|
-      +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<$Flowgen$Import$_40_khanacademy_2f_wonder_2d_blocks_2d_data.ValidCacheData> | null | void)
-        | ((
-            requestId: string
-          ) => Promise<$Flowgen$Import$_40_khanacademy_2f_wonder_2d_blocks_2d_data.ValidCacheData> | 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: $Flowgen$Import$history.LocationDescriptor<mixed>,
-                forceStatic: true,
-                path?: string | void,
-              |}
-            | {|
-                location: $Flowgen$Import$history.LocationDescriptor<mixed>,
-                path?: string | void,
-              |}
-          >
-      >,
-    |}>,
-    {}
-  > | void
-) => $Flowgen$Import$react.ForwardRefExoticComponent<{|
-  ...$Flowgen$Import$react.PropsWithoutRef<TProps>,
-  ...$Flowgen$Import$react.RefAttributes<mixed>,
-|}>;

package/dist/harness/types.js.flow

@@ -1,57 +0,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.
- */
-type ExtractConfig = <TConfig>(TestHarnessAdapter<TConfig>) => TConfig;
-type ExtractMaybeConfig = <TConfig>(TestHarnessAdapter<TConfig>) => ?TConfig;
-
-/**
- * Type for easily defining an adapter's config type.
- *
- * This is the `TestHarnessAdapter` equivalent of `React.ElementConfig`.
- */
-export type TestHarnessConfig<TAdapter> = $Call<ExtractConfig, TAdapter>;
-
-/**
- * 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>` - flow 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.js.flow

@@ -1,25 +0,0 @@
-/**
- * Flowtype definitions for data
- * Generated by Flowgen from a Typescript Definition
- * Flowgen v1.21.0
- * @flow
- */
-declare export { fixtures } from "./fixtures/fixtures";
-export type {
-  FixtureFn,
-  FixtureProps,
-  GetPropsOptions,
-} from "./fixtures/types";
-declare export { mockFetch } from "./fetch/mock-fetch";
-declare export { mockGqlFetch } from "./gql/mock-gql-fetch";
-declare export { RespondWith } from "./respond-with";
-declare 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";
-declare export * from "./harness/types";
-declare export * as harnessAdapters from "./harness/adapters/adapters";
-declare export { makeHookHarness } from "./harness/make-hook-harness";
-declare export { makeTestHarness } from "./harness/make-test-harness";
-declare export { hookHarness } from "./harness/hook-harness";
-declare export { testHarness } from "./harness/test-harness";

package/dist/mock-requester.js.flow

@@ -1,21 +0,0 @@
-/**
- * Flowtype definitions for data
- * Generated by Flowgen from a Typescript Definition
- * Flowgen v1.21.0
- * @flow
- */
-import type { OperationMock, OperationMatcher, MockFn } from "./types";
-
-/**
- * A generic mock request function for using when mocking fetch or gqlFetch.
- */
-declare export var mockRequester: <
-  TOperationType,
-  TOperationMock: OperationMock<TOperationType>
->(
-  operationMatcher: OperationMatcher<any>,
-  operationToString: (
-    operationMock: TOperationMock,
-    ...args: Array<any>
-  ) => string
-) => MockFn<TOperationType>;

package/dist/respond-with.js.flow

@@ -1,88 +0,0 @@
-/**
- * Flowtype definitions for data
- * Generated by Flowgen from a Typescript Definition
- * Flowgen v1.21.0
- * @flow
- */
-import { SettleSignal } from "./settle-signal";
-import type { GraphQLJson } from "./types";
-
-/**
- * Describes a mock response to a fetch request.
- */
-export type MockResponse<TData> = {|
-  /**
-   * Create a promise from the mocked response.
-   *
-   * If a signal was provided when the mock response was created, the promise
-   * will only settle to resolution or rejection if the signal is raised.
-   */
-  +toPromise: () => Promise<Response>,
-|};
-/**
- * Helpers to define mock responses for mocked requests.
- */
-declare export var RespondWith: $ReadOnly<{|
-  /**
-   * Response with text body and status code.
-   * Status code defaults to 200.
-   */
-  text: <TData>(
-    text: string,
-    statusCode?: number,
-    signal?: SettleSignal | null
-  ) => MockResponse<TData>,
-
-  /**
-   * Response with JSON body and status code 200.
-   */
-  json: <TJson: { [key: any]: any }>(
-    json: TJson,
-    signal?: SettleSignal | null
-  ) => MockResponse<TJson>,
-
-  /**
-   * Response with GraphQL data JSON body and status code 200.
-   */
-  graphQLData: <TData_1: { [key: any]: any }>(
-    data: TData_1,
-    signal?: SettleSignal | null
-  ) => MockResponse<GraphQLJson<TData_1>>,
-
-  /**
-   * Response with body that will not parse as JSON and status code 200.
-   */
-  unparseableBody: (signal?: SettleSignal | null) => MockResponse<any>,
-
-  /**
-   * Rejects with an AbortError to simulate an aborted request.
-   */
-  abortedRequest: (signal?: SettleSignal | null) => MockResponse<any>,
-
-  /**
-   * Rejects with the given error.
-   */
-  reject: (error: Error, signal?: SettleSignal | null) => MockResponse<any>,
-
-  /**
-   * A non-200 status code with empty text body.
-   * Equivalent to calling `ResponseWith.text("", statusCode)`.
-   */
-  errorStatusCode: (
-    statusCode: number,
-    signal?: SettleSignal | null
-  ) => MockResponse<any>,
-
-  /**
-   * Response body that is valid JSON but not a valid GraphQL response.
-   */
-  nonGraphQLBody: (signal?: SettleSignal | null) => MockResponse<any>,
-
-  /**
-   * Response that is a GraphQL errors response with status code 200.
-   */
-  graphQLErrors: (
-    errorMessages: $ReadOnlyArray<string>,
-    signal?: SettleSignal | null
-  ) => MockResponse<GraphQLJson<any>>,
-|}>;