feat: define nitro `#storage` and `#assets` types (#1377)

packages/bridge/src/nitro.ts

@@ -129,6 +129,11 @@ export function setupNitroBridge () {
   // Add typed route responses
   nuxt.hook('prepare:types', (opts) => {
     opts.references.push({ path: resolve(nuxt.options.buildDir, 'nitro.d.ts') })
+
+    for (const stub of ['#storage', '#assets']) {
+      // The `@nuxt/nitro` types will be overwritten by packages/nitro/types/shims.d.ts
+      opts.tsConfig.compilerOptions.paths[stub] = ['@nuxt/nitro']
+    }
   })
 
   // nuxt build/dev

packages/nitro/types/shims.d.ts

@@ -5,7 +5,7 @@ declare module '#storage' {
 
 declare module '#assets' {
   export interface AssetMeta { type?: string, etag?: string, mtime?: string }
-  export function readAsset<T=any>(id: string): Promise<T>
-  export function statAsset(id: string): Promise<AssetMeta>
+  export function readAsset<T = any> (id: string): Promise<T>
+  export function statAsset (id: string): Promise<AssetMeta>
   export function getKeys() : Promise<string[]>
 }

packages/nuxi/src/utils/prepare.ts

@@ -27,7 +27,10 @@ export const writeTypes = async (nuxt: Nuxt) => {
 
   const aliases = {
     ...nuxt.options.alias,
-    '#build': nuxt.options.buildDir
+    '#build': nuxt.options.buildDir,
+    // The `@nuxt/nitro` types will be overwritten by packages/nitro/types/shims.d.ts
+    '#storage': '@nuxt/nitro',
+    '#assets': '@nuxt/nitro'
   }
 
   for (const alias in aliases) {