fix(type): register module hooks types (#3166)

Author: farnabaz

docs/content/docs/7.advanced/5.hooks.md

@@ -13,11 +13,9 @@ It can be used to modify the raw content from a `file` before it is transformed
 or modify the transform options.
 
 ```ts
-import type { FileBeforeParseHook } from '@nuxt/content'
-
 export default defineNuxtConfig({
   hooks: {
-    'content:file:beforeParse'(ctx: FileBeforeParseHook) {
+    'content:file:beforeParse'(ctx) {
       // ...
     }
   }
@@ -29,11 +27,9 @@ export default defineNuxtConfig({
 This hook is called after the content is parsed and before it is saved to the database.
 
 ```ts
-import type { FileAfterParseHook } from '@nuxt/content'
-
 export default defineNuxtConfig({
   hooks: {
-    'content:file:afterParse'(ctx: FileAfterParseHook) {
+    'content:file:afterParse'(ctx) {
       // ...
     }
   }

src/types/content.ts

@@ -79,3 +79,5 @@ export interface MarkdownRoot extends MDCRoot {
   props?: Record<string, unknown>
   toc?: Toc
 }
+
+export type ParsedContentFile = Record<string, unknown>

src/types/hooks.ts

@@ -0,0 +1,36 @@
+import type { ResolvedCollection } from './collection'
+import type { ContentFile, ParsedContentFile } from './content'
+import type { PathMetaOptions } from './path-meta'
+
+// Parser options interface
+interface ParserOptions {
+  pathMeta: PathMetaOptions
+  markdown: {
+    compress: boolean
+    rehypePlugins: Record<string, unknown>
+    remarkPlugins: Record<string, unknown>
+    [key: string]: unknown
+  }
+}
+
+// Hook context for beforeParse
+export interface FileBeforeParseHook {
+  file: ContentFile
+  collection: ResolvedCollection
+  parserOptions: ParserOptions
+}
+
+// Hook context for afterParse
+export interface FileAfterParseHook {
+  file: ContentFile
+  content: ParsedContentFile
+  collection: ResolvedCollection
+}
+
+// Declare module to extend Nuxt hooks
+declare module '@nuxt/schema' {
+  interface NuxtHooks {
+    'content:file:beforeParse': (ctx: FileBeforeParseHook) => Promise<void> | void
+    'content:file:afterParse': (ctx: FileAfterParseHook) => Promise<void> | void
+  }
+}

src/types/index.ts

@@ -1,4 +1,5 @@
 export type * from './collection'
+export type * from './hooks'
 export type * from './module'
 export type * from './navigation'
 export type * from './surround'

src/types/module.ts

@@ -1,9 +1,8 @@
 import type { BuiltinLanguage as ShikiLang, BuiltinTheme as ShikiTheme, LanguageRegistration, ThemeRegistrationAny, ThemeRegistrationRaw } from 'shiki'
 import type { ListenOptions } from 'listhen'
 import type { GitInfo } from '../utils/git'
-import type { ContentFile, MarkdownPlugin, TransformContentOptions } from './content'
+import type { MarkdownPlugin } from './content'
 import type { PathMetaOptions } from './path-meta'
-import type { ResolvedCollection } from './collection'
 
 export interface D1DatabaseConfig {
   type: 'd1'
@@ -197,22 +196,3 @@ export interface PublicRuntimeConfig {
     iframeMessagingAllowedOrigins?: string
   }
 }
-
-// TODO improve types
-export type ParsedContentFile = Record<string, unknown>
-
-export interface FileBeforeParseHook {
-  collection: Readonly<ResolvedCollection>
-  file: ContentFile
-  parserOptions: TransformContentOptions
-}
-export interface FileAfterParseHook {
-  collection: Readonly<ResolvedCollection>
-  file: ContentFile
-  content: ParsedContentFile
-}
-
-export interface ModuleHooks {
-  'content:file:beforeParse': (hook: FileBeforeParseHook) => void | Promise<void>
-  'content:file:afterParse': (hook: FileAfterParseHook) => void | Promise<void>
-}

src/utils/content/index.ts

@@ -9,9 +9,8 @@ import { defu } from 'defu'
 import { createOnigurumaEngine } from 'shiki/engine/oniguruma'
 import { visit } from 'unist-util-visit'
 import type { ResolvedCollection } from '../../types/collection'
-import type { FileAfterParseHook, FileBeforeParseHook, ModuleOptions } from '../../types/module'
+import type { FileAfterParseHook, FileBeforeParseHook, ModuleOptions, ContentFile, ContentTransformer } from '../../types'
 import { logger } from '../dev'
-import type { ContentFile, ContentTransformer } from '../../types'
 import { transformContent } from './transformers'
 
 let parserOptions = {
@@ -147,7 +146,6 @@ export async function createParser(collection: ResolvedCollection, nuxt?: Nuxt)
       file.extension = file.extension ?? file.path.includes('.') ? '.' + file.path.split('.').pop() : undefined
     }
     const beforeParseCtx: FileBeforeParseHook = { file, collection, parserOptions }
-    // @ts-expect-error runtime type
     await nuxt?.callHook?.('content:file:beforeParse', beforeParseCtx)
     const { file: hookedFile } = beforeParseCtx
 
@@ -183,7 +181,6 @@ export async function createParser(collection: ResolvedCollection, nuxt?: Nuxt)
     }
 
     const afterParseCtx: FileAfterParseHook = { file: hookedFile, content: result, collection }
-    // @ts-expect-error runtime type
     await nuxt?.callHook?.('content:file:afterParse', afterParseCtx)
     return afterParseCtx.content
   }