@testing-library/svelte 5.2.7 → 5.2.9

package/README.md

@@ -12,9 +12,10 @@
 
 <p>Simple and complete Svelte testing utilities that encourage good testing practices.</p>
 
-[**Read The Docs**][stl-docs] | [Edit the docs][stl-docs-repo]
+[**Read The Docs**][stl-docs] | [Edit the docs][stl-docs-repo] | [Examples](./examples)
 
 <!-- prettier-ignore-start -->
+
 [![Build Status][build-badge]][build]
 [![Code Coverage][coverage-badge]][coverage]
 [![version][version-badge]][package]
@@ -29,7 +30,9 @@
 [![Watch on GitHub][github-watch-badge]][github-watch]
 [![Star on GitHub][github-star-badge]][github-star]
 [![Tweet][twitter-badge]][twitter]
+
 <!-- prettier-ignore-end -->
+
 </div>
 
 <hr />
@@ -63,13 +66,11 @@
 
 ## Table of Contents
 
-<!-- START doctoc generated TOC please keep comment here to allow auto update -->
-<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-
 - [The Problem](#the-problem)
 - [This Solution](#this-solution)
 - [Installation](#installation)
 - [Setup](#setup)
+  - [Auto-cleanup](#auto-cleanup)
 - [Docs](#docs)
 - [Issues](#issues)
   - [🐛 Bugs](#-bugs)
@@ -77,8 +78,6 @@
   - [❓ Questions](#-questions)
 - [Contributors](#contributors)
 
-<!-- END doctoc generated TOC please keep comment here to allow auto update -->
-
 ## The Problem
 
 You want to write maintainable tests for your [Svelte][svelte] components.
@@ -140,6 +139,39 @@ test runners like Jest.
 [vitest]: https://vitest.dev/
 [setup docs]: https://testing-library.com/docs/svelte-testing-library/setup
 
+### Auto-cleanup
+
+In Vitest (via the `svelteTesting` plugin) and Jest (via the `beforeEach` and `afterEach` globals),
+this library will automatically setup and cleanup the test environment before and after each test.
+
+To do your own cleanup, or if you're using another framework, call the `setup` and `cleanup` functions yourself:
+
+```js
+import { cleanup, render, setup } from '@testing-library/svelte'
+
+// before
+setup()
+
+// test
+render(/* ... */)
+
+// after
+cleanup()
+```
+
+To disable auto-cleanup in Vitest, set the `autoCleanup` option of the plugin to false:
+
+```js
+svelteTesting({ autoCleanup: false })
+```
+
+To disable auto-cleanup in Jest and other frameworks with global test hooks,
+set the `STL_SKIP_AUTO_CLEANUP` environment variable:
+
+```shell
+STL_SKIP_AUTO_CLEANUP=1 jest
+```
+
 ## Docs
 
 See the [**docs**][stl-docs] over at the Testing Library website.
@@ -183,8 +215,11 @@ instead of filing an issue on GitHub.
 Thanks goes to these people ([emoji key][emojis]):
 
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+
 <!-- prettier-ignore-start -->
+
 <!-- markdownlint-disable -->
+
 <table>
   <tbody>
     <tr>
@@ -212,6 +247,7 @@ Thanks goes to these people ([emoji key][emojis]):
 </table>
 
 <!-- markdownlint-restore -->
+
 <!-- prettier-ignore-end -->
 
 <!-- ALL-CONTRIBUTORS-LIST:END -->

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testing-library/svelte",
-  "version": "5.2.7",
+  "version": "5.2.9",
   "description": "Simple and complete Svelte testing utilities that encourage good testing practices.",
   "main": "src/index.js",
   "exports": {
@@ -49,29 +49,23 @@
   ],
   "files": [
     "src",
-    "types",
-    "!__tests__"
+    "types"
   ],
   "scripts": {
-    "all": "npm-run-all contributors:generate toc format types build test:vitest:* test:jest",
-    "toc": "doctoc README.md",
+    "all": "npm-run-all contributors:generate docs format types build test:vitest:* test:jest test:examples",
+    "all:legacy": "npm-run-all types:legacy test:vitest:* test:jest",
+    "docs": "remark --output --use remark-toc --use remark-code-import --use unified-prettier README.md examples",
     "lint": "prettier . --check && eslint .",
-    "lint:delta": "npm-run-all -p prettier:delta eslint:delta",
-    "prettier:delta": "prettier --check `./scripts/changed-files`",
-    "eslint:delta": "eslint `./scripts/changed-files`",
     "format": "prettier . --write && eslint . --fix",
-    "format:delta": "npm-run-all format:prettier:delta format:eslint:delta",
-    "format:prettier:delta": "prettier --write `./scripts/changed-files`",
-    "format:eslint:delta": "eslint --fix `./scripts/changed-files`",
-    "setup": "npm install && npm run all",
+    "setup": "npm run install:5 && npm run all",
     "test": "vitest run --coverage",
     "test:watch": "vitest",
-    "test:vitest:jsdom": "vitest run --coverage --environment jsdom",
-    "test:vitest:happy-dom": "vitest run --coverage --environment happy-dom",
+    "test:vitest:jsdom": "vitest run tests --coverage --environment jsdom",
+    "test:vitest:happy-dom": "vitest run tests --coverage --environment happy-dom",
     "test:jest": "npx --node-options=\"--experimental-vm-modules --no-warnings\" jest --coverage",
+    "test:examples": "vitest run examples --coverage",
     "types": "svelte-check",
     "types:legacy": "svelte-check --tsconfig tsconfig.legacy.json",
-    "validate": "npm-run-all test:vitest:* test:jest types build",
     "build": "tsc -p tsconfig.build.json && cp src/component-types.d.ts types",
     "contributors:add": "all-contributors add",
     "contributors:generate": "all-contributors generate",
@@ -94,40 +88,45 @@
     }
   },
   "dependencies": {
-    "@testing-library/dom": "^10.0.0"
+    "@testing-library/dom": "9.x.x || 10.x.x"
   },
   "devDependencies": {
+    "@eslint/js": "^9.26.0",
     "@jest/globals": "^29.7.0",
-    "@sveltejs/vite-plugin-svelte": "^2.0.0 || ^3.0.0 || ^4.0.0",
-    "@testing-library/jest-dom": "^6.3.0",
-    "@testing-library/user-event": "^14.5.2",
-    "@typescript-eslint/eslint-plugin": "^8.0.0",
-    "@typescript-eslint/parser": "^8.0.0",
-    "@vitest/coverage-v8": "0.x.x || ^1.0.0 || ^2.0.2",
+    "@sveltejs/vite-plugin-svelte": "^5.0.3",
+    "@testing-library/jest-dom": "^6.6.3",
+    "@testing-library/user-event": "^14.6.1",
+    "@vitest/coverage-v8": "^3.1.3",
+    "@vitest/eslint-plugin": "^1.1.44",
     "all-contributors-cli": "^6.26.1",
-    "doctoc": "^2.2.1",
-    "esbuild": "*",
-    "eslint": "^8.57.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-config-standard": "^17.1.0",
-    "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-n": "^16.6.2",
-    "eslint-plugin-promise": "^6.4.0",
+    "eslint": "^9.26.0",
+    "eslint-config-prettier": "^10.1.5",
+    "eslint-plugin-jest-dom": "^5.5.0",
+    "eslint-plugin-promise": "^7.2.1",
     "eslint-plugin-simple-import-sort": "^12.1.1",
-    "eslint-plugin-svelte": "^2.42.0",
-    "expect-type": "^1.1.0",
-    "happy-dom": "^16.3.0",
+    "eslint-plugin-svelte": "^3.5.1",
+    "eslint-plugin-testing-library": "^7.1.1",
+    "eslint-plugin-unicorn": "^59.0.1",
+    "expect-type": "^1.2.1",
+    "globals": "^16.1.0",
+    "happy-dom": "^17.4.6",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
-    "jsdom": "^25.0.0",
+    "jsdom": "^26.1.0",
     "npm-run-all": "^4.1.5",
-    "prettier": "^3.3.3",
-    "prettier-plugin-svelte": "^3.2.5",
-    "svelte": "^3 || ^4 || ^5 || ^5.0.0-next.0",
-    "svelte-check": "^3.0.0 || ^4.0.4",
+    "prettier": "^3.5.3",
+    "prettier-plugin-svelte": "^3.3.3",
+    "remark-cli": "^12.0.1",
+    "remark-code-import": "^1.2.0",
+    "remark-toc": "^9.0.0",
+    "svelte": "^5.28.2",
+    "svelte-check": "^4.1.7",
     "svelte-jester": "^5.0.0",
-    "typescript": "^5.5.3",
-    "vite": "^4.0.0 || ^5.3.3",
-    "vitest": "0.x.x || ^1.0.0 || ^2.0.2"
+    "typescript": "^5.8.3",
+    "typescript-eslint": "^8.32.0",
+    "typescript-svelte-plugin": "^0.3.46",
+    "unified-prettier": "^2.0.1",
+    "vite": "^6.3.5",
+    "vitest": "^3.1.3"
   }
 }

package/src/component-types.d.ts

@@ -1,4 +1,4 @@
-/* eslint-disable @typescript-eslint/no-explicit-any, @typescript-eslint/no-redundant-type-constituents */
+/* eslint-disable @typescript-eslint/no-explicit-any, @typescript-eslint/no-deprecated */
 import type {
   Component as ModernComponent,
   ComponentConstructorOptions as LegacyConstructorOptions,

package/src/core/cleanup.js

@@ -0,0 +1,32 @@
+/** @type {Set<() => void>} */
+const cleanupTasks = new Set()
+
+/**
+ * Register later cleanup task
+ *
+ * @param {() => void} onCleanup
+ */
+const addCleanupTask = (onCleanup) => {
+  cleanupTasks.add(onCleanup)
+  return onCleanup
+}
+
+/**
+ * Remove a cleanup task without running it.
+ *
+ * @param {() => void} onCleanup
+ */
+const removeCleanupTask = (onCleanup) => {
+  cleanupTasks.delete(onCleanup)
+}
+
+/** Clean up all components and elements added to the document. */
+const cleanup = () => {
+  for (const handleCleanup of cleanupTasks.values()) {
+    handleCleanup()
+  }
+
+  cleanupTasks.clear()
+}
+
+export { addCleanupTask, cleanup, removeCleanupTask }

package/src/core/index.js

@@ -5,23 +5,9 @@
  * Will switch to legacy, class-based mounting logic
  * if it looks like we're in a Svelte <= 4 environment.
  */
-import * as LegacyCore from './legacy.js'
-import * as ModernCore from './modern.svelte.js'
-import {
-  createValidateOptions,
-  UnknownSvelteOptionsError,
-} from './validate-options.js'
-
-const { mount, unmount, updateProps, allowedOptions } =
-  ModernCore.IS_MODERN_SVELTE ? ModernCore : LegacyCore
-
-/** Validate component options. */
-const validateOptions = createValidateOptions(allowedOptions)
-
+export { addCleanupTask, cleanup } from './cleanup.js'
+export { mount } from './mount.js'
 export {
-  mount,
   UnknownSvelteOptionsError,
-  unmount,
-  updateProps,
   validateOptions,
-}
+} from './validate-options.js'

package/src/core/mount.js

@@ -0,0 +1,95 @@
+/**
+ * Component rendering core, with support for Svelte 3, 4, and 5
+ */
+import * as Svelte from 'svelte'
+
+import { addCleanupTask, removeCleanupTask } from './cleanup.js'
+import { createProps } from './props.svelte.js'
+
+/** Whether we're using Svelte >= 5. */
+const IS_MODERN_SVELTE = typeof Svelte.mount === 'function'
+
+/** Allowed options to the `mount` call or legacy component constructor. */
+const ALLOWED_MOUNT_OPTIONS = IS_MODERN_SVELTE
+  ? ['target', 'anchor', 'props', 'events', 'context', 'intro']
+  : ['target', 'accessors', 'anchor', 'props', 'hydrate', 'intro', 'context']
+
+/** Mount a modern Svelte 5 component into the DOM. */
+const mountModern = (Component, options) => {
+  const [props, updateProps] = createProps(options.props)
+  const component = Svelte.mount(Component, { ...options, props })
+
+  /** Remove the component from the DOM. */
+  const unmount = () => {
+    Svelte.flushSync(() => Svelte.unmount(component))
+    removeCleanupTask(unmount)
+  }
+
+  /** Update the component's props. */
+  const rerender = (nextProps) => {
+    Svelte.flushSync(() => updateProps(nextProps))
+  }
+
+  addCleanupTask(unmount)
+  Svelte.flushSync()
+
+  return { component, unmount, rerender }
+}
+
+/** Mount a legacy Svelte 3 or 4 component into the DOM. */
+const mountLegacy = (Component, options) => {
+  const component = new Component(options)
+
+  /** Remove the component from the DOM. */
+  const unmount = () => {
+    component.$destroy()
+    removeCleanupTask(unmount)
+  }
+
+  /** Update the component's props. */
+  const rerender = (nextProps) => {
+    component.$set(nextProps)
+  }
+
+  // This `$$.on_destroy` listener is included for strict backwards compatibility
+  // with previous versions of `@testing-library/svelte`.
+  // It's unnecessary and will be removed in a future major version.
+  component.$$.on_destroy.push(() => {
+    removeCleanupTask(unmount)
+  })
+
+  addCleanupTask(unmount)
+
+  return { component, unmount, rerender }
+}
+
+/** The mount method in use. */
+const mountComponent = IS_MODERN_SVELTE ? mountModern : mountLegacy
+
+/**
+ * Render a Svelte component into the document.
+ *
+ * @template {import('./types.js').Component} C
+ * @param {import('./types.js').ComponentType<C>} Component
+ * @param {import('./types.js').MountOptions<C>} options
+ * @returns {{
+ *   component: C
+ *   unmount: () => void
+ *   rerender: (props: Partial<import('./types.js').Props<C>>) => Promise<void>
+ * }}
+ */
+const mount = (Component, options = {}) => {
+  const { component, unmount, rerender } = mountComponent(Component, options)
+
+  return {
+    component,
+    unmount,
+    rerender: async (props) => {
+      rerender(props)
+      // Await the next tick for Svelte 4, which cannot flush changes synchronously
+      await Svelte.tick()
+    },
+  }
+}
+
+export { ALLOWED_MOUNT_OPTIONS, mount }

package/src/core/props.svelte.js

@@ -0,0 +1,38 @@
+/**
+ * Create a shallowly reactive props object.
+ *
+ * This allows us to update props on `rerender`
+ * without turing `props` into a deep set of Proxy objects
+ *
+ * @template {Record<string, unknown>} Props
+ * @param {Props} initialProps
+ * @returns {[Props, (nextProps: Partial<Props>) => void]}
+ */
+const createProps = (initialProps) => {
+  const targetProps = initialProps ?? {}
+  let currentProps = $state.raw(targetProps)
+
+  const props = new Proxy(targetProps, {
+    get(_, key) {
+      return currentProps[key]
+    },
+    set(_, key, value) {
+      currentProps[key] = value
+      return true
+    },
+    has(_, key) {
+      return Reflect.has(currentProps, key)
+    },
+    ownKeys() {
+      return Reflect.ownKeys(currentProps)
+    },
+  })
+
+  const update = (nextProps) => {
+    currentProps = { ...currentProps, ...nextProps }
+  }
+
+  return [props, update]
+}
+
+export { createProps }

package/src/core/validate-options.js

@@ -1,3 +1,5 @@
+import { ALLOWED_MOUNT_OPTIONS } from './mount.js'
+
 class UnknownSvelteOptionsError extends TypeError {
   constructor(unknownOptions, allowedOptions) {
     super(`Unknown options.
@@ -15,9 +17,9 @@ class UnknownSvelteOptionsError extends TypeError {
   }
 }
 
-const createValidateOptions = (allowedOptions) => (options) => {
+const validateOptions = (options) => {
   const isProps = !Object.keys(options).some((option) =>
-    allowedOptions.includes(option)
+    ALLOWED_MOUNT_OPTIONS.includes(option)
   )
 
   if (isProps) {
@@ -26,14 +28,14 @@ const createValidateOptions = (allowedOptions) => (options) => {
 
   // Check if any props and Svelte options were accidentally mixed.
   const unknownOptions = Object.keys(options).filter(
-    (option) => !allowedOptions.includes(option)
+    (option) => !ALLOWED_MOUNT_OPTIONS.includes(option)
   )
 
   if (unknownOptions.length > 0) {
-    throw new UnknownSvelteOptionsError(unknownOptions, allowedOptions)
+    throw new UnknownSvelteOptionsError(unknownOptions, ALLOWED_MOUNT_OPTIONS)
   }
 
   return options
 }
 
-export { createValidateOptions, UnknownSvelteOptionsError }
+export { UnknownSvelteOptionsError, validateOptions }

package/src/index.js

@@ -1,15 +1,22 @@
-/* eslint-disable import/export */
-import { act, cleanup } from './pure.js'
+import { act, cleanup, setup } from './pure.js'
 
-// If we're running in a test runner that supports afterEach
-// then we'll automatically run cleanup afterEach test
+// If we're running in a test runner that supports beforeEach/afterEach
+// we'll automatically run setup and cleanup before and after each test
 // this ensures that tests run in isolation from each other
 // if you don't like this then set the STL_SKIP_AUTO_CLEANUP env variable.
-if (typeof afterEach === 'function' && !process.env.STL_SKIP_AUTO_CLEANUP) {
-  afterEach(async () => {
-    await act()
-    cleanup()
-  })
+if (typeof process !== 'undefined' && !process.env.STL_SKIP_AUTO_CLEANUP) {
+  if (typeof beforeEach === 'function') {
+    beforeEach(() => {
+      setup()
+    })
+  }
+
+  if (typeof afterEach === 'function') {
+    afterEach(async () => {
+      await act()
+      cleanup()
+    })
+  }
 }
 
 // export all base queries, screen, etc.

package/src/pure.js

@@ -1,14 +1,13 @@
 import {
+  configure as configureDTL,
   fireEvent as baseFireEvent,
+  getConfig as getDTLConfig,
   getQueriesForElement,
   prettyDOM,
 } from '@testing-library/dom'
-import { tick } from 'svelte'
+import * as Svelte from 'svelte'
 
-import { mount, unmount, updateProps, validateOptions } from './core/index.js'
-
-const targetCache = new Set()
-const componentCache = new Set()
+import { addCleanupTask, mount, validateOptions } from './core/index.js'
 
 /**
  * Customize how Svelte renders the component.
@@ -65,18 +64,20 @@ const render = (Component, options = {}, renderOptions = {}) => {
   const queries = getQueriesForElement(baseElement, renderOptions.queries)
 
   const target =
+    // eslint-disable-next-line unicorn/prefer-dom-node-append
     options.target ?? baseElement.appendChild(document.createElement('div'))
 
-  targetCache.add(target)
+  addCleanupTask(() => {
+    if (target.parentNode === document.body) {
+      target.remove()
+    }
+  })
 
-  const component = mount(
+  const { component, unmount, rerender } = mount(
     Component.default ?? Component,
-    { ...options, target },
-    cleanupComponent
+    { ...options, target }
   )
 
-  componentCache.add(component)
-
   return {
     baseElement,
     component,
@@ -92,51 +93,47 @@ const render = (Component, options = {}, renderOptions = {}) => {
         props = props.props
       }
 
-      updateProps(component, props)
-      await tick()
-    },
-    unmount: () => {
-      cleanupComponent(component)
+      await rerender(props)
     },
+    unmount,
     ...queries,
   }
 }
 
-/** Remove a component from the component cache. */
-const cleanupComponent = (component) => {
-  const inCache = componentCache.delete(component)
-
-  if (inCache) {
-    unmount(component)
-  }
-}
-
-/** Remove a target element from the target cache. */
-const cleanupTarget = (target) => {
-  const inCache = targetCache.delete(target)
+/**
+ * Configure `@testing-library/dom` for usage with Svelte.
+ *
+ * Ensures events fired from `@testing-library/dom`
+ * and `@testing-library/user-event` wait for Svelte
+ * to flush changes to the DOM before proceeding.
+ */
+const setup = () => {
+  const originalDTLConfig = getDTLConfig()
 
-  if (inCache && target.parentNode === document.body) {
-    document.body.removeChild(target)
-  }
-}
+  configureDTL({
+    asyncWrapper: act,
+    eventWrapper: Svelte.flushSync ?? ((cb) => cb()),
+  })
 
-/** Unmount all components and remove elements added to `<body>`. */
-const cleanup = () => {
-  componentCache.forEach(cleanupComponent)
-  targetCache.forEach(cleanupTarget)
+  addCleanupTask(() => {
+    configureDTL(originalDTLConfig)
+  })
 }
 
 /**
  * Call a function and wait for Svelte to flush pending changes.
  *
- * @param {() => unknown} [fn] - A function, which may be `async`, to call before flushing updates.
- * @returns {Promise<void>}
+ * @template T
+ * @param {(() => Promise<T>) | () => T} [fn] - A function, which may be `async`, to call before flushing updates.
+ * @returns {Promise<T>}
  */
 const act = async (fn) => {
+  let result
   if (fn) {
-    await fn()
+    result = await fn()
   }
-  return tick()
+  await Svelte.tick()
+  return result
 }
 
 /**
@@ -157,18 +154,11 @@ const act = async (fn) => {
  *
  * @type {FireFunction & FireObject}
  */
-const fireEvent = async (...args) => {
-  const event = baseFireEvent(...args)
-  await tick()
-  return event
-}
+const fireEvent = async (...args) => act(() => baseFireEvent(...args))
 
-Object.keys(baseFireEvent).forEach((key) => {
-  fireEvent[key] = async (...args) => {
-    const event = baseFireEvent[key](...args)
-    await tick()
-    return event
-  }
-})
+for (const [key, baseEvent] of Object.entries(baseFireEvent)) {
+  fireEvent[key] = async (...args) => act(() => baseEvent(...args))
+}
 
-export { act, cleanup, fireEvent, render }
+export { cleanup } from './core/index.js'
+export { act, fireEvent, render, setup }

package/src/vite.js

@@ -1,5 +1,5 @@
-import { dirname, join } from 'node:path'
-import { fileURLToPath } from 'node:url'
+import path from 'node:path'
+import url from 'node:url'
 
 /**
  * Vite plugin to configure @testing-library/svelte.
@@ -50,8 +50,8 @@ const addBrowserCondition = (config) => {
   const browserConditionIndex = conditions.indexOf('browser')
 
   if (
-    nodeConditionIndex >= 0 &&
-    (nodeConditionIndex < browserConditionIndex || browserConditionIndex < 0)
+    nodeConditionIndex !== -1 &&
+    (nodeConditionIndex < browserConditionIndex || browserConditionIndex === -1)
   ) {
     conditions.splice(nodeConditionIndex, 0, 'browser')
   }
@@ -77,7 +77,9 @@ const addAutoCleanup = (config) => {
     setupFiles = [setupFiles]
   }
 
-  setupFiles.push(join(dirname(fileURLToPath(import.meta.url)), './vitest.js'))
+  setupFiles.push(
+    path.join(path.dirname(url.fileURLToPath(import.meta.url)), './vitest.js')
+  )
 
   test.setupFiles = setupFiles
   config.test = test

package/src/vitest.js

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

package/types/component-types.d.ts

@@ -1,4 +1,4 @@
-/* eslint-disable @typescript-eslint/no-explicit-any, @typescript-eslint/no-redundant-type-constituents */
+/* eslint-disable @typescript-eslint/no-explicit-any, @typescript-eslint/no-deprecated */
 import type {
   Component as ModernComponent,
   ComponentConstructorOptions as LegacyConstructorOptions,

package/types/core/cleanup.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Register later cleanup task
+ *
+ * @param {() => void} onCleanup
+ */
+export function addCleanupTask(onCleanup: () => void): () => void;
+/** Clean up all components and elements added to the document. */
+export function cleanup(): void;
+/**
+ * Remove a cleanup task without running it.
+ *
+ * @param {() => void} onCleanup
+ */
+export function removeCleanupTask(onCleanup: () => void): void;
+//# sourceMappingURL=cleanup.d.ts.map

package/types/core/cleanup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cleanup.d.ts","sourceRoot":"","sources":["../../src/core/cleanup.js"],"names":[],"mappings":"AAGA;;;;GAIG;AACH,0CAFW,MAAM,IAAI,SAAJ,IAAI,CAKpB;AAWD,kEAAkE;AAClE,gCAMC;AAhBD;;;;GAIG;AACH,6CAFW,MAAM,IAAI,QAIpB"}

package/types/core/index.d.ts

@@ -1,8 +1,4 @@
-export const mount: (Component: any, options: any, onDestroy: any) => any;
-import { UnknownSvelteOptionsError } from './validate-options.js';
-export const unmount: (component: any) => void;
-export const updateProps: (component: any, nextProps: any) => void;
-/** Validate component options. */
-export const validateOptions: (options: any) => any;
-export { UnknownSvelteOptionsError };
+export { mount } from "./mount.js";
+export { addCleanupTask, cleanup } from "./cleanup.js";
+export { UnknownSvelteOptionsError, validateOptions } from "./validate-options.js";
 //# sourceMappingURL=index.d.ts.map

package/types/core/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/core/index.js"],"names":[],"mappings":";0CAYO,uBAAuB;;;AAK9B,kCAAkC;AAClC,oDAA6D"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/core/index.js"],"names":[],"mappings":""}

package/types/core/mount.d.ts

@@ -0,0 +1,20 @@
+/** Allowed options to the `mount` call or legacy component constructor. */
+export const ALLOWED_MOUNT_OPTIONS: string[];
+/**
+ * Render a Svelte component into the document.
+ *
+ * @template {import('./types.js').Component} C
+ * @param {import('./types.js').ComponentType<C>} Component
+ * @param {import('./types.js').MountOptions<C>} options
+ * @returns {{
+ *   component: C
+ *   unmount: () => void
+ *   rerender: (props: Partial<import('./types.js').Props<C>>) => Promise<void>
+ * }}
+ */
+export function mount<C extends any>(Component: any, options?: any): {
+    component: C;
+    unmount: () => void;
+    rerender: (props: Partial<any>) => Promise<void>;
+};
+//# sourceMappingURL=mount.d.ts.map

package/types/core/mount.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mount.d.ts","sourceRoot":"","sources":["../../src/core/mount.js"],"names":[],"mappings":"AAWA,2EAA2E;AAC3E,6CAE6E;AAsD7E;;;;;;;;;;;GAWG;AACH,sBAT8C,CAAC,SAAlC,GAAgC,kCAGhC;IACR,SAAS,EAAE,CAAC,CAAA;IACZ,OAAO,EAAE,MAAM,IAAI,CAAA;IACnB,QAAQ,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,GAA6B,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;CAC3E,CAcH"}

package/types/core/props.svelte.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Create a shallowly reactive props object.
+ *
+ * This allows us to update props on `rerender`
+ * without turing `props` into a deep set of Proxy objects
+ *
+ * @template {Record<string, unknown>} Props
+ * @param {Props} initialProps
+ * @returns {[Props, (nextProps: Partial<Props>) => void]}
+ */
+export function createProps<Props extends Record<string, unknown>>(initialProps: Props): [Props, (nextProps: Partial<Props>) => void];
+//# sourceMappingURL=props.svelte.d.ts.map

package/types/core/props.svelte.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"props.svelte.d.ts","sourceRoot":"","sources":["../../src/core/props.svelte.js"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,4BAJuC,KAAK,SAA9B,MAAM,CAAC,MAAM,EAAE,OAAO,CAAE,gBAC3B,KAAK,GACH,CAAC,KAAK,EAAE,CAAC,SAAS,EAAE,OAAO,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,CA2BxD"}

package/types/core/validate-options.d.ts

@@ -1,5 +1,5 @@
-export function createValidateOptions(allowedOptions: any): (options: any) => any;
 export class UnknownSvelteOptionsError extends TypeError {
     constructor(unknownOptions: any, allowedOptions: any);
 }
+export function validateOptions(options: any): any;
 //# sourceMappingURL=validate-options.d.ts.map

package/types/core/validate-options.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validate-options.d.ts","sourceRoot":"","sources":["../../src/core/validate-options.js"],"names":[],"mappings":"AAiBA,kFAmBC;AApCD;IACE,sDAaC;CACF"}
+{"version":3,"file":"validate-options.d.ts","sourceRoot":"","sources":["../../src/core/validate-options.js"],"names":[],"mappings":"AAEA;IACE,sDAaC;CACF;AAED,mDAmBC"}

package/types/pure.d.ts

@@ -1,3 +1,4 @@
+export { cleanup } from "./core/index.js";
 /**
  * Customize how Svelte renders the component.
  */
@@ -25,12 +26,11 @@ export type FireObject = { [K in import("@testing-library/dom").EventType]: (...
 /**
  * Call a function and wait for Svelte to flush pending changes.
  *
- * @param {() => unknown} [fn] - A function, which may be `async`, to call before flushing updates.
- * @returns {Promise<void>}
+ * @template T
+ * @param {(() => Promise<T>) | () => T} [fn] - A function, which may be `async`, to call before flushing updates.
+ * @returns {Promise<T>}
  */
-export function act(fn?: () => unknown): Promise<void>;
-/** Unmount all components and remove elements added to `<body>`. */
-export function cleanup(): void;
+export function act<T>(fn?: (() => Promise<T>) | (() => T)): Promise<T>;
 /**
  * @typedef {(...args: Parameters<import('@testing-library/dom').FireFunction>) => Promise<ReturnType<import('@testing-library/dom').FireFunction>>} FireFunction
  */
@@ -92,4 +92,12 @@ export const fireEvent: FireFunction & FireObject;
  * @returns {RenderResult<C, Q>} The rendered component and bound testing functions.
  */
 export function render<C extends import("./component-types.js").Component, Q extends import("@testing-library/dom").Queries = typeof import("@testing-library/dom/types/queries.js")>(Component: import("./component-types.js").ComponentType<C>, options?: SvelteComponentOptions<C>, renderOptions?: RenderOptions<Q>): RenderResult<C, Q>;
+/**
+ * Configure `@testing-library/dom` for usage with Svelte.
+ *
+ * Ensures events fired from `@testing-library/dom`
+ * and `@testing-library/user-event` wait for Svelte
+ * to flush changes to the DOM before proceeding.
+ */
+export function setup(): void;
 //# sourceMappingURL=pure.d.ts.map

package/types/pure.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pure.d.ts","sourceRoot":"","sources":["../src/pure.js"],"names":[],"mappings":";;;mCAewD,CAAC,SAA5C,OAAQ,sBAAsB,EAAE,SAAU,IAC1C,OAAO,sBAAsB,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,OAAO,sBAAsB,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;;;;0BAMvD,CAAC,SAA3C,OAAQ,sBAAsB,EAAE,OAAQ,6DACxC;IACR,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,OAAO,CAAC,EAAE,CAAC,CAAA;CACZ;;;;yBAMoD,CAAC,SAA5C,OAAQ,sBAAsB,EAAE,SAAU,EACA,CAAC,SAA3C,OAAQ,sBAAsB,EAAE,OAAQ,6DAExC;IACR,SAAS,EAAE,WAAW,CAAA;IACtB,WAAW,EAAE,WAAW,CAAA;IACxB,SAAS,EAAE,OAAO,sBAAsB,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;IACpD,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,WAAW,GAAG,gBAAgB,KAAK,IAAI,CAAA;IACpD,QAAQ,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,OAAO,sBAAsB,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACpF,OAAO,EAAE,MAAM,IAAI,CAAA;CACpB,GAAG,GACD,CAAC,IAAI,MAAM,CAAC,GAAG,OAAO,sBAAsB,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACnE;2BAkGS,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,OAAO,sBAAsB,EAAE,YAAY,CAAC,KAAK,OAAO,CAAC,UAAU,CAAC,OAAO,sBAAsB,EAAE,YAAY,CAAC,CAAC;yBAItI,GACP,CAAC,IAAI,OAAO,sBAAsB,EAAE,SAAS,GAAG,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,OAAO,sBAAsB,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,UAAU,CAAC,OAAO,sBAAsB,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,GAC1L;AApBJ;;;;;GAKG;AACH,yBAHW,MAAM,OAAO,GACX,OAAO,CAAC,IAAI,CAAC,CAOzB;AAjBD,oEAAoE;AACpE,gCAGC;AAeD;;GAEG;AAEH;;;;GAIG;AAEH;;;;;;;GAOG;AACH,wBAFU,YAAY,GAAG,UAAU,CAMlC;AAvJD;;;;;GAKG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;;;;;;;;;;GAgBG;AAEH;;;;;;;;;;GAUG;AACH,uBARwD,CAAC,SAA5C,OAAQ,sBAAsB,EAAE,SAAU,EACA,CAAC,SAA3C,OAAQ,sBAAsB,EAAE,OAAQ,sEAE1C,OAAO,sBAAsB,EAAE,aAAa,CAAC,CAAC,CAAC,YAC/C,sBAAsB,CAAC,CAAC,CAAC,kBACzB,aAAa,CAAC,CAAC,CAAC,GACd,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CA8C9B"}
+{"version":3,"file":"pure.d.ts","sourceRoot":"","sources":["../src/pure.js"],"names":[],"mappings":";;;;mCAcwD,CAAC,SAA5C,OAAQ,sBAAsB,EAAE,SAAU,IAC1C,OAAO,sBAAsB,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,OAAO,sBAAsB,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;;;;0BAMvD,CAAC,SAA3C,OAAQ,sBAAsB,EAAE,OAAQ,6DACxC;IACR,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,OAAO,CAAC,EAAE,CAAC,CAAA;CACZ;;;;yBAMoD,CAAC,SAA5C,OAAQ,sBAAsB,EAAE,SAAU,EACA,CAAC,SAA3C,OAAQ,sBAAsB,EAAE,OAAQ,6DAExC;IACR,SAAS,EAAE,WAAW,CAAA;IACtB,WAAW,EAAE,WAAW,CAAA;IACxB,SAAS,EAAE,OAAO,sBAAsB,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;IACpD,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,WAAW,GAAG,gBAAgB,KAAK,IAAI,CAAA;IACpD,QAAQ,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,OAAO,sBAAsB,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACpF,OAAO,EAAE,MAAM,IAAI,CAAA;CACpB,GAAG,GACD,CAAC,IAAI,MAAM,CAAC,GAAG,OAAO,sBAAsB,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACnE;2BAgGS,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,OAAO,sBAAsB,EAAE,YAAY,CAAC,KAAK,OAAO,CAAC,UAAU,CAAC,OAAO,sBAAsB,EAAE,YAAY,CAAC,CAAC;yBAItI,GACP,CAAC,IAAI,OAAO,sBAAsB,EAAE,SAAS,GAAG,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,OAAO,sBAAsB,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,UAAU,CAAC,OAAO,sBAAsB,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,GAC1L;AAvBJ;;;;;;GAMG;AACH,oBAJa,CAAC,OACH,CAAC,MAAM,OAAO,CAAC,CAAC,CAAC,CAAC,IAAG,MAAM,CAAC,CAAA,GAC1B,OAAO,CAAC,CAAC,CAAC,CAStB;AAED;;GAEG;AAEH;;;;GAIG;AAEH;;;;;;;GAOG;AACH,wBAFU,YAAY,GAAG,UAAU,CAEmC;AAjJtE;;;;;GAKG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;;;;;;;;;;GAgBG;AAEH;;;;;;;;;;GAUG;AACH,uBARwD,CAAC,SAA5C,OAAQ,sBAAsB,EAAE,SAAU,EACA,CAAC,SAA3C,OAAQ,sBAAsB,EAAE,OAAQ,sEAE1C,OAAO,sBAAsB,EAAE,aAAa,CAAC,CAAC,CAAC,YAC/C,sBAAsB,CAAC,CAAC,CAAC,kBACzB,aAAa,CAAC,CAAC,CAAC,GACd,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CA6C9B;AAED;;;;;;GAMG;AACH,8BAWC"}

package/src/core/legacy.js

@@ -1,46 +0,0 @@
-/**
- * Legacy rendering core for svelte-testing-library.
- *
- * Supports Svelte <= 4.
- */
-
-/** Allowed options for the component constructor. */
-const allowedOptions = [
-  'target',
-  'accessors',
-  'anchor',
-  'props',
-  'hydrate',
-  'intro',
-  'context',
-]
-
-/**
- * Mount the component into the DOM.
- *
- * The `onDestroy` callback is included for strict backwards compatibility
- * with previous versions of this library. It's mostly unnecessary logic.
- */
-const mount = (Component, options, onDestroy) => {
-  const component = new Component(options)
-
-  if (typeof onDestroy === 'function') {
-    component.$$.on_destroy.push(() => {
-      onDestroy(component)
-    })
-  }
-
-  return component
-}
-
-/** Remove the component from the DOM. */
-const unmount = (component) => {
-  component.$destroy()
-}
-
-/** Update the component's props. */
-const updateProps = (component, nextProps) => {
-  component.$set(nextProps)
-}
-
-export { allowedOptions, mount, unmount, updateProps }

package/src/core/modern.svelte.js

@@ -1,51 +0,0 @@
-/**
- * Modern rendering core for svelte-testing-library.
- *
- * Supports Svelte >= 5.
- */
-import * as Svelte from 'svelte'
-
-/** Props signals for each rendered component. */
-const propsByComponent = new Map()
-
-/** Whether we're using Svelte >= 5. */
-const IS_MODERN_SVELTE = typeof Svelte.mount === 'function'
-
-/** Allowed options to the `mount` call. */
-const allowedOptions = [
-  'target',
-  'anchor',
-  'props',
-  'events',
-  'context',
-  'intro',
-]
-
-/** Mount the component into the DOM. */
-const mount = (Component, options) => {
-  const props = $state(options.props ?? {})
-  const component = Svelte.mount(Component, { ...options, props })
-
-  Svelte.flushSync()
-  propsByComponent.set(component, props)
-
-  return component
-}
-
-/** Remove the component from the DOM. */
-const unmount = (component) => {
-  propsByComponent.delete(component)
-  Svelte.flushSync(() => Svelte.unmount(component))
-}
-
-/**
- * Update the component's props.
- *
- * Relies on the `$state` signal added in `mount`.
- */
-const updateProps = (component, nextProps) => {
-  const prevProps = propsByComponent.get(component)
-  Object.assign(prevProps, nextProps)
-}
-
-export { allowedOptions, IS_MODERN_SVELTE, mount, unmount, updateProps }

package/types/core/legacy.d.ts

@@ -1,19 +0,0 @@
-/**
- * Legacy rendering core for svelte-testing-library.
- *
- * Supports Svelte <= 4.
- */
-/** Allowed options for the component constructor. */
-export const allowedOptions: string[];
-/**
- * Mount the component into the DOM.
- *
- * The `onDestroy` callback is included for strict backwards compatibility
- * with previous versions of this library. It's mostly unnecessary logic.
- */
-export function mount(Component: any, options: any, onDestroy: any): any;
-/** Remove the component from the DOM. */
-export function unmount(component: any): void;
-/** Update the component's props. */
-export function updateProps(component: any, nextProps: any): void;
-//# sourceMappingURL=legacy.d.ts.map

package/types/core/legacy.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"legacy.d.ts","sourceRoot":"","sources":["../../src/core/legacy.js"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,qDAAqD;AACrD,sCAQC;AAED;;;;;GAKG;AACH,yEAUC;AAED,yCAAyC;AACzC,8CAEC;AAED,oCAAoC;AACpC,kEAEC"}

package/types/core/modern.svelte.d.ts

@@ -1,15 +0,0 @@
-/** Allowed options to the `mount` call. */
-export const allowedOptions: string[];
-/** Whether we're using Svelte >= 5. */
-export const IS_MODERN_SVELTE: boolean;
-/** Mount the component into the DOM. */
-export function mount(Component: any, options: any): Record<string, any>;
-/** Remove the component from the DOM. */
-export function unmount(component: any): void;
-/**
- * Update the component's props.
- *
- * Relies on the `$state` signal added in `mount`.
- */
-export function updateProps(component: any, nextProps: any): void;
-//# sourceMappingURL=modern.svelte.d.ts.map

package/types/core/modern.svelte.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"modern.svelte.d.ts","sourceRoot":"","sources":["../../src/core/modern.svelte.js"],"names":[],"mappings":"AAaA,2CAA2C;AAC3C,sCAOC;AAXD,uCAAuC;AACvC,uCAA2D;AAY3D,wCAAwC;AACxC,yEAQC;AAED,yCAAyC;AACzC,8CAGC;AAED;;;;GAIG;AACH,kEAGC"}