feat(nuxt3): add importMeta types for vite and webpack (#1439)

Co-authored-by: Pooya Parsa <pyapar@gmail.com>

packages/kit/src/index.ts

@@ -1,3 +1,6 @@
+// Augmentations
+import './types/global'
+
 // Config
 export * from './config/load'
 export * from './config/env'

packages/kit/src/types/global/index.ts

@@ -0,0 +1,13 @@
+import { ViteImportMeta } from './vite'
+import { WebpackImportMeta } from './webpack'
+
+export type BundlerImportMeta = ViteImportMeta & WebpackImportMeta
+
+declare global {
+  interface ImportMeta extends BundlerImportMeta {
+    /** the `file:` url of the current file (similar to `__filename` but as file url) */
+    url: string
+
+    readonly env: Record<string, string | boolean | undefined>
+  }
+}

packages/kit/src/types/global/vite.ts

@@ -0,0 +1,29 @@
+/**
+ * Reference: https://github.com/vitejs/vite/blob/main/packages/vite/types/importMeta.d.ts
+ */
+
+export interface ViteHot {
+  readonly data: any
+
+  accept (): void
+  accept (cb: (mod: any) => void): void
+  accept (dep: string, cb: (mod: any) => void): void
+  accept (deps: readonly string[], cb: (mods: any[]) => void): void
+
+  dispose (cb: (data: any) => void): void
+  decline (): void
+  invalidate (): void
+
+  on: (event: 'any', cb: (payload: any) => void) => void
+}
+
+export interface ViteImportMeta {
+  /** Vite client HMR API - see https://vitejs.dev/guide/api-hmr.html */
+  readonly hot?: ViteHot
+
+  /** vite glob import utility - https://vitejs.dev/guide/features.html#glob-import */
+  glob?(pattern: string): Record<string, () => Promise<Record<string, any>>>
+
+  /** vite glob import utility - https://vitejs.dev/guide/features.html#glob-import */
+  globeager?(pattern: string): Record<string, Record<string, any>>
+}

packages/kit/src/types/global/webpack.ts

@@ -0,0 +1,219 @@
+/**
+ * Reference: https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/webpack-env/index.d.ts
+ */
+
+export type WebpackModuleId = string | number
+
+export interface HotNotifierInfo {
+  type:
+  | 'self-declined'
+  | 'declined'
+  | 'unaccepted'
+  | 'accepted'
+  | 'disposed'
+  | 'accept-errored'
+  | 'self-accept-errored'
+  | 'self-accept-error-handler-errored'
+  /**
+   * The module in question.
+   */
+  moduleId: number
+  /**
+   * For errors: the module id owning the accept handler.
+   */
+  dependencyId?: number | undefined
+  /**
+   * For declined/accepted/unaccepted: the chain from where the update was propagated.
+   */
+  chain?: number[] | undefined
+  /**
+   * For declined: the module id of the declining parent
+   */
+  parentId?: number | undefined
+  /**
+   * For accepted: the modules that are outdated and will be disposed
+   */
+  outdatedModules?: number[] | undefined
+  /**
+   * For accepted: The location of accept handlers that will handle the update
+   */
+  outdatedDependencies?: {
+    [dependencyId: number]: number[]
+  } | undefined
+  /**
+   * For errors: the thrown error
+   */
+  error?: Error | undefined
+  /**
+   * For self-accept-error-handler-errored: the error thrown by the module
+   * before the error handler tried to handle it.
+   */
+  originalError?: Error | undefined
+}
+
+export interface AcceptOptions {
+  /**
+   * If true the update process continues even if some modules are not accepted (and would bubble to the entry point).
+   */
+  ignoreUnaccepted?: boolean | undefined
+  /**
+   * Ignore changes made to declined modules.
+   */
+  ignoreDeclined?: boolean | undefined
+  /**
+   *  Ignore errors throw in accept handlers, error handlers and while reevaluating module.
+   */
+  ignoreErrored?: boolean | undefined
+  /**
+   * Notifier for declined modules.
+   */
+  onDeclined?: ((info: HotNotifierInfo) => void) | undefined
+  /**
+   * Notifier for unaccepted modules.
+   */
+  onUnaccepted?: ((info: HotNotifierInfo) => void) | undefined
+  /**
+   * Notifier for accepted modules.
+   */
+  onAccepted?: ((info: HotNotifierInfo) => void) | undefined
+  /**
+   * Notifier for disposed modules.
+   */
+  onDisposed?: ((info: HotNotifierInfo) => void) | undefined
+  /**
+   * Notifier for errors.
+   */
+  onErrored?: ((info: HotNotifierInfo) => void) | undefined
+  /**
+   * Indicates that apply() is automatically called by check function
+   */
+  autoApply?: boolean | undefined
+}
+
+export interface WebpackHot {
+  /**
+   * Accept code updates for the specified dependencies. The callback is called when dependencies were replaced.
+   *
+   * @param dependencies
+   * @param callback
+   * @param errorHandler
+   */
+  accept (dependencies: string[], callback?: (updatedDependencies: WebpackModuleId[]) => void, errorHandler?: (err: Error) => void): void
+  /**
+   * Accept code updates for the specified dependencies. The callback is called when dependencies were replaced.
+   *
+   * @param dependency
+   * @param callback
+   * @param errorHandler
+   */
+  accept (dependency: string, callback?: () => void, errorHandler?: (err: Error) => void): void
+  /**
+   * Accept code updates for this module without notification of parents.
+   * This should only be used if the module doesn’t export anything.
+   * The errHandler can be used to handle errors that occur while loading the updated module.
+   *
+   * @param errHandler
+   */
+  accept (errHandler?: (err: Error) => void): void
+  /**
+   * Do not accept updates for the specified dependencies. If any dependencies is updated, the code update fails with code "decline".
+   */
+  decline (dependencies: string[]): void
+  /**
+   * Do not accept updates for the specified dependencies. If any dependencies is updated, the code update fails with code "decline".
+   */
+  decline (dependency: string): void
+  /**
+   * Flag the current module as not update-able. If updated the update code would fail with code "decline".
+   */
+  decline (): void
+  /**
+   * Add a one time handler, which is executed when the current module code is replaced.
+   * Here you should destroy/remove any persistent resource you have claimed/created.
+   * If you want to transfer state to the new module, add it to data object.
+   * The data will be available at module.hot.data on the new module.
+   *
+   * @param callback
+   */
+  dispose (callback: (data: any) => void): void
+  dispose (callback: <T>(data: T) => void): void
+  /**
+   * Add a one time handler, which is executed when the current module code is replaced.
+   * Here you should destroy/remove any persistent resource you have claimed/created.
+   * If you want to transfer state to the new module, add it to data object.
+   * The data will be available at module.hot.data on the new module.
+   *
+   * @param callback
+   */
+  addDisposeHandler (callback: (data: any) => void): void
+  addDisposeHandler<T> (callback: (data: T) => void): void
+  /**
+   * Remove a handler.
+   * This can useful to add a temporary dispose handler. You could i. e. replace code while in the middle of a multi-step async function.
+   *
+   * @param callback
+   */
+  removeDisposeHandler (callback: (data: any) => void): void
+  removeDisposeHandler<T> (callback: (data: T) => void): void
+  /**
+   * Throws an exceptions if status() is not idle.
+   * Check all currently loaded modules for updates and apply updates if found.
+   * If no update was found, the callback is called with null.
+   * If autoApply is truthy the callback will be called with all modules that were disposed.
+   * apply() is automatically called with autoApply as options parameter.
+   * If autoApply is not set the callback will be called with all modules that will be disposed on apply().
+   *
+   * @param autoApply
+   * @param callback
+   */
+  check (autoApply: boolean, callback: (err: Error, outdatedModules: WebpackModuleId[]) => void): void
+  /**
+   * Throws an exceptions if status() is not idle.
+   * Check all currently loaded modules for updates and apply updates if found.
+   * If no update was found, the callback is called with null.
+   * The callback will be called with all modules that will be disposed on apply().
+   *
+   * @param callback
+   */
+  check (callback: (err: Error, outdatedModules: WebpackModuleId[]) => void): void
+  /**
+   * If status() != "ready" it throws an error.
+   * Continue the update process.
+   *
+   * @param options
+   * @param callback
+   */
+  apply (options: AcceptOptions, callback: (err: Error, outdatedModules: WebpackModuleId[]) => void): void
+  /**
+   * If status() != "ready" it throws an error.
+   * Continue the update process.
+   *
+   * @param callback
+   */
+  apply (callback: (err: Error, outdatedModules: WebpackModuleId[]) => void): void
+  /**
+   * Return one of idle, check, watch, watch-delay, prepare, ready, dispose, apply, abort or fail.
+   */
+  status (): string
+  /** Register a callback on status change. */
+  status (callback: (status: string) => void): void
+  /** Register a callback on status change. */
+  addStatusHandler (callback: (status: string) => void): void
+  /**
+   * Remove a registered status change handler.
+   *
+   * @param callback
+   */
+  removeStatusHandler (callback: (status: string) => void): void
+
+  active: boolean
+  data: any
+}
+
+export interface WebpackImportMeta {
+  /** an alias for `module.hot` - see https://webpack.js.org/api/hot-module-replacement/ */
+  webpackHot?: WebpackHot | undefined
+
+  /** the webpack major version as number */
+  webpack?: number
+}