Move client types into Astro (#3851)

* Move client types into Astro

* Adds a changeset

* Fix path to local client

* Reference vite/client in our HMR types

* Add back in the expect-error

* Update types comment

.changeset/healthy-poems-know.md

@@ -0,0 +1,5 @@
+---
+'astro': patch
+---
+
+Replaces vite/client types with astro/client

examples/basics/tsconfig.json

@@ -9,7 +9,7 @@
     "resolveJsonModule": true,
     // Enable stricter transpilation for better output.
     "isolatedModules": true,
-    // Add type definitions for our Vite runtime.
-    "types": ["vite/client"]
+    // Add type definitions for our Astro runtime.
+    "types": ["astro/client"]
   }
 }

examples/blog-multiple-authors/tsconfig.json

@@ -9,7 +9,7 @@
     "resolveJsonModule": true,
     // Enable stricter transpilation for better output.
     "isolatedModules": true,
-    // Add type definitions for our Vite runtime.
-    "types": ["vite/client"]
+    // Add type definitions for our Astro runtime.
+    "types": ["astro/client"]
   }
 }

examples/blog/tsconfig.json

@@ -9,7 +9,7 @@
     "resolveJsonModule": true,
     // Enable stricter transpilation for better output.
     "isolatedModules": true,
-    // Add type definitions for our Vite runtime.
-    "types": ["vite/client"]
+    // Add type definitions for our Astro runtime.
+    "types": ["astro/client"]
   }
 }

examples/docs/tsconfig.json

@@ -9,7 +9,7 @@
     "resolveJsonModule": true,
     // Enable stricter transpilation for better output.
     "isolatedModules": true,
-    // Add type definitions for our Vite runtime.
-    "types": ["vite/client"]
+    // Add type definitions for our Astro runtime.
+    "types": ["astro/client"]
   }
 }

examples/env-vars/src/env.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="vite/client" />
+/// <reference types="astro/client" />
 
 interface ImportMetaEnv {
 	readonly DB_PASSWORD: string;

examples/env-vars/tsconfig.json

@@ -9,7 +9,7 @@
     "resolveJsonModule": true,
     // Enable stricter transpilation for better output.
     "isolatedModules": true,
-    // Add type definitions for our Vite runtime.
-    "types": ["vite/client"]
+    // Add type definitions for our Astro runtime.
+    "types": ["astro/client"]
   }
 }

examples/framework-alpine/tsconfig.json

@@ -9,7 +9,7 @@
     "resolveJsonModule": true,
     // Enable stricter transpilation for better output.
     "isolatedModules": true,
-    // Add type definitions for our Vite runtime.
-    "types": ["vite/client"]
+    // Add type definitions for our Astro runtime.
+    "types": ["astro/client"]
   }
 }

examples/framework-lit/tsconfig.json

@@ -9,7 +9,7 @@
     "resolveJsonModule": true,
     // Enable stricter transpilation for better output.
     "isolatedModules": true,
-    // Add type definitions for our Vite runtime.
-    "types": ["vite/client"]
+    // Add type definitions for our Astro runtime.
+    "types": ["astro/client"]
   }
 }

examples/framework-multiple/tsconfig.json

@@ -9,7 +9,7 @@
     "resolveJsonModule": true,
     // Enable stricter transpilation for better output.
     "isolatedModules": true,
-    // Add type definitions for our Vite runtime.
-    "types": ["vite/client"]
+    // Add type definitions for our Astro runtime.
+    "types": ["astro/client"]
   }
 }

examples/framework-preact/tsconfig.json

@@ -12,7 +12,7 @@
     "resolveJsonModule": true,
     // Enable stricter transpilation for better output.
     "isolatedModules": true,
-    // Add type definitions for our Vite runtime.
-    "types": ["vite/client"]
+    // Add type definitions for our Astro runtime.
+    "types": ["astro/client"]
   }
 }

examples/framework-react/tsconfig.json

@@ -9,7 +9,7 @@
     "resolveJsonModule": true,
     // Enable stricter transpilation for better output.
     "isolatedModules": true,
-    // Add type definitions for our Vite runtime.
-    "types": ["vite/client"]
+    // Add type definitions for our Astro runtime.
+    "types": ["astro/client"]
   }
 }

examples/framework-solid/tsconfig.json

@@ -12,7 +12,7 @@
     "resolveJsonModule": true,
     // Enable stricter transpilation for better output.
     "isolatedModules": true,
-    // Add type definitions for our Vite runtime.
-    "types": ["vite/client"]
+    // Add type definitions for our Astro runtime.
+    "types": ["astro/client"]
   }
 }

examples/framework-svelte/tsconfig.json

@@ -9,7 +9,7 @@
     "resolveJsonModule": true,
     // Enable stricter transpilation for better output.
     "isolatedModules": true,
-    // Add type definitions for our Vite runtime.
-    "types": ["vite/client"]
+    // Add type definitions for our Astro runtime.
+    "types": ["astro/client"]
   }
 }

examples/framework-vue/tsconfig.json

@@ -9,7 +9,7 @@
     "resolveJsonModule": true,
     // Enable stricter transpilation for better output.
     "isolatedModules": true,
-    // Add type definitions for our Vite runtime.
-    "types": ["vite/client"]
+    // Add type definitions for our Astro runtime.
+    "types": ["astro/client"]
   }
 }

examples/integrations-playground/tsconfig.json

@@ -9,7 +9,7 @@
     "resolveJsonModule": true,
     // Enable stricter transpilation for better output.
     "isolatedModules": true,
-    // Add type definitions for our Vite runtime.
-    "types": ["vite/client"]
+    // Add type definitions for our Astro runtime.
+    "types": ["astro/client"]
   }
 }

examples/minimal/tsconfig.json

@@ -9,7 +9,7 @@
     "resolveJsonModule": true,
     // Enable stricter transpilation for better output.
     "isolatedModules": true,
-    // Add type definitions for our Vite runtime.
-    "types": ["vite/client"]
+    // Add type definitions for our Astro runtime.
+    "types": ["astro/client"]
   }
 }

examples/non-html-pages/tsconfig.json

@@ -9,7 +9,7 @@
     "resolveJsonModule": true,
     // Enable stricter transpilation for better output.
     "isolatedModules": true,
-    // Add type definitions for our Vite runtime.
-    "types": ["vite/client"]
+    // Add type definitions for our Astro runtime.
+    "types": ["astro/client"]
   }
 }

examples/portfolio/tsconfig.json

@@ -9,7 +9,7 @@
     "resolveJsonModule": true,
     // Enable stricter transpilation for better output.
     "isolatedModules": true,
-    // Add type definitions for our Vite runtime.
-    "types": ["vite/client"]
+    // Add type definitions for our Astro runtime.
+    "types": ["astro/client"]
   }
 }

examples/ssr/tsconfig.json

@@ -9,7 +9,7 @@
     "resolveJsonModule": true,
     // Enable stricter transpilation for better output.
     "isolatedModules": true,
-    // Add type definitions for our Vite runtime.
-    "types": ["vite/client"]
+    // Add type definitions for our Astro runtime.
+    "types": ["astro/client"]
   }
 }

examples/starter/tsconfig.json

@@ -9,7 +9,7 @@
     "resolveJsonModule": true,
     // Enable stricter transpilation for better output.
     "isolatedModules": true,
-    // Add type definitions for our Vite runtime.
-    "types": ["vite/client"]
+    // Add type definitions for our Astro runtime.
+    "types": ["astro/client"]
   }
 }

examples/subpath/tsconfig.json

@@ -9,7 +9,7 @@
     "resolveJsonModule": true,
     // Enable stricter transpilation for better output.
     "isolatedModules": true,
-    // Add type definitions for our Vite runtime.
-    "types": ["vite/client"]
+    // Add type definitions for our Astro runtime.
+    "types": ["astro/client"]
   }
 }

examples/with-markdown-plugins/tsconfig.json

@@ -9,7 +9,7 @@
     "resolveJsonModule": true,
     // Enable stricter transpilation for better output.
     "isolatedModules": true,
-    // Add type definitions for our Vite runtime.
-    "types": ["vite/client"]
+    // Add type definitions for our Astro runtime.
+    "types": ["astro/client"]
   }
 }

examples/with-markdown-shiki/tsconfig.json

@@ -9,7 +9,7 @@
     "resolveJsonModule": true,
     // Enable stricter transpilation for better output.
     "isolatedModules": true,
-    // Add type definitions for our Vite runtime.
-    "types": ["vite/client"]
+    // Add type definitions for our Astro runtime.
+    "types": ["astro/client"]
   }
 }

examples/with-markdown/tsconfig.json

@@ -9,7 +9,7 @@
     "resolveJsonModule": true,
     // Enable stricter transpilation for better output.
     "isolatedModules": true,
-    // Add type definitions for our Vite runtime.
-    "types": ["vite/client"]
+    // Add type definitions for our Astro runtime.
+    "types": ["astro/client"]
   }
 }

examples/with-mdx/tsconfig.json

@@ -9,7 +9,7 @@
     "resolveJsonModule": true,
     // Enable stricter transpilation for better output.
     "isolatedModules": true,
-    // Add type definitions for our Vite runtime.
-    "types": ["vite/client"]
+    // Add type definitions for our Astro runtime.
+    "types": ["astro/client"]
   }
 }

examples/with-nanostores/tsconfig.json

@@ -9,7 +9,7 @@
     "resolveJsonModule": true,
     // Enable stricter transpilation for better output.
     "isolatedModules": true,
-    // Add type definitions for our Vite runtime.
-    "types": ["vite/client"]
+    // Add type definitions for our Astro runtime.
+    "types": ["astro/client"]
   }
 }

examples/with-tailwindcss/tsconfig.json

@@ -9,7 +9,7 @@
     "resolveJsonModule": true,
     // Enable stricter transpilation for better output.
     "isolatedModules": true,
-    // Add type definitions for our Vite runtime.
-    "types": ["vite/client"]
+    // Add type definitions for our Astro runtime.
+    "types": ["astro/client"]
   }
 }

examples/with-vite-plugin-pwa/tsconfig.json

@@ -9,7 +9,7 @@
     "resolveJsonModule": true,
     // Enable stricter transpilation for better output.
     "isolatedModules": true,
-    // Add type definitions for our Vite runtime.
-    "types": ["vite/client"]
+    // Add type definitions for our Astro runtime.
+    "types": ["astro/client"]
   }
 }

packages/astro/client.d.ts

@@ -0,0 +1,207 @@
+/// <reference types="vite/types/importMeta" />
+
+// CSS modules
+type CSSModuleClasses = { readonly [key: string]: string }
+
+declare module '*.module.css' {
+  const classes: CSSModuleClasses
+  export default classes
+}
+declare module '*.module.scss' {
+  const classes: CSSModuleClasses
+  export default classes
+}
+declare module '*.module.sass' {
+  const classes: CSSModuleClasses
+  export default classes
+}
+declare module '*.module.less' {
+  const classes: CSSModuleClasses
+  export default classes
+}
+declare module '*.module.styl' {
+  const classes: CSSModuleClasses
+  export default classes
+}
+declare module '*.module.stylus' {
+  const classes: CSSModuleClasses
+  export default classes
+}
+declare module '*.module.pcss' {
+  const classes: CSSModuleClasses
+  export default classes
+}
+
+// CSS
+declare module '*.css' {
+  const css: string
+  export default css
+}
+declare module '*.scss' {
+  const css: string
+  export default css
+}
+declare module '*.sass' {
+  const css: string
+  export default css
+}
+declare module '*.less' {
+  const css: string
+  export default css
+}
+declare module '*.styl' {
+  const css: string
+  export default css
+}
+declare module '*.stylus' {
+  const css: string
+  export default css
+}
+declare module '*.pcss' {
+  const css: string
+  export default css
+}
+
+// Built-in asset types
+// see `src/constants.ts`
+
+// images
+declare module '*.jpg' {
+  const src: string
+  export default src
+}
+declare module '*.jpeg' {
+  const src: string
+  export default src
+}
+declare module '*.png' {
+  const src: string
+  export default src
+}
+declare module '*.gif' {
+  const src: string
+  export default src
+}
+declare module '*.svg' {
+  const src: string
+  export default src
+}
+declare module '*.ico' {
+  const src: string
+  export default src
+}
+declare module '*.webp' {
+  const src: string
+  export default src
+}
+declare module '*.avif' {
+  const src: string
+  export default src
+}
+
+// media
+declare module '*.mp4' {
+  const src: string
+  export default src
+}
+declare module '*.webm' {
+  const src: string
+  export default src
+}
+declare module '*.ogg' {
+  const src: string
+  export default src
+}
+declare module '*.mp3' {
+  const src: string
+  export default src
+}
+declare module '*.wav' {
+  const src: string
+  export default src
+}
+declare module '*.flac' {
+  const src: string
+  export default src
+}
+declare module '*.aac' {
+  const src: string
+  export default src
+}
+
+// fonts
+declare module '*.woff' {
+  const src: string
+  export default src
+}
+declare module '*.woff2' {
+  const src: string
+  export default src
+}
+declare module '*.eot' {
+  const src: string
+  export default src
+}
+declare module '*.ttf' {
+  const src: string
+  export default src
+}
+declare module '*.otf' {
+  const src: string
+  export default src
+}
+
+// other
+declare module '*.wasm' {
+  const initWasm: (options: WebAssembly.Imports) => Promise<WebAssembly.Exports>
+  export default initWasm
+}
+declare module '*.webmanifest' {
+  const src: string
+  export default src
+}
+declare module '*.pdf' {
+  const src: string
+  export default src
+}
+declare module '*.txt' {
+  const src: string
+  export default src
+}
+
+// web worker
+declare module '*?worker' {
+  const workerConstructor: {
+    new (): Worker
+  }
+  export default workerConstructor
+}
+
+declare module '*?worker&inline' {
+  const workerConstructor: {
+    new (): Worker
+  }
+  export default workerConstructor
+}
+
+declare module '*?sharedworker' {
+  const sharedWorkerConstructor: {
+    new (): SharedWorker
+  }
+  export default sharedWorkerConstructor
+}
+
+declare module '*?raw' {
+  const src: string
+  export default src
+}
+
+declare module '*?url' {
+  const src: string
+  export default src
+}
+
+declare module '*?inline' {
+  const src: string
+  export default src
+}

packages/astro/env.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="vite/client" />
+/// <reference path="./client.d.ts" />
 
 type Astro = import('astro').AstroGlobal;
 

packages/astro/package.json

@@ -26,6 +26,7 @@
   "exports": {
     ".": "./astro.js",
     "./env": "./env.d.ts",
+    "./client": "./client.d.ts",
     "./astro-jsx": "./astro-jsx.d.ts",
     "./jsx/*": "./dist/jsx/*",
     "./jsx-runtime": "./dist/jsx-runtime/index.js",
@@ -63,6 +64,7 @@
     "config.d.ts",
     "config.mjs",
     "env.d.ts",
+    "client.d.ts",
     "astro-jsx.d.ts",
     "README.md",
     "vendor"

packages/astro/src/runtime/client/hmr.ts

@@ -1,3 +1,4 @@
+/// <reference types="vite/client" />
 if (import.meta.hot) {
 	import.meta.hot.accept((mod) => mod);
 

packages/astro/tsconfig.json

@@ -7,6 +7,6 @@
     "module": "ES2020",
     "outDir": "./dist",
     "target": "ES2020",
-    "types": ["vite/client"]
+    "types": ["./client"]
   }
 }