@khanacademy/wonder-blocks-testing 7.1.10 → 7.1.12

package/dist/fetch/types.js.flow

@@ -0,0 +1,19 @@
+/**
+ * Flowtype definitions for types
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+
+import type { MockResponse } from "../respond-with";
+export type FetchMockOperation = RegExp | string;
+declare type FetchMockOperationFn = (
+  operation: FetchMockOperation,
+  response: MockResponse<any>
+) => FetchMockFn;
+export type FetchMockFn = {
+  (input: RequestInfo, init?: RequestInit): Promise<Response>,
+  mockOperation: FetchMockOperationFn,
+  mockOperationOnce: FetchMockOperationFn,
+  ...
+};

package/dist/fixtures/fixtures.basic.stories.d.ts

@@ -0,0 +1,13 @@
+import * as React from "react";
+type Props = {
+    propA: string;
+    propB?: string;
+};
+export declare const F1: unknown;
+export declare const F2: unknown;
+export declare const F3: unknown;
+declare const _default: {
+    title: string;
+    component: React.FC<Props>;
+};
+export default _default;

package/dist/fixtures/fixtures.basic.stories.js.flow

@@ -0,0 +1,22 @@
+/**
+ * Flowtype definitions for fixtures.basic.stories
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+
+import * as React from "react";
+declare type Props = {
+  propA: string,
+  propB?: string,
+  ...
+};
+declare export var F1: mixed;
+declare export var F2: mixed;
+declare export var F3: mixed;
+declare var _default: {
+  title: string,
+  component: React.FC<Props>,
+  ...
+};
+declare export default typeof _default;

package/dist/fixtures/fixtures.d.ts

@@ -0,0 +1,19 @@
+import * as React from "react";
+import type { FixtureFn } from "./types";
+/**
+ * Describe a group of fixtures for a given component.
+ *
+ * Only one `fixtures` call should be used per fixture file as it returns
+ * the exports for that file.
+ *
+ * @param {component: React.ComponentType<any>} options Options describing the
+ * fixture group.
+ * @param {FixtureFn<TProps> => void} fn A function that provides a `fixture`
+ * function for defining fixtures.
+ * @returns {(
+ *    description: string,
+ *    props: FixtureProps<TProps>,
+ *    wrapper?: React.ComponentType<TProps>,
+ * ) => mixed} A function to create a CSF compatible story.
+ */
+export declare const fixtures: <TComponent extends React.ComponentType<any>, TProps extends JSX.LibraryManagedAttributes<TComponent, React.ComponentProps<TComponent>>>(Component: TComponent) => FixtureFn<TProps>;

package/dist/fixtures/fixtures.defaultwrapper.stories.d.ts

@@ -0,0 +1,9 @@
+import * as React from "react";
+type Props = Record<any, any>;
+export declare const F1: unknown;
+export declare const F2: unknown;
+declare const _default: {
+    title: string;
+    component: React.FC<Props>;
+};
+export default _default;

package/dist/fixtures/fixtures.defaultwrapper.stories.js.flow

@@ -0,0 +1,17 @@
+/**
+ * Flowtype definitions for fixtures.defaultwrapper.stories
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+
+import * as React from "react";
+declare type Props = { [key: any]: any, ... };
+declare export var F1: mixed;
+declare export var F2: mixed;
+declare var _default: {
+  title: string,
+  component: React.FC<Props>,
+  ...
+};
+declare export default typeof _default;

package/dist/fixtures/fixtures.js.flow

@@ -0,0 +1,33 @@
+/**
+ * Flowtype definitions for fixtures
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+
+import * as React from "react";
+import type { FixtureFn } from "./types";
+
+/**
+ * Describe a group of fixtures for a given component.
+ * 
+ * Only one `fixtures` call should be used per fixture file as it returns
+ * the exports for that file.
+ * @param {component}  : React.ComponentType<any>} options Options describing the
+ * fixture group.
+ * @param {FixtureFn<TProps>}  => void} fn A function that provides a `fixture`
+ * function for defining fixtures.
+ * @returns {(
+description: string,
+props: FixtureProps<TProps>,
+wrapper?: React.ComponentType<TProps>) => mixed} A function to create a CSF compatible story.
+ */
+declare export var fixtures: <
+  TComponent: React.ComponentType<any>,
+  TProps: JSX.LibraryManagedAttributes<
+    TComponent,
+    React.ComponentProps<TComponent>
+  >
+>(
+  Component: TComponent
+) => FixtureFn<TProps>;

package/dist/fixtures/types.d.ts

@@ -0,0 +1,36 @@
+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 extends Record<any, any>> = Readonly<TProps> | ((options: Readonly<GetPropsOptions>) => Readonly<TProps>);
+/**
+ * A function for defining a fixture.
+ */
+export type FixtureFn<TProps extends Record<any, any>> = (
+/**
+ * The name of the fixture.
+ */
+description: string, 
+/**
+ * The props for the fixture or a function that returns the props.
+ * The function is injected with an API to facilitate logging.
+ */
+props: FixtureProps<TProps>, 
+/**
+ * An alternative component to render for the fixture.
+ * Useful if the fixture requires some additional setup for testing the
+ * component.
+ */
+wrapper?: React.ComponentType<TProps>) => unknown;

package/dist/fixtures/types.js.flow

@@ -0,0 +1,37 @@
+/**
+ * Flowtype definitions for types
+ * 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: { [key: any]: any, ... }> =
+  | $ReadOnly<TProps>
+  | ((options: $ReadOnly<GetPropsOptions>) => $ReadOnly<TProps>);
+/**
+ * A function for defining a fixture.
+ */
+export type FixtureFn<TProps: { [key: any]: any, ... }> = (
+  description: string,
+  props: FixtureProps<TProps>,
+  wrapper?: React.ComponentType<TProps>
+) => mixed;

package/dist/gql/gql-request-matches-mock.d.ts

@@ -0,0 +1,3 @@
+import type { GqlOperation, GqlContext } from "@khanacademy/wonder-blocks-data";
+import type { GqlMockOperation } from "./types";
+export declare const gqlRequestMatchesMock: (mock: GqlMockOperation<any, any, any>, operation: GqlOperation<any, any>, variables: Record<any, any> | null | undefined, context: GqlContext) => boolean;

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

@@ -0,0 +1,15 @@
+/**
+ * Flowtype definitions for gql-request-matches-mock
+ * 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.d.ts

@@ -0,0 +1,5 @@
+import type { GqlFetchMockFn } from "./types";
+/**
+ * A mock for the fetch function passed to GqlRouter.
+ */
+export declare const mockGqlFetch: () => GqlFetchMockFn;

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

@@ -0,0 +1,13 @@
+/**
+ * Flowtype definitions for mock-gql-fetch
+ * 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.d.ts

@@ -0,0 +1,15 @@
+import type { GqlOperation, GqlContext } from "@khanacademy/wonder-blocks-data";
+import type { GraphQLJson } from "../types";
+import type { MockResponse } from "../respond-with";
+export type GqlMockOperation<TData extends Record<any, any>, TVariables extends Record<any, any>, TContext extends GqlContext> = {
+    operation: GqlOperation<TData, TVariables>;
+    variables?: TVariables;
+    context?: TContext;
+};
+type GqlMockOperationFn = <TData extends Record<any, any>, TVariables extends Record<any, any>, TContext extends GqlContext, TResponseData extends GraphQLJson<TData>>(operation: GqlMockOperation<TData, TVariables, TContext>, response: MockResponse<TResponseData>) => GqlFetchMockFn;
+export type GqlFetchMockFn = {
+    (operation: GqlOperation<any, any>, variables: Record<any, any> | null | undefined, context: GqlContext): Promise<Response>;
+    mockOperation: GqlMockOperationFn;
+    mockOperationOnce: GqlMockOperationFn;
+};
+export {};

package/dist/gql/types.js.flow

@@ -0,0 +1,39 @@
+/**
+ * Flowtype definitions for types
+ * 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.d.ts

@@ -0,0 +1,35 @@
+/// <reference path="../../../types/aphrodite.d.ts" />
+import type { TestHarnessConfigs } 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.
+ */
+export declare const DefaultAdapters: {
+    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;
+    }>>;
+};
+/**
+ * The default configurations to use with the `DefaultAdapters`.
+ */
+export declare const DefaultConfigs: TestHarnessConfigs<typeof DefaultAdapters>;

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

@@ -0,0 +1,69 @@
+/**
+ * Flowtype definitions for adapters
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+
+import * as $Flowgen$Import$_2e__2e__2f_types from "../types";
+import * as $Flowgen$Import$aphrodite from "aphrodite";
+import * as $Flowgen$Import$history from "history";
+import type { TestHarnessConfigs } 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: $Flowgen$Import$_2e__2e__2f_types.TestHarnessAdapter<
+    | string
+    | string[]
+    | $Flowgen$Import$aphrodite.CSSProperties
+    | {
+        classes: string[],
+        style: $Flowgen$Import$aphrodite.CSSProperties,
+        ...
+      }
+  >,
+  +data: $Flowgen$Import$_2e__2e__2f_types.TestHarnessAdapter<
+    | ((requestId: string) => Promise<any> | null | void)
+    | ((requestId: string) => Promise<any> | null | void)[]
+  >,
+  +portal: $Flowgen$Import$_2e__2e__2f_types.TestHarnessAdapter<string>,
+  +router: $Flowgen$Import$_2e__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,
+            ...
+          }
+      >
+  >,
+  ...
+};
+/**
+ * The default configurations to use with the `DefaultAdapters`.
+ */
+declare export var DefaultConfigs: TestHarnessConfigs<typeof DefaultAdapters>;

package/dist/harness/adapters/css.d.ts

@@ -0,0 +1,12 @@
+import type { CSSProperties } from "aphrodite";
+import type { TestHarnessAdapter } from "../types";
+type Config = string | Array<string> | CSSProperties | {
+    classes: Array<string>;
+    style: CSSProperties;
+};
+export declare const defaultConfig: Config | null | undefined;
+/**
+ * Test harness adapter for adding CSS to the harnessed component wrapper.
+ */
+export declare const adapter: TestHarnessAdapter<Config>;
+export {};

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

@@ -0,0 +1,23 @@
+/**
+ * Flowtype definitions for css
+ * 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.d.ts

@@ -0,0 +1,18 @@
+import * as React from "react";
+import { InterceptRequests } from "@khanacademy/wonder-blocks-data";
+import type { TestHarnessAdapter } from "../types";
+type Interceptor = JSX.LibraryManagedAttributes<typeof InterceptRequests, React.ComponentProps<typeof InterceptRequests>>["interceptor"];
+type Config = Interceptor | Array<Interceptor>;
+/**
+ * Default configuration for the Wonder Blocks Data adapter.
+ */
+export declare const defaultConfig: ((requestId: string) => Promise<any> | null | undefined)[];
+/**
+ * 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.
+ */
+export declare const adapter: TestHarnessAdapter<Config>;
+export {};

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

@@ -0,0 +1,32 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+
+import * as React from "react";
+import { InterceptRequests } from "@khanacademy/wonder-blocks-data";
+import type { TestHarnessAdapter } from "../types";
+declare type Interceptor = $PropertyType<
+  JSX.LibraryManagedAttributes<
+    typeof InterceptRequests,
+    React.ComponentProps<typeof InterceptRequests>
+  >,
+  "interceptor"
+>;
+declare type Config = Interceptor | Array<Interceptor>;
+/**
+ * Default configuration for the Wonder Blocks Data adapter.
+ */
+declare export var defaultConfig: ((
+  requestId: string
+) => Promise<any> | 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.d.ts

@@ -0,0 +1,12 @@
+import type { TestHarnessAdapter } from "../types";
+type Config = string;
+export declare const defaultConfig: Config | null | undefined;
+/**
+ * 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.
+ */
+export declare const adapter: TestHarnessAdapter<Config>;
+export {};

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

@@ -0,0 +1,18 @@
+/**
+ * Flowtype definitions for portal
+ * 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.d.ts

@@ -0,0 +1,94 @@
+import * as React from "react";
+import { MemoryRouter } from "react-router-dom";
+import type { LocationShape, Location } from "react-router-dom";
+import type { TestHarnessAdapter } from "../types";
+type MemoryRouterProps = JSX.LibraryManagedAttributes<typeof MemoryRouter, React.ComponentProps<typeof MemoryRouter>>;
+/**
+ * Configuration for the withLocation test harness adapter.
+ */
+type Config = Readonly<{
+    /**
+     * See MemoryRouter prop for initialEntries.
+     */
+    initialEntries: MemoryRouterProps["initialEntries"];
+    /**
+     * See MemoryRouter prop for initialIndex.
+     */
+    initialIndex?: MemoryRouterProps["initialIndex"];
+    /**
+     * See MemoryRouter prop for getUserConfirmation.
+     */
+    getUserConfirmation?: 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.
+ */
+export declare const defaultConfig: {
+    readonly 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.
+ */
+export declare const adapter: TestHarnessAdapter<Config>;
+export {};