@instructure/ui-test-utils

const expect: Chai.ExpectStatic;

const wait: (
    callback?: () => void,
    { timeout, interval }?: { timeout?: number; interval?: number }
) => Promise<{}>;

const within: any;

const wrap: any;

generateA11yTests: <Props extends Record<string, any>>(
    Component: React.ComponentType<any>,
    componentExample: StoryConfig<Props>,
    ariaRulesToIgnore?: string[]
) => void;

generateComponentExamples: <Props extends Record<string, any>>(
    Component: ComponentType<any>,
    config: StoryConfig<Props>
) => ExampleSection<Props>[];

generatePropCombinations: <T extends Record<string, unknown>>(
    propValues: Props<T>
) => Record<keyof Props<T>, ArrayElement<Props<T>[keyof Props<T>]>>[];

waitForExpect: (
    callback?: () => void,
    {
        timeout,
        interval,
    }?: { timeout?: number | undefined; interval?: number | undefined }
) => Promise<{}>;

type Example<Props> = {
    Component: ComponentType;
    componentProps: Partial<Props>;
    exampleProps: Record<string, any>;
    key: string;
};

type ExamplesPage<Props> = {
    examples: Example<Props>[];
    index: number;
    renderExample?: (exampleProps: Example<Props>) => ReactNode;
    parameters?: Record<string, unknown>;
};

type StoryConfig<Props> = {
    /**
     * Used to divide the resulting examples into sections. It should correspond
     * to an enumerated prop in the Component
     */
    sectionProp?: keyof Props;
    /**
     * Specifies the max number of examples that can exist in a single page
     * within a section
     */
    maxExamplesPerPage?: number | ((sectionName: string) => number);
    /**
     * Specifies the total max number of examples. Default: 500
     */
    maxExamples?: number;
    /**
     * An object with keys that correspond to the component props. Each key has a
     * corresponding value array. This array contains possible values for that prop.
     */
    propValues?: Partial<Record<keyof Props | string, any[]>>;
    /**
     * Prop keys to exclude from propValues. Useful when generating propValues with code.
     */
    excludeProps?: (keyof Props)[];
    /**
     * The values returned by this function are passed to the component.
     * A function called with the prop combination for the current example. It
     * returns an object of props that will be passed into the `renderExample`
     * function as componentProps.
     */
    getComponentProps?: (props: Props & Record<string, any>) => Partial<Props>;
    /**
     * The values returned by this function are passed to a `View` that wraps the
     * example.
     * A function called with the prop combination for the current example. It
     * returns an object of props that will be passed into the `renderExample`
     * function as exampleProps.
     */
    getExampleProps?: (props: Props & Record<string, any>) => Record<string, any>;
    /**
     * A function called with the examples and index for the current page of
     * examples. It returns an object of parameters/metadata for that page of
     * examples (e.g. to be passed in to a visual regression tool like chromatic).
     */
    getParameters?: (params: ExamplesPage<Props>) => {
        [key: string]: any;
        delay?: number;
        disable?: boolean;
    };
    filter?: (props: Props) => boolean;
};