@storybook/test 8.3.0-alpha.1 → 8.3.0-alpha.11

package/README.md

@@ -21,8 +21,8 @@ The instrumentation makes sure you can debug those methods in the [addon-interac
 
 ```ts
 // Button.stories.ts
+import { expect, fn, userEvent, within } from '@storybook/test';
 import { Button } from './Button';
-import { within, userEvent, expect, fn } from '@storybook/test';
 
 export default {
   component: Button,

package/dist/index.d.ts

@@ -1,8 +1,9 @@
-import { AsymmetricMatchersContaining, MatchersObject, MatcherState, JestAssertion, ExpectStatic } from '@vitest/expect';
 import { TestingLibraryMatchers } from '@testing-library/jest-dom/matchers';
+import { AsymmetricMatchersContaining, MatchersObject, MatcherState, JestAssertion, ExpectStatic } from '@vitest/expect';
 import * as domTestingLibrary from '@testing-library/dom';
+import { BoundFunctions } from '@testing-library/dom';
 import _userEvent from '@testing-library/user-event';
-import { spyOn as spyOn$1, fn as fn$1, MaybeMocked, MaybeMockedDeep, MaybePartiallyMocked, MaybePartiallyMockedDeep, MockInstance } from '@vitest/spy';
+import { spyOn as spyOn$1, Mock as Mock$1, MaybeMocked, MaybeMockedDeep, MaybePartiallyMocked, MaybePartiallyMockedDeep, MockInstance } from '@vitest/spy';
 export * from '@vitest/spy';
 export { isMockFunction, mocks } from '@vitest/spy';
 
@@ -113,28 +114,39 @@ declare const userEvent: UserEvent;
 type Listener = (mock: MockInstance, args: unknown[]) => void;
 declare function onMockCall(callback: Listener): () => void;
 declare const spyOn: typeof spyOn$1;
-declare const fn: typeof fn$1;
+type Procedure = (...args: any[]) => any;
+type Mock<T extends Procedure | any[] = any[], R = any> = T extends Procedure ? Mock$1<T> : T extends any[] ? Mock$1<(...args: T) => R> : never;
+declare function fn<T extends Procedure = Procedure>(implementation?: T): Mock<T>;
+declare function fn<TArgs extends any[] = any, R = any>(): Mock<(...args: TArgs) => R>;
+declare function fn<TArgs extends any[] = any[], R = any>(implementation: (...args: TArgs) => R): Mock<(...args: TArgs) => R>;
+declare function fn<TArgs extends any[] = any[], R = any>(implementation?: (...args: TArgs) => R): Mock<(...args: TArgs) => R>;
 /**
- * Calls [`.mockClear()`](https://vitest.dev/api/mock#mockclear) on every mocked function. This will only empty `.mock` state, it will not reset implementation.
+ * Calls [`.mockClear()`](https://vitest.dev/api/mock#mockclear) on every mocked function. This will
+ * only empty `.mock` state, it will not reset implementation.
  *
  * It is useful if you need to clean up mock between different assertions.
  */
 declare function clearAllMocks(): void;
 /**
- * Calls [`.mockReset()`](https://vitest.dev/api/mock#mockreset) on every mocked function. This will empty `.mock` state, reset "once" implementations and force the base implementation to return `undefined` when invoked.
+ * Calls [`.mockReset()`](https://vitest.dev/api/mock#mockreset) on every mocked function. This will
+ * empty `.mock` state, reset "once" implementations and force the base implementation to return
+ * `undefined` when invoked.
  *
  * This is useful when you want to completely reset a mock to the default state.
  */
 declare function resetAllMocks(): void;
 /**
- * Calls [`.mockRestore()`](https://vitest.dev/api/mock#mockrestore) on every mocked function. This will restore all original implementations.
+ * Calls [`.mockRestore()`](https://vitest.dev/api/mock#mockrestore) on every mocked function. This
+ * will restore all original implementations.
  */
 declare function restoreAllMocks(): void;
 /**
  * Type helper for TypeScript. Just returns the object that was passed.
  *
- * When `partial` is `true` it will expect a `Partial<T>` as a return value. By default, this will only make TypeScript believe that
- * the first level values are mocked. You can pass down `{ deep: true }` as a second argument to tell TypeScript that the whole object is mocked, if it actually is.
+ * When `partial` is `true` it will expect a `Partial<T>` as a return value. By default, this will
+ * only make TypeScript believe that the first level values are mocked. You can pass down `{ deep:
+ * true }` as a second argument to tell TypeScript that the whole object is mocked, if it actually
+ * is.
  *
  * @param item Anything that can be mocked
  * @param deep If the object is deeply mocked
@@ -160,7 +172,7 @@ declare function mocked<T>(item: T, options: {
 }): MaybePartiallyMockedDeep<T>;
 declare function mocked<T>(item: T): MaybeMocked<T>;
 
-type Queries = ReturnType<typeof within<typeof queries>>;
+type Queries = BoundFunctions<typeof queries>;
 declare module '@storybook/csf' {
     interface Canvas extends Queries {
     }
@@ -171,4 +183,4 @@ declare const expect: Expect;
 
 declare const traverseArgs: (value: unknown, depth?: number, key?: string) => unknown;
 
-export { UserEvent, buildQueries, clearAllMocks, configure, createEvent, expect, findAllByAltText, findAllByDisplayValue, findAllByLabelText, findAllByPlaceholderText, findAllByRole, findAllByTestId, findAllByText, findAllByTitle, findByAltText, findByDisplayValue, findByLabelText, findByPlaceholderText, findByRole, findByTestId, findByText, findByTitle, fireEvent, fn, getAllByAltText, getAllByDisplayValue, getAllByLabelText, getAllByPlaceholderText, getAllByRole, getAllByTestId, getAllByText, getAllByTitle, getByAltText, getByDisplayValue, getByLabelText, getByPlaceholderText, getByRole, getByTestId, getByText, getByTitle, getConfig, getDefaultNormalizer, getElementError, getNodeText, getQueriesForElement, getRoles, getSuggestedQuery, isInaccessible, logDOM, logRoles, mocked, onMockCall, prettyDOM, prettyFormat, queries, queryAllByAltText, queryAllByAttribute, queryAllByDisplayValue, queryAllByLabelText, queryAllByPlaceholderText, queryAllByRole, queryAllByTestId, queryAllByText, queryAllByTitle, queryByAltText, queryByAttribute, queryByDisplayValue, queryByLabelText, queryByPlaceholderText, queryByRole, queryByTestId, queryByText, queryByTitle, queryHelpers, resetAllMocks, restoreAllMocks, screen, spyOn, traverseArgs, userEvent, waitFor, waitForElementToBeRemoved, within };
+export { Mock, UserEvent, buildQueries, clearAllMocks, configure, createEvent, expect, findAllByAltText, findAllByDisplayValue, findAllByLabelText, findAllByPlaceholderText, findAllByRole, findAllByTestId, findAllByText, findAllByTitle, findByAltText, findByDisplayValue, findByLabelText, findByPlaceholderText, findByRole, findByTestId, findByText, findByTitle, fireEvent, fn, getAllByAltText, getAllByDisplayValue, getAllByLabelText, getAllByPlaceholderText, getAllByRole, getAllByTestId, getAllByText, getAllByTitle, getByAltText, getByDisplayValue, getByLabelText, getByPlaceholderText, getByRole, getByTestId, getByText, getByTitle, getConfig, getDefaultNormalizer, getElementError, getNodeText, getQueriesForElement, getRoles, getSuggestedQuery, isInaccessible, logDOM, logRoles, mocked, onMockCall, prettyDOM, prettyFormat, queries, queryAllByAltText, queryAllByAttribute, queryAllByDisplayValue, queryAllByLabelText, queryAllByPlaceholderText, queryAllByRole, queryAllByTestId, queryAllByText, queryAllByTitle, queryByAltText, queryByAttribute, queryByDisplayValue, queryByLabelText, queryByPlaceholderText, queryByRole, queryByTestId, queryByText, queryByTitle, queryHelpers, resetAllMocks, restoreAllMocks, screen, spyOn, traverseArgs, userEvent, waitFor, waitForElementToBeRemoved, within };