fix(types): omit children from wrapper props types (#495)

Author: mcous

packages/svelte-core/types.d.ts

@@ -109,7 +109,7 @@ export interface SetupOptions<W extends Component = never> {
   /** A wrapper component. */
   wrapper?: ComponentImport<W>
   /** Wrapper component props. */
-  wrapperProps?: Props<W>
+  wrapperProps?: Omit<Props<W>, 'children'>
 }
 
 /** The result of setting up the document for rendering. */

tests/fixtures/WrapperRunesTyped.svelte

@@ -0,0 +1,20 @@
+<script lang="ts">
+  import { setContext, type Snippet } from 'svelte'
+
+  const { greeting, children } = $props<{
+    greeting: string
+    children: Snippet
+  }>()
+
+  export const wrapperContext = {
+    get greeting() {
+      return greeting
+    },
+  }
+
+  setContext('wrapperContext', wrapperContext)
+</script>
+
+<div data-testid="wrapper-runes">
+  {@render children?.()}
+</div>

tests/render-runes.test-d.ts

@@ -5,6 +5,7 @@ import { describe, test, vi } from 'vitest'
 import UntypedComponent from './fixtures/Comp.svelte'
 import LegacyComponent from './fixtures/Typed.svelte'
 import Component from './fixtures/TypedRunes.svelte'
+import Wrapper from './fixtures/WrapperRunesTyped.svelte'
 
 describe('types (runes)', () => {
   test('render is a function that accepts a Svelte component', () => {
@@ -44,18 +45,20 @@ describe('types (runes)', () => {
     const result = subject.render(
       UntypedComponent,
       {},
-      { wrapper: Component, wrapperProps: { name: 'Alice', count: 42 } }
+      { wrapper: Wrapper, wrapperProps: { greeting: 'hello' } }
     )
 
-    expectTypeOf(result).toExtend<{ wrapper: { hello: string } }>()
+    expectTypeOf(result).toExtend<{
+      wrapper: { wrapperContext: { greeting: string } }
+    }>()
   })
 
   test('invalid wrapper props are rejected', () => {
     subject.render(
       UntypedComponent,
       {},
-      // @ts-expect-error: count should be a number
-      { wrapper: Component, wrapperProps: { name: 'Alice', count: '42' } }
+      // @ts-expect-error: greeting should be a string
+      { wrapper: Wrapper, wrapperProps: { greeting: 42 } }
     )
   })
 })

tests/tsconfig.legacy.json

@@ -5,6 +5,7 @@
     "fixtures/CompRunes.svelte",
     "fixtures/PropCloner.svelte",
     "fixtures/TypedRunes.svelte",
-    "fixtures/WrapperRunes.svelte"
+    "fixtures/WrapperRunes.svelte",
+    "fixtures/WrapperRunesTyped.svelte"
   ]
 }