@testing-library/svelte 5.2.2 → 5.2.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testing-library/svelte",
-  "version": "5.2.2",
+  "version": "5.2.4",
   "description": "Simple and complete Svelte testing utilities that encourage good testing practices.",
   "main": "src/index.js",
   "exports": {
@@ -72,7 +72,7 @@
     "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",
+    "build": "tsc -p tsconfig.build.json && cp src/component-types.d.ts types",
     "contributors:add": "all-contributors add",
     "contributors:generate": "all-contributors generate",
     "preview-release": "./scripts/preview-release"
@@ -120,7 +120,7 @@
     "prettier": "^3.3.3",
     "prettier-plugin-svelte": "^3.2.5",
     "svelte": "^3 || ^4 || ^5 || ^5.0.0-next.0",
-    "svelte-check": "^3.8.4",
+    "svelte-check": "^4.0.4",
     "svelte-jester": "^5.0.0",
     "typescript": "^5.5.3",
     "vite": "^5.3.3",

package/src/component-types.d.ts

@@ -1,11 +1,14 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
 import type * as Svelte from 'svelte'
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 type IS_MODERN_SVELTE = any extends Svelte.Component ? false : true
 
 /** A compiled, imported Svelte component. */
-export type Component<P> = IS_MODERN_SVELTE extends true
-  ? Svelte.Component<P> | Svelte.SvelteComponent<P>
+export type Component<
+  P extends Record<string, any>,
+  E extends Record<string, any>,
+> = IS_MODERN_SVELTE extends true
+  ? Svelte.Component<P, E> | Svelte.SvelteComponent<P>
   : Svelte.SvelteComponent<P>
 
 /**
@@ -19,7 +22,7 @@ export type ComponentType<C> = C extends Svelte.SvelteComponent
   : C
 
 /** The props of a component. */
-export type Props<C> = Svelte.ComponentProps<C>
+export type Props<C extends Component<any, any>> = Svelte.ComponentProps<C>
 
 /**
  * The exported fields of a component.
@@ -29,7 +32,7 @@ export type Props<C> = Svelte.ComponentProps<C>
  */
 export type Exports<C> = C extends Svelte.SvelteComponent
   ? C
-  : C extends Svelte.Component<unknown, infer E>
+  : C extends Svelte.Component<any, infer E>
     ? E
     : never
 
@@ -38,6 +41,7 @@ export type Exports<C> = C extends Svelte.SvelteComponent
  *
  * In Svelte 4, these are the options passed to the component constructor.
  */
-export type MountOptions<C> = IS_MODERN_SVELTE extends true
-  ? Parameters<typeof Svelte.mount<Props<C>, Exports<C>>>[1]
-  : Svelte.ComponentConstructorOptions<Props<C>>
+export type MountOptions<C extends Component<any, any>> =
+  IS_MODERN_SVELTE extends true
+    ? Parameters<typeof Svelte.mount<Props<C>, Exports<C>>>[1]
+    : Svelte.ComponentConstructorOptions<Props<C>>

package/src/vite.js

@@ -7,12 +7,13 @@ import { fileURLToPath } from 'node:url'
  * Ensures Svelte is imported correctly in tests
  * and that the DOM is cleaned up after each test.
  *
- * @param {{resolveBrowser?: boolean, autoCleanup?: boolean}} options
+ * @param {{resolveBrowser?: boolean, autoCleanup?: boolean, noExternal?: boolean}} options
  * @returns {import('vite').Plugin}
  */
 export const svelteTesting = ({
   resolveBrowser = true,
   autoCleanup = true,
+  noExternal = true,
 } = {}) => ({
   name: 'vite-plugin-svelte-testing-library',
   config: (config) => {
@@ -27,6 +28,10 @@ export const svelteTesting = ({
     if (autoCleanup) {
       addAutoCleanup(config)
     }
+
+    if (noExternal) {
+      addNoExternal(config)
+    }
   },
 })
 
@@ -64,6 +69,10 @@ const addAutoCleanup = (config) => {
   const test = config.test ?? {}
   let setupFiles = test.setupFiles ?? []
 
+  if (test.globals) {
+    return
+  }
+
   if (typeof setupFiles === 'string') {
     setupFiles = [setupFiles]
   }
@@ -73,3 +82,40 @@ const addAutoCleanup = (config) => {
   test.setupFiles = setupFiles
   config.test = test
 }
+
+/**
+ * Add `@testing-library/svelte` to Vite's noExternal rules, if not present.
+ *
+ * This ensures `@testing-library/svelte` is processed by `@sveltejs/vite-plugin-svelte`
+ * in certain monorepo setups.
+ */
+const addNoExternal = (config) => {
+  const ssr = config.ssr ?? {}
+  let noExternal = ssr.noExternal ?? []
+
+  if (noExternal === true) {
+    return
+  }
+
+  if (typeof noExternal === 'string' || noExternal instanceof RegExp) {
+    noExternal = [noExternal]
+  }
+
+  if (!Array.isArray(noExternal)) {
+    return
+  }
+
+  for (const rule of noExternal) {
+    if (typeof rule === 'string' && rule === '@testing-library/svelte') {
+      return
+    }
+
+    if (rule instanceof RegExp && rule.test('@testing-library/svelte')) {
+      return
+    }
+  }
+
+  noExternal.push('@testing-library/svelte')
+  ssr.noExternal = noExternal
+  config.ssr = ssr
+}

package/types/component-types.d.ts

@@ -0,0 +1,47 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import type * as Svelte from 'svelte'
+
+type IS_MODERN_SVELTE = any extends Svelte.Component ? false : true
+
+/** A compiled, imported Svelte component. */
+export type Component<
+  P extends Record<string, any>,
+  E extends Record<string, any>,
+> = IS_MODERN_SVELTE extends true
+  ? Svelte.Component<P, E> | Svelte.SvelteComponent<P>
+  : Svelte.SvelteComponent<P>
+
+/**
+ * The type of an imported, compiled Svelte component.
+ *
+ * In Svelte 4, this was the Svelte component class' type.
+ * In Svelte 5, this distinction no longer matters.
+ */
+export type ComponentType<C> = C extends Svelte.SvelteComponent
+  ? Svelte.ComponentType<C>
+  : C
+
+/** The props of a component. */
+export type Props<C extends Component<any, any>> = Svelte.ComponentProps<C>
+
+/**
+ * The exported fields of a component.
+ *
+ * In Svelte 4, this is simply the instance of the component class.
+ * In Svelte 5, this is the set of variables marked as `export`'d.
+ */
+export type Exports<C> = C extends Svelte.SvelteComponent
+  ? C
+  : C extends Svelte.Component<any, infer E>
+    ? E
+    : never
+
+/**
+ * Options that may be passed to `mount` when rendering the component.
+ *
+ * In Svelte 4, these are the options passed to the component constructor.
+ */
+export type MountOptions<C extends Component<any, any>> =
+  IS_MODERN_SVELTE extends true
+    ? Parameters<typeof Svelte.mount<Props<C>, Exports<C>>>[1]
+    : Svelte.ComponentConstructorOptions<Props<C>>

package/types/vite.d.ts

@@ -1,5 +1,6 @@
-export function svelteTesting({ resolveBrowser, autoCleanup, }?: {
+export function svelteTesting({ resolveBrowser, autoCleanup, noExternal, }?: {
     resolveBrowser?: boolean;
     autoCleanup?: boolean;
+    noExternal?: boolean;
 }): import("vite").Plugin;
 //# sourceMappingURL=vite.d.ts.map

package/types/vite.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"vite.d.ts","sourceRoot":"","sources":["../src/vite.js"],"names":[],"mappings":"AAYO,iEAHI;IAAC,cAAc,CAAC,EAAE,OAAO,CAAC;IAAC,WAAW,CAAC,EAAE,OAAO,CAAA;CAAC,GAC/C,OAAO,MAAM,EAAE,MAAM,CAoBhC"}
+{"version":3,"file":"vite.d.ts","sourceRoot":"","sources":["../src/vite.js"],"names":[],"mappings":"AAYO,6EAHI;IAAC,cAAc,CAAC,EAAE,OAAO,CAAC;IAAC,WAAW,CAAC,EAAE,OAAO,CAAC;IAAC,UAAU,CAAC,EAAE,OAAO,CAAA;CAAC,GACrE,OAAO,MAAM,EAAE,MAAM,CAyBhC"}