@testing-library/svelte 4.2.0 → 4.2.2

package/README.md

@@ -80,6 +80,21 @@ This library has `peerDependencies` listings for `svelte >= 3`.
 You may also be interested in installing `@testing-library/jest-dom` so you can use
 [the custom jest matchers](https://github.com/testing-library/jest-dom).
 
+### Svelte 5 support
+
+If you are riding the bleeding edge of Svelte 5, you'll need to either
+import from `@testing-library/svelte/svelte5` instead of `@testing-library/svelte`, or have your `vite.config.js` contains the following alias:
+
+```
+export default defineConfig(({ }) => ({
+  test: {
+    alias: {
+      '@testing-library/svelte': '@testing-library/svelte/svelte5'
+    }
+  },
+}))
+```
+
 ## Docs
 
 See the [**docs**](https://testing-library.com/docs/svelte-testing-library/intro) over at the Testing Library website.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testing-library/svelte",
-  "version": "4.2.0",
+  "version": "4.2.2",
   "description": "Simple and complete Svelte testing utilities that encourage good testing practices.",
   "main": "src/index.js",
   "exports": {
@@ -8,6 +8,10 @@
       "types": "./types/index.d.ts",
       "default": "./src/index.js"
     },
+    "./svelte5": {
+      "types": "./types/index.d.ts",
+      "default": "./src/svelte5-index.js"
+    },
     "./vitest": {
       "default": "./src/vitest.js"
     }
@@ -94,7 +98,7 @@
     "npm-run-all": "^4.1.5",
     "prettier": "3.2.4",
     "prettier-plugin-svelte": "3.1.2",
-    "svelte": "^4.2.10",
+    "svelte": "^3 || ^4 || ^5",
     "svelte-check": "^3.6.3",
     "svelte-jester": "^3.0.0",
     "typescript": "^5.3.3",

package/src/__tests__/act.test.js

@@ -1,25 +1,13 @@
-import { beforeEach, describe, expect, test } from 'vitest'
+import { setTimeout } from 'node:timers/promises'
+
+import { act, render } from '@testing-library/svelte'
+import { describe, expect, test } from 'vitest'
 
-import { act, fireEvent, render as stlRender } from '..'
 import Comp from './fixtures/Comp.svelte'
 
 describe('act', () => {
-  let props
-
-  const render = () => {
-    return stlRender(Comp, {
-      props
-    })
-  }
-
-  beforeEach(() => {
-    props = {
-      name: 'World'
-    }
-  })
-
   test('state updates are flushed', async () => {
-    const { getByText } = render()
+    const { getByText } = render(Comp)
     const button = getByText('Button')
 
     expect(button).toHaveTextContent('Button')
@@ -31,24 +19,13 @@ describe('act', () => {
     expect(button).toHaveTextContent('Button Clicked')
   })
 
-  test('findByTestId returns the element', async () => {
-    const { findByTestId } = render()
-
-    expect(await findByTestId('test')).toHaveTextContent(`Hello ${props.name}!`)
-  })
-
   test('accepts async functions', async () => {
-    const sleep = (ms) =>
-      new Promise((resolve) => {
-        setTimeout(() => resolve(), ms)
-      })
-
-    const { getByText } = render()
+    const { getByText } = render(Comp)
     const button = getByText('Button')
 
     await act(async () => {
-      await sleep(100)
-      await fireEvent.click(button)
+      await setTimeout(100)
+      button.click()
     })
 
     expect(button).toHaveTextContent('Button Clicked')

package/src/__tests__/auto-cleanup-skip.test.js

@@ -7,7 +7,7 @@ describe('auto-cleanup-skip', () => {
 
   beforeAll(async () => {
     process.env.STL_SKIP_AUTO_CLEANUP = 'true'
-    const stl = await import('..')
+    const stl = await import('@testing-library/svelte')
     render = stl.render
   })
 

package/src/__tests__/auto-cleanup.test.js

@@ -1,6 +1,6 @@
+import { render } from '@testing-library/svelte'
 import { describe, expect, test } from 'vitest'
 
-import { render } from '..'
 import Comp from './fixtures/Comp.svelte'
 
 describe('auto-cleanup', () => {

package/src/__tests__/cleanup.test.js

@@ -1,6 +1,6 @@
+import { cleanup, render } from '@testing-library/svelte'
 import { describe, expect, test, vi } from 'vitest'
 
-import { act, cleanup, render } from '..'
 import Mounter from './fixtures/Mounter.svelte'
 
 const onExecuted = vi.fn()
@@ -15,8 +15,8 @@ describe('cleanup', () => {
     expect(document.body).toBeEmptyDOMElement()
   })
 
-  test('cleanup unmounts component', async () => {
-    await act(renderSubject)
+  test('cleanup unmounts component', () => {
+    renderSubject()
     cleanup()
 
     expect(onDestroyed).toHaveBeenCalledOnce()

package/src/__tests__/context.test.js

@@ -1,9 +1,10 @@
+import { render } from '@testing-library/svelte'
 import { expect, test } from 'vitest'
 
-import { render } from '..'
 import Comp from './fixtures/Context.svelte'
+import { IS_HAPPYDOM, IS_SVELTE_5 } from './utils.js'
 
-test('can set a context', () => {
+test.skipIf(IS_SVELTE_5 && IS_HAPPYDOM)('can set a context', () => {
   const message = 'Got it'
 
   const { getByText } = render(Comp, {

package/src/__tests__/debug.test.js

@@ -1,24 +1,18 @@
 import { prettyDOM } from '@testing-library/dom'
-import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest'
+import { render } from '@testing-library/svelte'
+import { describe, expect, test, vi } from 'vitest'
 
-import { render } from '..'
 import Comp from './fixtures/Comp.svelte'
 
 describe('debug', () => {
-  beforeEach(() => {
-    vi.spyOn(console, 'log').mockImplementation(() => { })
-  })
-
-  afterEach(() => {
-    console.log.mockRestore()
-  })
+  test('pretty prints the base element', () => {
+    vi.stubGlobal('console', { log: vi.fn(), warn: vi.fn(), error: vi.fn() })
 
-  test('pretty prints the container', () => {
-    const { container, debug } = render(Comp, { props: { name: 'world' } })
+    const { baseElement, debug } = render(Comp, { props: { name: 'world' } })
 
     debug()
 
     expect(console.log).toHaveBeenCalledTimes(1)
-    expect(console.log).toHaveBeenCalledWith(prettyDOM(container))
+    expect(console.log).toHaveBeenCalledWith(prettyDOM(baseElement))
   })
 })

package/src/__tests__/events.test.js

@@ -1,6 +1,6 @@
+import { fireEvent, render } from '@testing-library/svelte'
 import { describe, expect, test } from 'vitest'
 
-import { fireEvent, render } from '..'
 import Comp from './fixtures/Comp.svelte'
 
 describe('events', () => {
@@ -8,8 +8,9 @@ describe('events', () => {
     const { getByText } = render(Comp, { props: { name: 'World' } })
     const button = getByText('Button')
 
-    await fireEvent.click(button)
+    const result = fireEvent.click(button)
 
+    await expect(result).resolves.toBe(true)
     expect(button).toHaveTextContent('Button Clicked')
   })
 
@@ -17,14 +18,15 @@ describe('events', () => {
     const { getByText } = render(Comp, { props: { name: 'World' } })
     const button = getByText('Button')
 
-    await fireEvent(
+    const result = fireEvent(
       button,
       new MouseEvent('click', {
         bubbles: true,
-        cancelable: true
+        cancelable: true,
       })
     )
 
+    await expect(result).resolves.toBe(true)
     expect(button).toHaveTextContent('Button Clicked')
   })
 })

package/src/__tests__/fixtures/Comp.svelte

@@ -1,23 +1,17 @@
 <svelte:options accessors />
 
 <script>
-  import { getContext } from 'svelte'
-
-  export let name
+  export let name = 'World'
 
   let buttonText = 'Button'
 
-  const contextName = getContext('name')
-
-  function handleClick () {
+  function handleClick() {
     buttonText = 'Button Clicked'
   }
 </script>
 
 <h1 data-testid="test">Hello {name}!</h1>
 
-<div>we have {contextName}</div>
-
 <button on:click={handleClick}>{buttonText}</button>
 
 <style></style>

package/src/__tests__/fixtures/Context.svelte

@@ -1,7 +1,7 @@
 <script>
-  import { getContext } from 'svelte';
+  import { getContext } from 'svelte'
 
-  const ctx = getContext('foo');
+  const ctx = getContext('foo')
 </script>
 
 <div>{ctx.message}</div>

package/src/__tests__/fixtures/Simple.svelte

@@ -1,5 +1,7 @@
 <script lang="ts">
   export let name: string
+  export let count: number
 </script>
 
 <h1>hello {name}</h1>
+<p>count: {count}</p>

package/src/__tests__/mount.test.js

@@ -1,13 +1,14 @@
+import { act, render, screen } from '@testing-library/svelte'
 import { describe, expect, test, vi } from 'vitest'
 
-import { act, render, screen } from '..'
 import Mounter from './fixtures/Mounter.svelte'
+import { IS_HAPPYDOM, IS_SVELTE_5 } from './utils.js'
 
 const onMounted = vi.fn()
 const onDestroyed = vi.fn()
 const renderSubject = () => render(Mounter, { onMounted, onDestroyed })
 
-describe('mount and destroy', () => {
+describe.skipIf(IS_SVELTE_5 && IS_HAPPYDOM)('mount and destroy', () => {
   test('component is mounted', async () => {
     renderSubject()
 

package/src/__tests__/multi-base.test.js

@@ -1,6 +1,6 @@
+import { render } from '@testing-library/svelte'
 import { describe, expect, test } from 'vitest'
 
-import { render } from '..'
 import Comp from './fixtures/Comp.svelte'
 
 describe('multi-base', () => {
@@ -13,11 +13,11 @@ describe('multi-base', () => {
       {
         target: treeA,
         props: {
-          name: 'Tree A'
-        }
+          name: 'Tree A',
+        },
       },
       {
-        container: treeA
+        baseElement: treeA,
       }
     )
 
@@ -26,11 +26,11 @@ describe('multi-base', () => {
       {
         target: treeB,
         props: {
-          name: 'Tree B'
-        }
+          name: 'Tree B',
+        },
       },
       {
-        container: treeB
+        baseElement: treeB,
       }
     )
 

package/src/__tests__/render.test.js

@@ -1,123 +1,85 @@
-import { VERSION as SVELTE_VERSION } from 'svelte/compiler'
-import { beforeEach, describe, expect, test } from 'vitest'
+import { render } from '@testing-library/svelte'
+import { describe, expect, test } from 'vitest'
 
-import { act, render as stlRender } from '..'
 import Comp from './fixtures/Comp.svelte'
-import CompDefault from './fixtures/Comp2.svelte'
+import { IS_SVELTE_5 } from './utils.js'
 
 describe('render', () => {
-  let props
-
-  const render = (additional = {}) => {
-    return stlRender(Comp, {
-      target: document.body,
-      props,
-      ...additional,
-    })
-  }
-
-  beforeEach(() => {
-    props = {
-      name: 'World',
-    }
-  })
+  const props = { name: 'World' }
 
   test('renders component into the document', () => {
-    const { getByText } = render()
+    const { getByText } = render(Comp, { props })
 
     expect(getByText('Hello World!')).toBeInTheDocument()
   })
 
-  // Dear reader, this is not something you generally want to do in your tests.
-  test('programmatically change props', async () => {
-    const { component, getByText } = render()
-
+  test('accepts props directly', () => {
+    const { getByText } = render(Comp, props)
     expect(getByText('Hello World!')).toBeInTheDocument()
-
-    await act(() => {
-      component.$set({ name: 'Worlds' })
-    })
-
-    expect(getByText('Hello Worlds!')).toBeInTheDocument()
   })
 
-  test('change props with accessors', async () => {
-    const { component, getByText } = render(
-      SVELTE_VERSION < '5' ? { accessors: true } : {}
-    )
-
-    expect(getByText('Hello World!')).toBeInTheDocument()
+  test('throws error when mixing svelte component options and props', () => {
+    expect(() => {
+      render(Comp, { props, name: 'World' })
+    }).toThrow(/Unknown options/)
+  })
 
-    expect(component.name).toBe('World')
+  test('throws error when mixing target option and props', () => {
+    expect(() => {
+      render(Comp, { target: document.createElement('div'), name: 'World' })
+    }).toThrow(/Unknown options/)
+  })
 
-    await act(() => {
-      component.value = 'Planet'
-    })
+  test('should return a container object wrapping the DOM of the rendered component', () => {
+    const { container, getByTestId } = render(Comp, props)
+    const firstElement = getByTestId('test')
 
-    expect(getByText('Hello World!')).toBeInTheDocument()
+    expect(container.firstChild).toBe(firstElement)
   })
 
-  test('should accept props directly', () => {
-    const { getByText } = stlRender(Comp, { name: 'World' })
-    expect(getByText('Hello World!')).toBeInTheDocument()
-  })
+  test('should return a baseElement object, which holds the container', () => {
+    const { baseElement, container } = render(Comp, props)
 
-  test.runIf(SVELTE_VERSION < '5')(
-    'should accept svelte v4 component options',
-    () => {
-      const target = document.createElement('div')
-      const div = document.createElement('div')
-      document.body.appendChild(target)
-      target.appendChild(div)
-      const { container } = stlRender(Comp, {
-        target,
-        anchor: div,
-        props: { name: 'World' },
-        context: new Map([['name', 'context']]),
-      })
-      expect(container).toMatchSnapshot()
-    }
-  )
-
-  test.runIf(SVELTE_VERSION >= '5')(
-    'should accept svelte v5 component options',
-    () => {
-      const target = document.createElement('section')
-      document.body.appendChild(target)
-
-      const { container } = stlRender(Comp, {
-        target,
-        props: { name: 'World' },
-        context: new Map([['name', 'context']]),
-      })
-      expect(container).toMatchSnapshot()
-    }
-  )
-
-  test('should throw error when mixing svelte component options and props', () => {
-    expect(() => {
-      stlRender(Comp, { props: {}, name: 'World' })
-    }).toThrow(/Unknown options were found/)
+    expect(baseElement).toBe(document.body)
+    expect(baseElement.firstChild).toBe(container)
   })
 
-  test('should return a container object, which contains the DOM of the rendered component', () => {
-    const { container } = render()
+  test('if target is provided, use it as container and baseElement', () => {
+    const target = document.createElement('div')
+    const { baseElement, container } = render(Comp, { props, target })
 
-    expect(container.innerHTML).toBe(document.body.innerHTML)
+    expect(container).toBe(target)
+    expect(baseElement).toBe(target)
   })
 
-  test('correctly find component constructor on the default property', () => {
-    const { getByText } = render(CompDefault, { props: { name: 'World' } })
+  test('allow baseElement to be specified', () => {
+    const customBaseElement = document.createElement('div')
 
-    expect(getByText('Hello World!')).toBeInTheDocument()
+    const { baseElement, container } = render(
+      Comp,
+      { props },
+      { baseElement: customBaseElement }
+    )
+
+    expect(baseElement).toBe(customBaseElement)
+    expect(baseElement.firstChild).toBe(container)
   })
 
-  test("accept the 'context' option", () => {
-    const { getByText } = stlRender(Comp, {
-      props: { name: 'Universe' },
-      context: new Map([['name', 'context']]),
-    })
+  test.skipIf(IS_SVELTE_5)('should accept anchor option in Svelte v4', () => {
+    const baseElement = document.body
+    const target = document.createElement('section')
+    const anchor = document.createElement('div')
+    baseElement.appendChild(target)
+    target.appendChild(anchor)
+
+    const { getByTestId } = render(
+      Comp,
+      { props, target, anchor },
+      { baseElement }
+    )
+    const firstElement = getByTestId('test')
 
-    expect(getByText('we have context')).toBeInTheDocument()
+    expect(target.firstChild).toBe(firstElement)
+    expect(target.lastChild).toBe(anchor)
   })
 })

package/src/__tests__/rerender.test.js

@@ -1,41 +1,50 @@
-/**
- * @jest-environment jsdom
- */
+import { act, render, screen } from '@testing-library/svelte'
+import { VERSION as SVELTE_VERSION } from 'svelte/compiler'
 import { describe, expect, test, vi } from 'vitest'
-import { writable } from 'svelte/store'
 
-import { act, render, waitFor } from '..'
-import Comp from './fixtures/Rerender.svelte'
+import Comp from './fixtures/Comp.svelte'
 
-test('mounts new component successfully', async () => {
-  const onMounted = vi.fn()
-  const onDestroyed = vi.fn()
+describe('rerender', () => {
+  test('updates props', async () => {
+    const { rerender } = render(Comp, { name: 'World' })
+    const element = screen.getByText('Hello World!')
 
-  const { getByTestId, rerender } = render(Comp, {
-    props: { name: 'World 1', onMounted, onDestroyed },
+    await rerender({ name: 'Dolly' })
+
+    expect(element).toHaveTextContent('Hello Dolly!')
   })
 
-  const expectToRender = (content) =>
-    waitFor(() => {
-      expect(getByTestId('test')).toHaveTextContent(content)
-      expect(onMounted).toHaveBeenCalledOnce()
-    })
+  test('warns if incorrect arguments shape used', async () => {
+    vi.stubGlobal('console', { log: vi.fn(), warn: vi.fn(), error: vi.fn() })
+
+    const { rerender } = render(Comp, { name: 'World' })
+    const element = screen.getByText('Hello World!')
 
-  await expectToRender('Hello World 1!')
+    await rerender({ props: { name: 'Dolly' } })
 
-  console.warn = vi.fn()
+    expect(element).toHaveTextContent('Hello Dolly!')
+    expect(console.warn).toHaveBeenCalledOnce()
+    expect(console.warn).toHaveBeenCalledWith(
+      expect.stringMatching(/deprecated/iu)
+    )
+  })
 
-  rerender({ props: { name: 'World 2' } })
-  await expectToRender('Hello World 2!')
-  expect(onDestroyed).not.toHaveBeenCalled()
+  test('change props with accessors', async () => {
+    const { component, getByText } = render(
+      Comp,
+      SVELTE_VERSION < '5'
+        ? { accessors: true, props: { name: 'World' } }
+        : { name: 'World' }
+    )
+    const element = getByText('Hello World!')
 
-  expect(console.warn).toHaveBeenCalledOnce()
+    expect(element).toBeInTheDocument()
+    expect(component.name).toBe('World')
 
-  console.warn.mockClear()
-  onDestroyed.mockReset()
-  rerender({ name: 'World 3' })
-  await expectToRender('Hello World 3!')
-  expect(onDestroyed).not.toHaveBeenCalled()
+    await act(() => {
+      component.name = 'Planet'
+    })
 
-  expect(console.warn).not.toHaveBeenCalled()
+    expect(element).toHaveTextContent('Hello Planet!')
+  })
 })

package/src/__tests__/transition.test.js

@@ -1,16 +1,16 @@
+import { render, screen, waitFor } from '@testing-library/svelte'
 import { userEvent } from '@testing-library/user-event'
-import { VERSION as SVELTE_VERSION } from 'svelte/compiler'
 import { beforeEach, describe, expect, test, vi } from 'vitest'
 
-import { render, screen, waitFor } from '..'
 import Transitioner from './fixtures/Transitioner.svelte'
+import { IS_JSDOM, IS_SVELTE_5 } from './utils.js'
 
-describe.runIf(SVELTE_VERSION < '5')('transitions', () => {
+describe.skipIf(IS_SVELTE_5)('transitions', () => {
   beforeEach(() => {
-    if (window.navigator.userAgent.includes('jsdom')) {
-      const raf = (fn) => setTimeout(() => fn(new Date()), 16)
-      vi.stubGlobal('requestAnimationFrame', raf)
-    }
+    if (!IS_JSDOM) return
+
+    const raf = (fn) => setTimeout(() => fn(new Date()), 16)
+    vi.stubGlobal('requestAnimationFrame', raf)
   })
 
   test('on:introend', async () => {

package/src/__tests__/utils.js

@@ -0,0 +1,7 @@
+import { VERSION as SVELTE_VERSION } from 'svelte/compiler'
+
+export const IS_JSDOM = window.navigator.userAgent.includes('jsdom')
+
+export const IS_HAPPYDOM = !IS_JSDOM // right now it's happy or js
+
+export const IS_SVELTE_5 = SVELTE_VERSION >= '5'

package/src/index.js

@@ -1,3 +1,4 @@
+/* eslint-disable import/export */
 import { act, cleanup } from './pure.js'
 
 // If we're running in a test runner that supports afterEach
@@ -12,4 +13,9 @@ if (typeof afterEach === 'function' && !process.env.STL_SKIP_AUTO_CLEANUP) {
   })
 }
 
-export * from './pure.js'
+// export all base queries, screen, etc.
+export * from '@testing-library/dom'
+
+// export svelte-specific functions and custom `fireEvent`
+// `fireEvent` must be a named export to take priority over wildcard export above
+export { act, cleanup, fireEvent, render } from './pure.js'

package/src/pure.js

@@ -4,42 +4,40 @@ import {
   prettyDOM,
 } from '@testing-library/dom'
 import * as Svelte from 'svelte'
+import { VERSION as SVELTE_VERSION } from 'svelte/compiler'
 
-const IS_SVELTE_5 = typeof Svelte.createRoot === 'function'
-const targetCache = new Set()
-const componentCache = new Set()
+const IS_SVELTE_5 = /^5\./.test(SVELTE_VERSION)
 
-const svelteComponentOptions = IS_SVELTE_5
-  ? ['target', 'props', 'events', 'context', 'intro', 'recover']
-  : ['accessors', 'anchor', 'props', 'hydrate', 'intro', 'context']
+export class SvelteTestingLibrary {
+  svelteComponentOptions = [
+    'target',
+    'accessors',
+    'anchor',
+    'props',
+    'hydrate',
+    'intro',
+    'context',
+  ]
 
-const render = (
-  Component,
-  { target, ...options } = {},
-  { container, queries } = {}
-) => {
-  container = container || document.body
-  target = target || container.appendChild(document.createElement('div'))
-  targetCache.add(target)
+  targetCache = new Set()
+  componentCache = new Set()
 
-  const ComponentConstructor = Component.default || Component
-
-  const checkProps = (options) => {
+  checkProps(options) {
     const isProps = !Object.keys(options).some((option) =>
-      svelteComponentOptions.includes(option)
+      this.svelteComponentOptions.includes(option)
     )
 
     // Check if any props and Svelte options were accidentally mixed.
     if (!isProps) {
       const unrecognizedOptions = Object.keys(options).filter(
-        (option) => !svelteComponentOptions.includes(option)
+        (option) => !this.svelteComponentOptions.includes(option)
       )
 
       if (unrecognizedOptions.length > 0) {
         throw Error(`
           Unknown options were found [${unrecognizedOptions}]. This might happen if you've mixed
           passing in props with Svelte options into the render function. Valid Svelte options
-          are [${svelteComponentOptions}]. You can either change the prop names, or pass in your
+          are [${this.svelteComponentOptions}]. You can either change the prop names, or pass in your
           props for that component via the \`props\` option.\n\n
           Eg: const { /** Results **/ } = render(MyComponent, { props: { /** props here **/ } })\n\n
         `)
@@ -51,78 +49,100 @@ const render = (
     return { props: options }
   }
 
-  const renderComponent = (options) => {
-    options = { target, ...checkProps(options) }
+  render(Component, componentOptions = {}, renderOptions = {}) {
+    componentOptions = this.checkProps(componentOptions)
+
+    const baseElement =
+      renderOptions.baseElement ?? componentOptions.target ?? document.body
+
+    const target =
+      componentOptions.target ??
+      baseElement.appendChild(document.createElement('div'))
+
+    this.targetCache.add(target)
+
+    const ComponentConstructor = Component.default || Component
+
+    const component = this.renderComponent(ComponentConstructor, {
+      ...componentOptions,
+      target,
+    })
+
+    return {
+      baseElement,
+      component,
+      container: target,
+      debug: (el = baseElement) => console.log(prettyDOM(el)),
+      rerender: async (props) => {
+        if (props.props) {
+          console.warn(
+            'rerender({ props: {...} }) deprecated, use rerender({...}) instead'
+          )
+          props = props.props
+        }
+        component.$set(props)
+        await Svelte.tick()
+      },
+      unmount: () => {
+        this.cleanupComponent(component)
+      },
+      ...getQueriesForElement(baseElement, renderOptions.queries),
+    }
+  }
+
+  renderComponent(ComponentConstructor, componentOptions) {
+    if (IS_SVELTE_5) {
+      throw new Error('for Svelte 5, use `@testing-library/svelte/svelte5`')
+    }
 
-    const component = IS_SVELTE_5
-      ? Svelte.createRoot(ComponentConstructor, options)
-      : new ComponentConstructor(options)
+    const component = new ComponentConstructor(componentOptions)
 
-    componentCache.add(component)
+    this.componentCache.add(component)
 
     // TODO(mcous, 2024-02-11): remove this behavior in the next major version
-    // It is unnecessary has no path to implementation in Svelte v5
-    if (!IS_SVELTE_5) {
-      component.$$.on_destroy.push(() => {
-        componentCache.delete(component)
-      })
-    }
+    component.$$.on_destroy.push(() => {
+      this.componentCache.delete(component)
+    })
 
     return component
   }
 
-  let component = renderComponent(options)
-
-  return {
-    container,
-    component,
-    debug: (el = container) => console.log(prettyDOM(el)),
-    rerender: async (props) => {
-      if (props.props) {
-        console.warn(
-          'rerender({ props: {...} }) deprecated, use rerender({...}) instead'
-        )
-        props = props.props
-      }
-      component.$set(props)
-      await Svelte.tick()
-    },
-    unmount: () => {
-      cleanupComponent(component)
-    },
-    ...getQueriesForElement(container, queries),
+  cleanupComponent(component) {
+    const inCache = this.componentCache.delete(component)
+
+    if (inCache) {
+      component.$destroy()
+    }
   }
-}
 
-const cleanupComponent = (component) => {
-  const inCache = componentCache.delete(component)
+  cleanupTarget(target) {
+    const inCache = this.targetCache.delete(target)
 
-  if (inCache) {
-    component.$destroy()
+    if (inCache && target.parentNode === document.body) {
+      document.body.removeChild(target)
+    }
   }
-}
-
-const cleanupTarget = (target) => {
-  const inCache = targetCache.delete(target)
 
-  if (inCache && target.parentNode === document.body) {
-    document.body.removeChild(target)
+  cleanup() {
+    this.componentCache.forEach(this.cleanupComponent.bind(this))
+    this.targetCache.forEach(this.cleanupTarget.bind(this))
   }
 }
 
-const cleanup = () => {
-  componentCache.forEach(cleanupComponent)
-  targetCache.forEach(cleanupTarget)
-}
+const instance = new SvelteTestingLibrary()
+
+export const render = instance.render.bind(instance)
 
-const act = async (fn) => {
+export const cleanup = instance.cleanup.bind(instance)
+
+export const act = async (fn) => {
   if (fn) {
     await fn()
   }
   return Svelte.tick()
 }
 
-const fireEvent = async (...args) => {
+export const fireEvent = async (...args) => {
   const event = dtlFireEvent(...args)
   await Svelte.tick()
   return event
@@ -135,9 +155,3 @@ Object.keys(dtlFireEvent).forEach((key) => {
     return event
   }
 })
-
-/* eslint-disable import/export */
-
-export * from '@testing-library/dom'
-
-export { render, cleanup, fireEvent, act }

package/src/svelte5-index.js

@@ -0,0 +1,22 @@
+/* eslint-disable import/export */
+import { act, cleanup } from './svelte5.js'
+
+// If we're running in a test runner that supports afterEach
+// then we'll automatically run cleanup afterEach test
+// this ensures that tests run in isolation from each other
+// if you don't like this then either import the `pure` module
+// or set the STL_SKIP_AUTO_CLEANUP env variable to 'true'.
+if (typeof afterEach === 'function' && !process.env.STL_SKIP_AUTO_CLEANUP) {
+  afterEach(async () => {
+    await act()
+    cleanup()
+  })
+}
+
+// export all base queries, screen, etc.
+export * from '@testing-library/dom'
+
+// export svelte-specific functions and custom `fireEvent`
+// `fireEvent` must be a named export to take priority over wildcard export above
+export { act, fireEvent } from './pure.js'
+export { cleanup, render } from './svelte5.js'

package/src/svelte5.js

@@ -0,0 +1,30 @@
+import { createClassComponent } from 'svelte/legacy'
+
+import { SvelteTestingLibrary } from './pure.js'
+
+class Svelte5TestingLibrary extends SvelteTestingLibrary {
+  svelteComponentOptions = [
+    'target',
+    'props',
+    'events',
+    'context',
+    'intro',
+    'recover',
+  ]
+
+  renderComponent(ComponentConstructor, componentOptions) {
+    const component = createClassComponent({
+      ...componentOptions,
+      component: ComponentConstructor,
+    })
+
+    this.componentCache.add(component)
+
+    return component
+  }
+}
+
+const instance = new Svelte5TestingLibrary()
+
+export const render = instance.render.bind(instance)
+export const cleanup = instance.cleanup.bind(instance)

package/src/vitest.js

@@ -1,7 +1,6 @@
+import { act, cleanup } from '@testing-library/svelte'
 import { afterEach } from 'vitest'
 
-import { act, cleanup } from './pure.js'
-
 afterEach(async () => {
   await act()
   cleanup()

package/types/index.d.ts

@@ -18,12 +18,7 @@ export * from '@testing-library/dom'
 
 type SvelteComponentOptions<C extends SvelteComponent> =
   | ComponentProps<C>
-  | Pick<
-      ComponentConstructorOptions<ComponentProps<C>>,
-      'anchor' | 'props' | 'hydrate' | 'intro' | 'context'
-    >
-
-type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>
+  | Partial<ComponentConstructorOptions<ComponentProps<C>>>
 
 type Constructor<T> = new (...args: any[]) => T
 
@@ -35,24 +30,22 @@ export type RenderResult<
   Q extends Queries = typeof queries,
 > = {
   container: HTMLElement
+  baseElement: HTMLElement
   component: C
   debug: (el?: HTMLElement | DocumentFragment) => void
-  rerender: (props: ComponentProps<C>) => Promise<void>
+  rerender: (props: Partial<ComponentProps<C>>) => Promise<void>
   unmount: () => void
 } & { [P in keyof Q]: BoundFunction<Q[P]> }
 
 export interface RenderOptions<Q extends Queries = typeof queries> {
-  container?: HTMLElement
+  baseElement?: HTMLElement
   queries?: Q
 }
 
-export function render<C extends SvelteComponent>(
-  component: Constructor<C>,
-  componentOptions?: SvelteComponentOptions<C>,
-  renderOptions?: Omit<RenderOptions, 'queries'>
-): RenderResult<C>
-
-export function render<C extends SvelteComponent, Q extends Queries>(
+export function render<
+  C extends SvelteComponent,
+  Q extends Queries = typeof queries,
+>(
   component: Constructor<C>,
   componentOptions?: SvelteComponentOptions<C>,
   renderOptions?: RenderOptions<Q>

package/src/__tests__/__snapshots__/render.test.js.snap

@@ -1,48 +0,0 @@
-// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
-
-exports[`render > should accept svelte v4 component options 1`] = `
-<body>
-  <div>
-    <h1
-      data-testid="test"
-    >
-      Hello 
-      World
-      !
-    </h1>
-     
-    <div>
-      we have context
-    </div>
-     
-    <button>
-      Button
-    </button>
-    <div />
-  </div>
-</body>
-`;
-
-exports[`render > should accept svelte v5 component options 1`] = `
-<body>
-  
-  
-  
-  <section>
-    <h1
-      data-testid="test"
-    >
-      Hello World!
-    </h1>
-     
-    <div>
-      we have context
-    </div>
-     
-    <button>
-      Button
-    </button>
-    
-  </section>
-</body>
-`;

package/src/__tests__/fixtures/Comp2.svelte

@@ -1,15 +0,0 @@
-<script>
-  export let name
-
-  let buttonText = 'Button Text'
-
-  function handleClick () {
-    buttonText = 'Button Clicked'
-  }
-</script>
-
-<style></style>
-
-<h1>Hello {name}!</h1>
-
-<button on:click={handleClick}>{buttonText}</button>

package/src/__tests__/fixtures/Rerender.svelte

@@ -1,17 +0,0 @@
-<script>
-  import { onDestroy, onMount } from 'svelte'
-
-  export let onExecuted = undefined
-  export let onMounted = undefined
-  export let onDestroyed = undefined
-
-  export let name = ''
-
-  onExecuted?.()
-
-  onMount(() => onMounted?.())
-
-  onDestroy(() => onDestroyed?.())
-</script>
-
-<div data-testid="test">Hello {name}!</div>