fix: better types and ensure works with crawlLinks enabled

Author: yassilah

playground/nuxt.config.ts

@@ -5,6 +5,9 @@ export default defineNuxtConfig({
     AlgoliaModule
   ],
   nitro: {
+    prerender: {
+      crawlLinks: true
+    },
     routeRules: {
       '/': {
         prerender: true

playground/pages/index.vue

@@ -15,6 +15,9 @@
       <h3>DocSearch plugin</h3>
       <AlgoliaDocSearch :options="docSearch" />
     </div>
+    <NuxtLink to="/other-page">
+      Other page
+    </NuxtLink>
   </div>
 </template>
 

playground/pages/other-page.vue

@@ -0,0 +1,15 @@
+<script setup lang="ts">
+import { useSeoMeta } from '@unhead/vue'
+
+useHead({
+  title: 'Other Page'
+})
+
+useSeoMeta({
+  description: 'Dolore amet culpa culpa dolore cupidatat dolor magna amet elit aute qui proident. Eu ea aliquip ipsum est. Incididunt aliqua in consequat reprehenderit adipisicing id laboris eiusmod voluptate laboris tempor ullamco ipsum. Mollit culpa non dolore aute deserunt eiusmod pariatur enim sunt aute consequat quis. Quis sint enim consectetur velit ex ullamco. Dolor non aliqua elit anim reprehenderit ut sit ullamco nulla ut consectetur. Occaecat sit fugiat id consectetur nostrud aute dolore anim ex irure.'
+})
+</script>
+
+<template>
+  <div />
+</template>

src/hooks/crawler.ts

@@ -1,21 +1,32 @@
 
-import type { Nuxt, NuxtHooks } from '@nuxt/schema'
 import algoliasearch from 'algoliasearch'
 import scraper from 'metadata-scraper'
 import type { SearchClient, SearchIndex } from 'algoliasearch'
 import type { MetaData } from 'metadata-scraper/lib/types'
+import { Nuxt } from '@nuxt/schema'
 import type { ModuleOptions } from './../module'
 
-// TODO: Nuxt 2 only
-// export type GeneratePageArg = Parameters<NuxtHooks['generate:page']>[0]
-export type GeneratePageArg = any
-
 export type CrawlerPage = { href: string } & MetaData
 
+type CrawlerMetaGetter = ((html: string, route: string) => MetaData | Promise<MetaData>)
+type CrawlerIncludeFilter = ((route: string) => boolean)
+
+export interface CrawlerOptions {
+  apiKey: string;
+  indexName: string;
+  meta?: CrawlerMetaGetter | (keyof MetaData)[]
+  include?: CrawlerIncludeFilter | (string | RegExp)[]
+}
+
+export interface CrawlerConfig extends CrawlerOptions {
+  meta: CrawlerMetaGetter
+  include: CrawlerIncludeFilter
+}
+
 /**
  * Create a function to specify which routes should be indexed.
  */
-function createShouldInclude (options: ModuleOptions) {
+function createShouldInclude (options: ModuleOptions): CrawlerIncludeFilter {
   const { include } = options.crawler
 
   return typeof include === 'function'
@@ -26,7 +37,7 @@ function createShouldInclude (options: ModuleOptions) {
 /**
  * Create a function to collect the routes' metadata.
  */
-function createMetaGetter (options: ModuleOptions) {
+function createMetaGetter (options: ModuleOptions): CrawlerMetaGetter {
   const { meta } = options.crawler
 
   if (typeof meta === 'function') {
@@ -61,7 +72,7 @@ function createDefaultMetaGetter () {
 /**
  * Create the "page:generate" hook callback to collect all the included routes' metadata.
  */
-export function createPageGenerateHook (nuxt, options: ModuleOptions, pages: CrawlerPage[]) {
+export function createPageGenerateHook (nuxt: Nuxt, options: ModuleOptions, pages: CrawlerPage[]) {
   const shouldInclude = createShouldInclude(options)
   const getMeta = createMetaGetter(options)
 
@@ -92,7 +103,7 @@ export function createPageGenerateHook (nuxt, options: ModuleOptions, pages: Cra
 /**
    * Create the "generate:done" hook callback to index the collected routes' metadata.
    */
-export function createGenerateDoneHook (nuxt, options: ModuleOptions, pages: CrawlerPage[]) {
+export function createGenerateDoneHook (nuxt: Nuxt, options: ModuleOptions, pages: CrawlerPage[]) {
   return async () => {
     if (pages.length > 0 && options.crawler) {
       const { crawler: { apiKey, indexName }, applicationId } = options
@@ -128,5 +139,5 @@ export interface CrawlerHooks {
 }
 
 declare module '@nuxt/schema' {
-  interface NuxtHooks extends CrawlerHooks {}
+  interface NuxtHooks extends CrawlerHooks { }
 }

src/module.ts

@@ -1,9 +1,8 @@
 import { resolve } from 'path'
 import { fileURLToPath } from 'url'
-import { defineNuxtModule, addPlugin, addComponentsDir, addServerHandler, addImportsDir, isNuxt2, extendViteConfig } from '@nuxt/kit'
-import type { MetaData } from 'metadata-scraper/lib/types'
+import { defineNuxtModule, addPlugin, addComponentsDir, addServerHandler, addImportsDir, isNuxt2 } from '@nuxt/kit'
 import { defu } from 'defu'
-import { createPageGenerateHook, createGenerateDoneHook, CrawlerPage, CrawlerHooks } from './hooks'
+import { createPageGenerateHook, createGenerateDoneHook, CrawlerPage, CrawlerHooks, CrawlerOptions } from './hooks'
 import type { DocSearchOptions } from './types'
 
 enum InstantSearchThemes {
@@ -34,14 +33,7 @@ interface ModuleBaseOptions {
 }
 
 export interface ModuleOptions extends ModuleBaseOptions {
-  crawler?: {
-    apiKey: string;
-    indexName: string;
-    meta:
-            | ((html: string, route: string) => MetaData|Promise<MetaData>)
-            | (keyof MetaData)[]
-    include: ((route: string) => boolean) | (string | RegExp)[]
-  }
+  crawler?: CrawlerOptions
 };
 
 export interface ModuleHooks extends CrawlerHooks {}