@storybook/test 7.6.0-alpha.3 → 7.6.0-alpha.5

package/README.md

@@ -0,0 +1,41 @@
+# Storybook Test
+
+The `@storybook/test` package contains utilities for testing your stories inside `play` functions.
+
+## Installation
+
+Install the package by adding the `@storybook/test` dev dependency:
+
+```sh
+npm install -D @storybook/test
+pnpm add -D @storybook/test
+yarn add -D @storybook/test
+```
+
+Note that this package is not an addon, so you don't have to add it to your `main.js/main.ts` file.
+
+## Usage
+
+The test package exports instrumented versions of [@vitest/spy](https://vitest.dev/api/mock.html), [@vitest/expect](https://vitest.dev/api/expect.html) (based on [chai](https://www.chaijs.com/)), [@testing-library/dom](https://testing-library.com/docs/dom-testing-library/intro) and [@testing-library/user-event](https://testing-library.com/docs/user-event/intro).
+The instrumentation makes sure you can debug those methods in the [addon-interactions](https://storybook.js.org/addons/@storybook/addon-interactions) panel.
+
+```ts
+// Button.stories.ts
+import { Button } from './Button';
+import { within, userEvent, expect, fn } from '@storybook/test';
+
+export default {
+  component: Button,
+  args: {
+    onClick: fn(),
+  },
+};
+
+export const Demo = {
+  play: async ({ args, canvasElement }) => {
+    const canvas = within(canvasElement);
+    await userEvent.click(canvas.getByRole('button'));
+    await expect(args.onClick).toHaveBeenCalled();
+  },
+};
+```

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { AsymmetricMatchersContaining, MatchersObject, MatcherState, JestAssertion, ExpectStatic } from '@vitest/expect';
-import { TestingLibraryMatchers } from '@testing-library/jest-dom/types/matchers';
+import * as matchers from '@testing-library/jest-dom/matchers';
 export * from '@vitest/spy';
 import * as _testing_library_user_event_dist_types_setup_directApi from '@testing-library/user-event/dist/types/setup/directApi';
 import * as _testing_library_user_event_dist_types_setup_setup from '@testing-library/user-event/dist/types/setup/setup';
@@ -10,7 +10,8 @@ type PromisifyObject<O> = {
     [K in keyof O]: Promisify<O[K]>;
 };
 
-interface Assertion<T> extends PromisifyObject<JestAssertion<T>>, TestingLibraryMatchers<ReturnType<ExpectStatic['stringContaining']>, Promise<void>> {
+type Matchers<T> = PromisifyObject<JestAssertion<T>> & matchers.TestingLibraryMatchers<ReturnType<ExpectStatic['stringContaining']>, Promise<void>>;
+interface Assertion<T> extends Matchers<T> {
     toHaveBeenCalledOnce(): Promise<void>;
     toSatisfy<E>(matcher: (value: E) => boolean, message?: string): Promise<void>;
     resolves: Assertion<T>;