@testing-library/svelte 5.3.1 → 5.4.0

package/README.md

@@ -238,10 +238,19 @@ Thanks goes to these people ([emoji key][emojis]):
       <td align="center" valign="top" width="14.28%"><a href="http://www.benmccann.com"><img src="https://avatars.githubusercontent.com/u/322311?v=4?s=100" width="100px;" alt="Ben McCann"/><br /><sub><b>Ben McCann</b></sub></a><br /><a href="https://github.com/testing-library/svelte-testing-library/commits?author=benmccann" title="Tests">⚠️</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://johnbowser.dev/"><img src="https://avatars.githubusercontent.com/u/66637570?v=4?s=100" width="100px;" alt="John Bowser"/><br /><sub><b>John Bowser</b></sub></a><br /><a href="https://github.com/testing-library/svelte-testing-library/commits?author=jgbowser" title="Code">💻</a> <a href="https://github.com/testing-library/svelte-testing-library/commits?author=jgbowser" title="Tests">⚠️</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/ysitbon"><img src="https://avatars.githubusercontent.com/u/1370679?v=4?s=100" width="100px;" alt="Yoann"/><br /><sub><b>Yoann</b></sub></a><br /><a href="https://github.com/testing-library/svelte-testing-library/commits?author=ysitbon" title="Code">💻</a></td>
-      <td align="center" valign="top" width="14.28%"><a href="https://techblog.babyl.ca/"><img src="https://avatars.githubusercontent.com/u/19954?v=4?s=100" width="100px;" alt="Yanick Champoux"/><br /><sub><b>Yanick Champoux</b></sub></a><br /><a href="https://github.com/testing-library/svelte-testing-library/commits?author=yanick" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://techblog.babyl.ca/"><img src="https://avatars.githubusercontent.com/u/19954?v=4?s=100" width="100px;" alt="Yanick Champoux"/><br /><sub><b>Yanick Champoux</b></sub></a><br /><a href="https://github.com/testing-library/svelte-testing-library/commits?author=yanick" title="Code">💻</a> <a href="#maintenance-yanick" title="Maintenance">🚧</a></td>
     </tr>
     <tr>
-      <td align="center" valign="top" width="14.28%"><a href="https://michael.cousins.io/"><img src="https://avatars.githubusercontent.com/u/2963448?v=4?s=100" width="100px;" alt="Michael Cousins"/><br /><sub><b>Michael Cousins</b></sub></a><br /><a href="https://github.com/testing-library/svelte-testing-library/commits?author=mcous" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://michael.cousins.io/"><img src="https://avatars.githubusercontent.com/u/2963448?v=4?s=100" width="100px;" alt="Michael Cousins"/><br /><sub><b>Michael Cousins</b></sub></a><br /><a href="#ideas-mcous" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/testing-library/svelte-testing-library/commits?author=mcous" title="Tests">⚠️</a> <a href="#question-mcous" title="Answering Questions">💬</a> <a href="https://github.com/testing-library/svelte-testing-library/commits?author=mcous" title="Code">💻</a> <a href="#maintenance-mcous" title="Maintenance">🚧</a> <a href="https://github.com/testing-library/svelte-testing-library/commits?author=mcous" title="Documentation">📖</a> <a href="#example-mcous" title="Examples">💡</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://dotnet.social/@webJose"><img src="https://avatars.githubusercontent.com/u/25540842?v=4?s=100" width="100px;" alt="José Pablo Ramírez Vargas"/><br /><sub><b>José Pablo Ramírez Vargas</b></sub></a><br /><a href="https://github.com/testing-library/svelte-testing-library/issues?q=author%3AwebJose" title="Bug reports">🐛</a> <a href="#question-webJose" title="Answering Questions">💬</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/stefanhoelzl"><img src="https://avatars.githubusercontent.com/u/1478183?v=4?s=100" width="100px;" alt="Stefan Hoelzl"/><br /><sub><b>Stefan Hoelzl</b></sub></a><br /><a href="#ideas-stefanhoelzl" title="Ideas, Planning, & Feedback">🤔</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/bradyisom"><img src="https://avatars.githubusercontent.com/u/593515?v=4?s=100" width="100px;" alt="Brady Isom"/><br /><sub><b>Brady Isom</b></sub></a><br /><a href="https://github.com/testing-library/svelte-testing-library/issues?q=author%3Abradyisom" title="Bug reports">🐛</a> <a href="#example-bradyisom" title="Examples">💡</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://k776.tumblr.com/"><img src="https://avatars.githubusercontent.com/u/16620?v=4?s=100" width="100px;" alt="Kieran Pilkington"/><br /><sub><b>Kieran Pilkington</b></sub></a><br /><a href="https://github.com/testing-library/svelte-testing-library/issues?q=author%3AKieranP" title="Bug reports">🐛</a> <a href="#example-KieranP" title="Examples">💡</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/cezaryszymanski"><img src="https://avatars.githubusercontent.com/u/104898426?v=4?s=100" width="100px;" alt="Cezary Szymański"/><br /><sub><b>Cezary Szymański</b></sub></a><br /><a href="https://github.com/testing-library/svelte-testing-library/issues?q=author%3Acezaryszymanski" title="Bug reports">🐛</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/neo-noire"><img src="https://avatars.githubusercontent.com/u/111647919?v=4?s=100" width="100px;" alt="Mykola"/><br /><sub><b>Mykola</b></sub></a><br /><a href="#example-neo-noire" title="Examples">💡</a></td>
+    </tr>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/axel7083"><img src="https://avatars.githubusercontent.com/u/42176370?v=4?s=100" width="100px;" alt="axel7083"/><br /><sub><b>axel7083</b></sub></a><br /><a href="#ideas-axel7083" title="Ideas, Planning, & Feedback">🤔</a></td>
     </tr>
   </tbody>
 </table>

package/dist/pure.d.ts

@@ -7,16 +7,17 @@ export type SvelteComponentOptions<C extends import("@testing-library/svelte-cor
 /**
  * Customize how Testing Library sets up the document and binds queries.
  */
-export type RenderOptions<Q extends DomTestingLibrary.Queries = typeof DomTestingLibrary.queries> = import("@testing-library/svelte-core/types").SetupOptions & {
+export type RenderOptions<Q extends DomTestingLibrary.Queries = typeof DomTestingLibrary.queries, W extends import("@testing-library/svelte-core/types").Component = never> = import("@testing-library/svelte-core/types").SetupOptions<W> & {
     queries?: Q;
 };
 /**
  * The rendered component and bound testing functions.
  */
-export type RenderResult<C extends import("@testing-library/svelte-core/types").Component, Q extends DomTestingLibrary.Queries = typeof DomTestingLibrary.queries> = {
+export type RenderResult<C extends import("@testing-library/svelte-core/types").Component, Q extends DomTestingLibrary.Queries = typeof DomTestingLibrary.queries, W extends import("@testing-library/svelte-core/types").Component = never> = {
     container: HTMLElement;
     baseElement: HTMLElement;
     component: import("@testing-library/svelte-core/types").Exports<C>;
+    wrapper: import("@testing-library/svelte-core/types").Exports<W>;
     debug: (el?: HTMLElement | DocumentFragment) => void;
     rerender: import("@testing-library/svelte-core/types").Rerender<C>;
     unmount: () => void;
@@ -60,18 +61,21 @@ export const fireEvent: FireFunction & FireObject;
  * Customize how Testing Library sets up the document and binds queries.
  *
  * @template {DomTestingLibrary.Queries} [Q=typeof DomTestingLibrary.queries]
- * @typedef {import('@testing-library/svelte-core/types').SetupOptions & { queries?: Q }} RenderOptions
+ * @template {import('@testing-library/svelte-core/types').Component} [W=never]
+ * @typedef {import('@testing-library/svelte-core/types').SetupOptions<W> & { queries?: Q }} RenderOptions
  */
 /**
  * The rendered component and bound testing functions.
  *
  * @template {import('@testing-library/svelte-core/types').Component} C
  * @template {DomTestingLibrary.Queries} [Q=typeof DomTestingLibrary.queries]
+ * @template {import('@testing-library/svelte-core/types').Component} [W=never]
  *
  * @typedef {{
  *   container: HTMLElement
  *   baseElement: HTMLElement
  *   component: import('@testing-library/svelte-core/types').Exports<C>
+ *   wrapper: import('@testing-library/svelte-core/types').Exports<W>
  *   debug: (el?: HTMLElement | DocumentFragment) => void
  *   rerender: import('@testing-library/svelte-core/types').Rerender<C>
  *   unmount: () => void
@@ -84,13 +88,14 @@ export const fireEvent: FireFunction & FireObject;
  *
  * @template {import('@testing-library/svelte-core/types').Component} C
  * @template {DomTestingLibrary.Queries} [Q=typeof DomTestingLibrary.queries]
+ * @template {import('@testing-library/svelte-core/types').Component} [W=never]
  *
  * @param {import('@testing-library/svelte-core/types').ComponentImport<C>} Component - The component to render.
  * @param {import('@testing-library/svelte-core/types').ComponentOptions<C>} options - Customize how Svelte renders the component.
- * @param {RenderOptions<Q>} renderOptions - Customize how Testing Library sets up the document and binds queries.
- * @returns {RenderResult<C, Q>} The rendered component and bound testing functions.
+ * @param {RenderOptions<Q, W>} renderOptions - Customize how Testing Library sets up the document and binds queries.
+ * @returns {RenderResult<C, Q, W>} The rendered component and bound testing functions.
  */
-export function render<C extends import("@testing-library/svelte-core/types").Component, Q extends DomTestingLibrary.Queries = typeof DomTestingLibrary.queries>(Component: import("@testing-library/svelte-core/types").ComponentImport<C>, options?: import("@testing-library/svelte-core/types").ComponentOptions<C>, renderOptions?: RenderOptions<Q>): RenderResult<C, Q>;
+export function render<C extends import("@testing-library/svelte-core/types").Component, Q extends DomTestingLibrary.Queries = typeof DomTestingLibrary.queries, W extends import("@testing-library/svelte-core/types").Component = never>(Component: import("@testing-library/svelte-core/types").ComponentImport<C>, options?: import("@testing-library/svelte-core/types").ComponentOptions<C>, renderOptions?: RenderOptions<Q, W>): RenderResult<C, Q, W>;
 /**
  * Configure `@testing-library/dom` for usage with Svelte.
  *

package/dist/pure.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pure.d.ts","sourceRoot":"","sources":["../src/pure.js"],"names":[],"mappings":";;;;;mCAOsE,CAAC,SAA1D,OAAQ,oCAAoC,EAAE,SAAU,IACxD,OAAO,oCAAoC,EAAE,gBAAgB,CAAC,CAAC,CAAC;;;;0BAMnC,CAAC,SAA7B,iBAAiB,CAAC,OAAQ,uCAC3B,OAAO,oCAAoC,EAAE,YAAY,GAAG;IAAE,OAAO,CAAC,EAAE,CAAC,CAAA;CAAE;;;;yBAMlB,CAAC,SAA1D,OAAQ,oCAAoC,EAAE,SAAU,EAC3B,CAAC,SAA7B,iBAAiB,CAAC,OAAQ,uCAE3B;IACR,SAAS,EAAE,WAAW,CAAA;IACtB,WAAW,EAAE,WAAW,CAAA;IACxB,SAAS,EAAE,OAAO,oCAAoC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;IAClE,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,WAAW,GAAG,gBAAgB,KAAK,IAAI,CAAA;IACpD,QAAQ,EAAE,OAAO,oCAAoC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAA;IAClE,OAAO,EAAE,MAAM,IAAI,CAAA;CACpB,GAAG,GACD,CAAC,IAAI,MAAM,CAAC,GAAG,iBAAiB,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACtD;2BA+ES,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,iBAAiB,CAAC,YAAY,CAAC,KAAK,OAAO,CAAC,UAAU,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;yBAI5G,GACP,CAAC,IAAI,iBAAiB,CAAC,SAAS,GAAG,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,UAAU,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,GACnJ;AAvBJ;;;;;;GAMG;AACH,oBAJa,CAAC,OACH,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,GAClB,OAAO,CAAC,CAAC,CAAC,CAStB;AAnBD,+FAA+F;AAC/F,gCAEC;AAkBD;;GAEG;AAEH;;;;GAIG;AAEH;;;;;;;GAOG;AACH,wBAFU,YAAY,GAAG,UAAU,CAIlC;AA/HD;;;;;GAKG;AAEH;;;;;GAKG;AAEH;;;;;;;;;;;;;;;;GAgBG;AAEH;;;;;;;;;;GAUG;AACH,uBARsE,CAAC,SAA1D,OAAQ,oCAAoC,EAAE,SAAU,EAC3B,CAAC,SAA7B,iBAAiB,CAAC,OAAQ,gDAE7B,OAAO,oCAAoC,EAAE,eAAe,CAAC,CAAC,CAAC,YAC/D,OAAO,oCAAoC,EAAE,gBAAgB,CAAC,CAAC,CAAC,kBAChE,aAAa,CAAC,CAAC,CAAC,GACd,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CAuB9B;AAED;;;;;;GAMG;AACH,8BAWC;mCAxFkC,sBAAsB"}
+{"version":3,"file":"pure.d.ts","sourceRoot":"","sources":["../src/pure.js"],"names":[],"mappings":";;;;;mCAOsE,CAAC,SAA1D,OAAQ,oCAAoC,EAAE,SAAU,IACxD,OAAO,oCAAoC,EAAE,gBAAgB,CAAC,CAAC,CAAC;;;;0BAMnC,CAAC,SAA7B,iBAAiB,CAAC,OAAQ,qCAC+B,CAAC,SAA3D,OAAQ,oCAAoC,EAAE,SAAU,YACxD,OAAO,oCAAoC,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG;IAAE,OAAO,CAAC,EAAE,CAAC,CAAA;CAAE;;;;yBAMrB,CAAC,SAA1D,OAAQ,oCAAoC,EAAE,SAAU,EAC3B,CAAC,SAA7B,iBAAiB,CAAC,OAAQ,qCAC+B,CAAC,SAA3D,OAAQ,oCAAoC,EAAE,SAAU,YAExD;IACR,SAAS,EAAE,WAAW,CAAA;IACtB,WAAW,EAAE,WAAW,CAAA;IACxB,SAAS,EAAE,OAAO,oCAAoC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;IAClE,OAAO,EAAE,OAAO,oCAAoC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;IAChE,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,WAAW,GAAG,gBAAgB,KAAK,IAAI,CAAA;IACpD,QAAQ,EAAE,OAAO,oCAAoC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAA;IAClE,OAAO,EAAE,MAAM,IAAI,CAAA;CACpB,GAAG,GACD,CAAC,IAAI,MAAM,CAAC,GAAG,iBAAiB,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACtD;2BA8ES,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,iBAAiB,CAAC,YAAY,CAAC,KAAK,OAAO,CAAC,UAAU,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;yBAI5G,GACP,CAAC,IAAI,iBAAiB,CAAC,SAAS,GAAG,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,UAAU,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,GACnJ;AAvBJ;;;;;;GAMG;AACH,oBAJa,CAAC,OACH,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,GAClB,OAAO,CAAC,CAAC,CAAC,CAStB;AAnBD,+FAA+F;AAC/F,gCAEC;AAkBD;;GAEG;AAEH;;;;GAIG;AAEH;;;;;;;GAOG;AACH,wBAFU,YAAY,GAAG,UAAU,CAIlC;AAjID;;;;;GAKG;AAEH;;;;;;GAMG;AAEH;;;;;;;;;;;;;;;;;;GAkBG;AAEH;;;;;;;;;;;GAWG;AACH,uBATsE,CAAC,SAA1D,OAAQ,oCAAoC,EAAE,SAAU,EAC3B,CAAC,SAA7B,iBAAiB,CAAC,OAAQ,qCAC+B,CAAC,SAA3D,OAAQ,oCAAoC,EAAE,SAAU,qBAE1D,OAAO,oCAAoC,EAAE,eAAe,CAAC,CAAC,CAAC,YAC/D,OAAO,oCAAoC,EAAE,gBAAgB,CAAC,CAAC,CAAC,kBAChE,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,GACjB,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAqBjC;AAED;;;;;;GAMG;AACH,8BAWC;mCA1FkC,sBAAsB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testing-library/svelte",
-  "version": "5.3.1",
+  "version": "5.4.0",
   "description": "Simple and complete Svelte testing utilities that encourage good testing practices.",
   "main": "src/index.js",
   "exports": {
@@ -71,7 +71,7 @@
   },
   "dependencies": {
     "@testing-library/dom": "9.x.x || 10.x.x",
-    "@testing-library/svelte-core": "1.0.0"
+    "@testing-library/svelte-core": "1.1.0"
   },
   "publishConfig": {
     "access": "public",

package/src/pure.js

@@ -13,7 +13,8 @@ import * as Svelte from 'svelte'
  * Customize how Testing Library sets up the document and binds queries.
  *
  * @template {DomTestingLibrary.Queries} [Q=typeof DomTestingLibrary.queries]
- * @typedef {import('@testing-library/svelte-core/types').SetupOptions & { queries?: Q }} RenderOptions
+ * @template {import('@testing-library/svelte-core/types').Component} [W=never]
+ * @typedef {import('@testing-library/svelte-core/types').SetupOptions<W> & { queries?: Q }} RenderOptions
  */
 
 /**
@@ -21,11 +22,13 @@ import * as Svelte from 'svelte'
  *
  * @template {import('@testing-library/svelte-core/types').Component} C
  * @template {DomTestingLibrary.Queries} [Q=typeof DomTestingLibrary.queries]
+ * @template {import('@testing-library/svelte-core/types').Component} [W=never]
  *
  * @typedef {{
  *   container: HTMLElement
  *   baseElement: HTMLElement
  *   component: import('@testing-library/svelte-core/types').Exports<C>
+ *   wrapper: import('@testing-library/svelte-core/types').Exports<W>
  *   debug: (el?: HTMLElement | DocumentFragment) => void
  *   rerender: import('@testing-library/svelte-core/types').Rerender<C>
  *   unmount: () => void
@@ -39,18 +42,16 @@ import * as Svelte from 'svelte'
  *
  * @template {import('@testing-library/svelte-core/types').Component} C
  * @template {DomTestingLibrary.Queries} [Q=typeof DomTestingLibrary.queries]
+ * @template {import('@testing-library/svelte-core/types').Component} [W=never]
  *
  * @param {import('@testing-library/svelte-core/types').ComponentImport<C>} Component - The component to render.
  * @param {import('@testing-library/svelte-core/types').ComponentOptions<C>} options - Customize how Svelte renders the component.
- * @param {RenderOptions<Q>} renderOptions - Customize how Testing Library sets up the document and binds queries.
- * @returns {RenderResult<C, Q>} The rendered component and bound testing functions.
+ * @param {RenderOptions<Q, W>} renderOptions - Customize how Testing Library sets up the document and binds queries.
+ * @returns {RenderResult<C, Q, W>} The rendered component and bound testing functions.
  */
 const render = (Component, options = {}, renderOptions = {}) => {
-  const { baseElement, container, component, unmount, rerender } = Core.render(
-    Component,
-    options,
-    renderOptions
-  )
+  const { baseElement, container, component, wrapper, unmount, rerender } =
+    Core.render(Component, options, renderOptions)
 
   const queries = DomTestingLibrary.getQueriesForElement(
     baseElement,
@@ -61,6 +62,7 @@ const render = (Component, options = {}, renderOptions = {}) => {
     baseElement,
     container,
     component,
+    wrapper,
     rerender,
     unmount,
     debug: (el = baseElement) => console.log(DomTestingLibrary.prettyDOM(el)),

package/src/vitest.js

@@ -1,11 +1,12 @@
 import { act, cleanup, setup } from '@testing-library/svelte'
 import { beforeEach } from 'vitest'
 
+const afterEach = async () => {
+  await act()
+  cleanup()
+}
+
 beforeEach(() => {
   setup()
-
-  return async () => {
-    await act()
-    cleanup()
-  }
+  return afterEach
 })