feat(types): add more precise typing for known query types to match known as types (#21863)

Co-authored-by: nathanhleung <nathanhleung@users.noreply.github.com>
Co-authored-by: sapphi-red <49056869+sapphi-red@users.noreply.github.com>

Author: nathanhleung

packages/vite/src/node/__tests_dts__/importGlob.ts

@@ -0,0 +1,101 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import type { Equal, ExpectTrue } from '@type-challenges/utils'
+import type { ImportGlobFunction } from '#types/importGlob'
+
+const importGlobFunction: ImportGlobFunction = () => ({})
+
+const importGlobEagerReturn = importGlobFunction('', {
+  eager: true,
+})
+
+const importGlobNonEagerReturn = importGlobFunction('', {
+  eager: false,
+})
+
+const importGlobEagerReturnWithKnownQuery = importGlobFunction('', {
+  eager: true,
+  query: '?raw',
+})
+
+const importGlobNonEagerReturnWithKnownQuery = importGlobFunction('', {
+  eager: false,
+  query: '?raw',
+})
+
+const importGlobEagerReturnWithUnknownQuery = importGlobFunction('', {
+  eager: true,
+  query: '?unknown',
+})
+
+const importGlobNonEagerReturnWithUnknownQuery = importGlobFunction('', {
+  eager: false,
+  query: '?unknown',
+})
+
+const importGlobEagerReturnWithKnownAs = importGlobFunction('', {
+  eager: true,
+  as: 'url',
+})
+
+const importGlobNonEagerReturnWithKnownAs = importGlobFunction('', {
+  eager: false,
+  as: 'url',
+})
+
+const importGlobEagerReturnWithWorkerAs = importGlobFunction('', {
+  eager: true,
+  as: 'worker',
+})
+
+const importGlobNonEagerReturnWithWorkerAs = importGlobFunction('', {
+  eager: false,
+  as: 'worker',
+})
+
+export type cases = [
+  ExpectTrue<Equal<typeof importGlobEagerReturn, Record<string, unknown>>>,
+  ExpectTrue<
+    Equal<
+      typeof importGlobNonEagerReturn,
+      Record<string, () => Promise<unknown>>
+    >
+  >,
+  ExpectTrue<
+    Equal<typeof importGlobEagerReturnWithKnownQuery, Record<string, string>>
+  >,
+  ExpectTrue<
+    Equal<
+      typeof importGlobNonEagerReturnWithKnownQuery,
+      Record<string, () => Promise<string>>
+    >
+  >,
+  ExpectTrue<
+    Equal<typeof importGlobEagerReturnWithUnknownQuery, Record<string, unknown>>
+  >,
+  ExpectTrue<
+    Equal<
+      typeof importGlobNonEagerReturnWithUnknownQuery,
+      Record<string, () => Promise<unknown>>
+    >
+  >,
+  ExpectTrue<
+    Equal<typeof importGlobEagerReturnWithKnownAs, Record<string, string>>
+  >,
+  ExpectTrue<
+    Equal<
+      typeof importGlobNonEagerReturnWithKnownAs,
+      Record<string, () => Promise<string>>
+    >
+  >,
+  ExpectTrue<
+    Equal<typeof importGlobEagerReturnWithWorkerAs, Record<string, Worker>>
+  >,
+  ExpectTrue<
+    Equal<
+      typeof importGlobNonEagerReturnWithWorkerAs,
+      Record<string, () => Promise<Worker>>
+    >
+  >,
+]
+
+export {}

packages/vite/src/node/index.ts

@@ -269,6 +269,7 @@ export type {
   ImportGlobOptions,
   GeneralImportGlobOptions,
   KnownAsTypeMap,
+  KnownQueryTypeMap,
 } from '#types/importGlob'
 export type { ChunkMetadata, CustomPluginOptionsVite } from '#types/metadata'
 

packages/vite/types/importGlob.d.ts

@@ -1,6 +1,11 @@
+// make input suggestions work
+type StringQueryType = `?${keyof KnownAsTypeMap}` | (string & {})
+type BaseQueryType = StringQueryType | Record<string, string | number | boolean>
+
 export interface ImportGlobOptions<
   Eager extends boolean,
   AsType extends string,
+  QueryType extends BaseQueryType,
 > {
   /**
    * Import type for the import url.
@@ -21,7 +26,7 @@ export interface ImportGlobOptions<
   /**
    * Custom queries
    */
-  query?: string | Record<string, string | number | boolean>
+  query?: QueryType
   /**
    * Search files also inside `node_modules/` and hidden directories (e.g. `.git/`). This might have impact on performance.
    *
@@ -34,7 +39,18 @@ export interface ImportGlobOptions<
   base?: string
 }
 
-export type GeneralImportGlobOptions = ImportGlobOptions<boolean, string>
+export type ImportGlobOptionsWithoutAs<
+  Eager extends boolean,
+  QueryType extends BaseQueryType,
+> = Omit<ImportGlobOptions<Eager, string, QueryType>, 'as'> & {
+  as?: never
+}
+
+export type GeneralImportGlobOptions = ImportGlobOptions<
+  boolean,
+  string,
+  BaseQueryType
+>
 
 /**
  * Declare Worker in case DOM is not added to the tsconfig lib causing
@@ -52,19 +68,41 @@ export interface KnownAsTypeMap {
   worker: Worker
 }
 
+type KnownQueryTypeMap = {
+  [K in keyof KnownAsTypeMap as `?${K}`]: KnownAsTypeMap[K]
+}
+
 export interface ImportGlobFunction {
   /**
    * Import a list of files with a glob pattern.
    *
-   * Overload 1: No generic provided, infer the type from `eager` and `as`
+   * Overload 1A: No generic provided, infer the type from `eager` and `query`
+   */
+  <
+    Eager extends boolean,
+    Query extends BaseQueryType,
+    T = Query extends keyof KnownQueryTypeMap
+      ? KnownQueryTypeMap[Query]
+      : unknown,
+  >(
+    glob: string | string[],
+    options?: ImportGlobOptionsWithoutAs<Eager, Query>,
+  ): (Eager extends true ? true : false) extends true
+    ? Record<string, T>
+    : Record<string, () => Promise<T>>
+  /**
+   * Import a list of files with a glob pattern.
+   *
+   * Overload 1B: No generic provided, infer the type from `eager` and `as`
+   * (deprecated, use `query` instead)
    */
   <
     Eager extends boolean,
     As extends string,
     T = As extends keyof KnownAsTypeMap ? KnownAsTypeMap[As] : unknown,
   >(
     glob: string | string[],
-    options?: ImportGlobOptions<Eager, As>,
+    options?: ImportGlobOptions<Eager, As, BaseQueryType>,
   ): (Eager extends true ? true : false) extends true
     ? Record<string, T>
     : Record<string, () => Promise<T>>
@@ -75,7 +113,7 @@ export interface ImportGlobFunction {
    */
   <M>(
     glob: string | string[],
-    options?: ImportGlobOptions<false, string>,
+    options?: ImportGlobOptions<false, string, BaseQueryType>,
   ): Record<string, () => Promise<M>>
   /**
    * Import a list of files with a glob pattern.
@@ -84,6 +122,6 @@ export interface ImportGlobFunction {
    */
   <M>(
     glob: string | string[],
-    options: ImportGlobOptions<true, string>,
+    options: ImportGlobOptions<true, string, BaseQueryType>,
   ): Record<string, M>
 }