@mui/internal-test-utils 1.0.0-dev.20240529-082515-213b5e33ab

package/build/describeConformance.d.ts

@@ -0,0 +1,152 @@
+import * as React from 'react';
+import { ReactWrapper } from 'enzyme';
+import { MuiRenderResult } from './createRenderer';
+export interface SlotTestingOptions {
+    /**
+     * A custom React component to test if the receiving props are correct.
+     *
+     * It must:
+     * - contains at least one DOM which has `data-testid="custom"`
+     * - spread `className` to the DOM
+     *
+     * If not provided, the default custom component tests if the class name is spread.
+     */
+    testWithComponent?: React.ComponentType;
+    /**
+     * A custom HTML tag to use for the `slots` prop.
+     */
+    testWithElement?: keyof React.JSX.IntrinsicElements | null;
+    /**
+     * To ensure that the slot has this class name when `slotProps` is provided.
+     */
+    expectedClassName: string;
+    isOptional?: boolean;
+}
+interface SlotTestOverride {
+    slotName: string;
+    slotClassName?: string;
+}
+export interface ConformanceOptions {
+    muiName: string;
+    classes: {
+        root: string;
+    };
+    refInstanceof: any;
+    after?: () => void;
+    inheritComponent?: React.ElementType;
+    render: (node: React.ReactElement<any>) => MuiRenderResult;
+    mount?: (node: React.ReactElement<any>) => ReactWrapper;
+    only?: Array<keyof typeof fullSuite>;
+    skip?: Array<keyof typeof fullSuite | 'classesRoot'>;
+    testComponentsRootPropWith?: string;
+    testComponentPropWith?: string | React.ElementType;
+    testDeepOverrides?: SlotTestOverride | SlotTestOverride[];
+    testRootOverrides?: SlotTestOverride;
+    testStateOverrides?: {
+        prop?: string;
+        value?: any;
+        styleKey: string;
+    };
+    testCustomVariant?: boolean;
+    testVariantProps?: object;
+    testLegacyComponentsProp?: boolean;
+    wrapMount?: (mount: (node: React.ReactElement<any>) => ReactWrapper) => (node: React.ReactElement<any>) => ReactWrapper;
+    slots?: Record<string, SlotTestingOptions>;
+    ThemeProvider?: React.ElementType;
+    createTheme?: (arg: any) => any;
+}
+/**
+ * Glossary
+ * - root component:
+ *   - renders the outermost host component
+ *   - has the `root` class if the component has one
+ *   - excess props are spread to this component
+ *   - has the type of `inheritComponent`
+ */
+/**
+ * Returns the component with the same constructor as `component` that renders
+ * the outermost host
+ */
+export declare function findRootComponent(wrapper: ReactWrapper, component: string | React.ElementType): ReactWrapper<import("enzyme").HTMLAttributes, any, React.Component<{}, {}, any>>;
+export declare function randomStringValue(): string;
+/**
+ * MUI components have a `className` prop. The `className` is applied to
+ * the root component.
+ */
+export declare function testClassName(element: React.ReactElement<any>, getOptions: () => ConformanceOptions): void;
+/**
+ * MUI components have a `component` prop that allows rendering a different
+ * Component from @inheritComponent
+ */
+export declare function testComponentProp(element: React.ReactElement<any>, getOptions: () => ConformanceOptions): void;
+/**
+ * MUI components can spread additional props to a documented component.
+ */
+export declare function testPropsSpread(element: React.ReactElement<any>, getOptions: () => ConformanceOptions): void;
+/**
+ * Tests that the `ref` of a component will return the correct instance
+ *
+ * This is determined by a given constructor i.e. a React.Component or HTMLElement for
+ * components that forward their ref and attach it to a host component.
+ */
+export declare function describeRef(element: React.ReactElement<any>, getOptions: () => ConformanceOptions): void;
+/**
+ * Tests that the root component has the root class
+ */
+export declare function testRootClass(element: React.ReactElement<any>, getOptions: () => ConformanceOptions): void;
+/**
+ * Tests that the component can be rendered with react-test-renderer.
+ * This is important for snapshot testing with Jest (even if we don't encourage it).
+ */
+export declare function testReactTestRenderer(element: React.ReactElement<any>): void;
+declare function testSlotsProp(element: React.ReactElement<any>, getOptions: () => ConformanceOptions): void;
+declare function testSlotPropsProp(element: React.ReactElement<any>, getOptions: () => ConformanceOptions): void;
+declare function testSlotPropsCallback(element: React.ReactElement<any>, getOptions: () => ConformanceOptions): void;
+/**
+ * MUI components have a `components` prop that allows rendering a different
+ * Components from @inheritComponent
+ */
+declare function testComponentsProp(element: React.ReactElement<any>, getOptions: () => ConformanceOptions): void;
+/**
+ * MUI theme has a components section that allows specifying default props.
+ * Components from @inheritComponent
+ */
+declare function testThemeDefaultProps(element: React.ReactElement<any>, getOptions: () => ConformanceOptions): void;
+/**
+ * MUI theme has a components section that allows specifying style overrides.
+ * Components from @inheritComponent
+ */
+declare function testThemeStyleOverrides(element: React.ReactElement<any>, getOptions: () => ConformanceOptions): void;
+/**
+ * MUI theme has a components section that allows specifying custom variants.
+ * Components from @inheritComponent
+ */
+declare function testThemeVariants(element: React.ReactElement<any>, getOptions: () => ConformanceOptions): void;
+/**
+ * MUI theme supports custom palettes.
+ * The components that iterate over the palette via `variants` should be able to render with or without applying the custom palette styles.
+ */
+declare function testThemeCustomPalette(element: React.ReactElement<any>, getOptions: () => ConformanceOptions): void;
+declare const fullSuite: {
+    componentProp: typeof testComponentProp;
+    componentsProp: typeof testComponentsProp;
+    mergeClassName: typeof testClassName;
+    propsSpread: typeof testPropsSpread;
+    refForwarding: typeof describeRef;
+    rootClass: typeof testRootClass;
+    reactTestRenderer: typeof testReactTestRenderer;
+    slotPropsProp: typeof testSlotPropsProp;
+    slotPropsCallback: typeof testSlotPropsCallback;
+    slotsProp: typeof testSlotsProp;
+    themeDefaultProps: typeof testThemeDefaultProps;
+    themeStyleOverrides: typeof testThemeStyleOverrides;
+    themeVariants: typeof testThemeVariants;
+    themeCustomPalette: typeof testThemeCustomPalette;
+};
+declare const _default: {
+    (minimalElement: React.ReactElement<any, string | React.JSXElementConstructor<any>>, getOptions: () => ConformanceOptions): void;
+    skip: (minimalElement: React.ReactElement<any, string | React.JSXElementConstructor<any>>, getOptions: () => ConformanceOptions) => void;
+    only: (minimalElement: React.ReactElement<any, string | React.JSXElementConstructor<any>>, getOptions: () => ConformanceOptions) => void;
+};
+export default _default;
+//# sourceMappingURL=describeConformance.d.ts.map

package/build/describeConformance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"describeConformance.d.ts","sourceRoot":"","sources":["../src/describeConformance.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAKtC,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAMnD,MAAM,WAAW,kBAAkB;IACjC;;;;;;;;OAQG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;IACxC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,KAAK,CAAC,GAAG,CAAC,iBAAiB,GAAG,IAAI,CAAC;IAC3D;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,UAAU,gBAAgB;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAC1B,aAAa,EAAE,GAAG,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,IAAI,CAAC;IACnB,gBAAgB,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC;IACrC,MAAM,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,eAAe,CAAC;IAC3D,KAAK,CAAC,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,YAAY,CAAC;IACxD,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,OAAO,SAAS,CAAC,CAAC;IACrC,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,OAAO,SAAS,GAAG,aAAa,CAAC,CAAC;IACrD,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC,qBAAqB,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,WAAW,CAAC;IACnD,iBAAiB,CAAC,EAAE,gBAAgB,GAAG,gBAAgB,EAAE,CAAC;IAC1D,iBAAiB,CAAC,EAAE,gBAAgB,CAAC;IACrC,kBAAkB,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,GAAG,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC;IACtE,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC,SAAS,CAAC,EAAE,CACV,KAAK,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,YAAY,KACnD,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,YAAY,CAAC;IACrD,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;IAC3C,aAAa,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC;IAClC,WAAW,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,CAAC;CACjC;AA8BD;;;;;;;GAOG;AAEH;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,GAAG,KAAK,CAAC,WAAW,oFAM7F;AAED,wBAAgB,iBAAiB,WAEhC;AASD;;;GAGG;AACH,wBAAgB,aAAa,CAC3B,OAAO,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,EAChC,UAAU,EAAE,MAAM,kBAAkB,QAcrC;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,OAAO,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,EAChC,UAAU,EAAE,MAAM,kBAAkB,QAcrC;AAED;;GAEG;AACH,wBAAgB,eAAe,CAC7B,OAAO,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,EAChC,UAAU,EAAE,MAAM,kBAAkB,QAuBrC;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CACzB,OAAO,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,EAChC,UAAU,EAAE,MAAM,kBAAkB,QAiBrC;AAED;;GAEG;AACH,wBAAgB,aAAa,CAC3B,OAAO,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,EAChC,UAAU,EAAE,MAAM,kBAAkB,QAkCrC;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,QAUrE;AAiBD,iBAAS,aAAa,CAAC,OAAO,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,UAAU,EAAE,MAAM,kBAAkB,QAyK5F;AAED,iBAAS,iBAAiB,CAAC,OAAO,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,UAAU,EAAE,MAAM,kBAAkB,QAiFhG;AAED,iBAAS,qBAAqB,CAC5B,OAAO,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,EAChC,UAAU,EAAE,MAAM,kBAAkB,QAuBrC;AAED;;;GAGG;AACH,iBAAS,kBAAkB,CACzB,OAAO,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,EAChC,UAAU,EAAE,MAAM,kBAAkB,QAcrC;AAED;;;GAGG;AACH,iBAAS,qBAAqB,CAC5B,OAAO,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,EAChC,UAAU,EAAE,MAAM,kBAAkB,QAsCrC;AAED;;;GAGG;AACH,iBAAS,uBAAuB,CAC9B,OAAO,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,EAChC,UAAU,EAAE,MAAM,kBAAkB,QA+OrC;AAED;;;GAGG;AACH,iBAAS,iBAAiB,CAAC,OAAO,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,UAAU,EAAE,MAAM,kBAAkB,QAmGhG;AAED;;;GAGG;AACH,iBAAS,sBAAsB,CAC7B,OAAO,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,EAChC,UAAU,EAAE,MAAM,kBAAkB,QAqBrC;AAED,QAAA,MAAM,SAAS;;;;;;;;;;;;;;;CAed,CAAC;;;;;;AAuEF,wBAAwE"}