Merge pull request #222 from nuxt-modules/chore/1.11.0

Baroshem · web-flow · commit 3068c097be37 · 2025-03-19T14:47:35.000+01:00
chore: 1.11.0
diff --git a/docs/content/1.getting-started/2.configuration.md b/docs/content/1.getting-started/2.configuration.md
@@ -51,7 +51,8 @@ Defaults:
       secret: 'INDEXER_SECRET',
       algoliaAdminApiKey: 'ALGOLIA_ADMIN_KEY',
       indexName: 'ALGOLIA_INDEX_NAME',
-      accessToken: 'STORYBLOK_ACCESS_TOKEN'
+      accessToken: 'STORYBLOK_ACCESS_TOKEN',
+      contentVersion: 'draft'
     }
   }
 }
diff --git a/docs/content/2.advanced/3.indexer.md b/docs/content/2.advanced/3.indexer.md
@@ -24,7 +24,8 @@ export default defineNuxtConfig({
         secret: process.env.INDEXER_SECRET,
         algoliaAdminApiKey: process.env.ALGOLIA_ADMIN_KEY,
         indexName: process.env.ALGOLIA_INDEX_NAME,
-        accessToken: process.env.STORYBLOK_ACCESS_TOKEN
+        accessToken: process.env.STORYBLOK_ACCESS_TOKEN,
+        contentVersion: process.env.STORYBLOK_CONTENT_VERSION
       }
     }
 })
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@nuxtjs/algolia",
-  "version": "1.10.2",
+  "version": "1.11.2",
   "description": "Algolia module for Nuxt",
   "repository": {
     "type": "git",
@@ -38,10 +38,14 @@
     "@algolia/cache-in-memory": "^4.14.2",
     "@algolia/recommend": "^4.12.2",
     "@algolia/requester-fetch": "^4.23.2",
+    "@algolia/requester-node-http": "^5.21.0",
     "@nuxt/kit": "^3.7.0",
     "algoliasearch": "^4.11.0",
+    "defu": "^6.1.4",
+    "exsolve": "^1.0.4",
     "instantsearch.css": "^7.4.5",
     "metadata-scraper": "^0.2.49",
+    "mocked-exports": "^0.1.1",
     "storyblok-algolia-indexer": "^1.1.0",
     "vue-instantsearch": "^4.3.2"
   },
@@ -51,7 +55,7 @@
     "@nuxt/module-builder": "latest",
     "@nuxtjs/eslint-config-typescript": "latest",
     "eslint": "latest",
-    "nuxt": "^3.8.0",
+    "nuxt": "^3.16.0",
     "standard-version": "^9.3.2",
     "typescript": "^5.2.2"
   },
@@ -70,5 +74,6 @@
     "docsearch",
     "nuxt",
     "module"
-  ]
+  ],
+  "packageManager": "yarn@1.22.22+sha1.ac34549e6aa8e7ead463a7407e1c7390f61a6610"
 }
diff --git a/playground/nuxt.config.ts b/playground/nuxt.config.ts
@@ -1,9 +1,8 @@
-import AlgoliaModule from '..'
-
 export default defineNuxtConfig({
   modules: [
-    AlgoliaModule
+    '../src/module'
   ],
+
   nitro: {
     prerender: {
       crawlLinks: true
@@ -14,9 +13,10 @@ export default defineNuxtConfig({
       }
     }
   },
+
   algolia: {
-    apiKey: process.env.ALGOLIA_API_KEY ?? '599cec31baffa4868cae4e79f180729b',
-    applicationId: process.env.ALGOLIA_APPLICATION_ID ?? 'R2IYF7ETH7',
+    apiKey: process.env.ALGOLIA_API_KEY ?? '0fd1c4eba2f831788333e77c9d855f1d',
+    applicationId: process.env.ALGOLIA_APPLICATION_ID ?? 'AGN9HUEKF3',
     lite: false, // by default set to 'true'
     cache: true,
     docSearch: {
@@ -31,12 +31,15 @@ export default defineNuxtConfig({
         secret: process.env.INDEXER_SECRET,
         algoliaAdminApiKey: process.env.ALGOLIA_ADMIN_KEY,
         indexName: process.env.ALGOLIA_INDEX_NAME,
-        accessToken: process.env.STORYBLOK_ACCESS_TOKEN
+        accessToken: process.env.STORYBLOK_ACCESS_TOKEN,
+        contentVersion: process.env.STORYBLOK_CONTENT_VERSION
       }
     },
     crawler: {
       apiKey: process.env.ALGOLIA_CRAWLER_API_KEY,
       indexName: process.env.ALGOLIA_CRAWLER_INDEX_NAME
     }
-  }
-})
+  },
+
+  compatibilityDate: '2025-03-19'
+})
diff --git a/playground/pages/index.vue b/playground/pages/index.vue
@@ -22,7 +22,7 @@
 </template>
 
 <script lang="ts" setup>
-import { useSeoMeta } from '@unhead/vue'
+import { useSeoMeta } from '#imports'
 import { AisInstantSearch, AisSearchBox, AisHits } from 'vue-instantsearch/vue3/es'
 // Used to try the refresh of the component on options changes
 const indexName = ref('test_index')
diff --git a/playground/pages/other-page.vue b/playground/pages/other-page.vue
@@ -1,5 +1,5 @@
 <script setup lang="ts">
-import { useSeoMeta } from '@unhead/vue'
+import { useSeoMeta } from '#imports'
 
 useHead({
   title: 'Other Page'
diff --git a/renovate.json b/renovate.json
@@ -1,5 +1,6 @@
 {
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
   "extends": [
-    "@nuxtjs"
+    "github>nuxt/renovate-config-nuxt"
   ]
-}
+}
diff --git a/src/module.ts b/src/module.ts
@@ -5,6 +5,7 @@ import { defu } from 'defu'
 import { createPageGenerateHook, createGenerateDoneHook } from './hooks'
 import type { CrawlerPage, CrawlerHooks, CrawlerOptions } from './hooks'
 import { InstantSearchThemes, type ModuleBaseOptions } from './types'
+import { resolveModulePath } from 'exsolve'
 
 const MODULE_NAME = '@nuxtjs/algolia'
 const logger = useLogger(MODULE_NAME)
@@ -26,7 +27,7 @@ export default defineNuxtModule<ModuleOptions>({
     name: '@nuxtjs/algolia',
     configKey: 'algolia',
     compatibility: {
-      nuxt: '^3.0.0-rc.9 || ^2.16.0',
+      nuxt: '>=3.0.0-rc.9 || ^2.16.0',
       bridge: true
     }
   },
@@ -52,12 +53,9 @@ export default defineNuxtModule<ModuleOptions>({
 
     const notRunningInPrepareScript = !nuxt.options._prepare
 
-    if (!options.apiKey && notRunningInPrepareScript) {
-      throwError('Missing `apiKey`')
-    }
-
-    if (!options.applicationId && notRunningInPrepareScript) {
-      throwError('Missing `applicationId`')
+    if (notRunningInPrepareScript && (!options.apiKey || !options.applicationId)) {
+      console.warn('Missing `apiKey` or `applicationId` in `nuxt.config.js`')
+      return
     }
 
     if (options.crawler!.apiKey || options.crawler!.indexName) {
@@ -76,7 +74,7 @@ export default defineNuxtModule<ModuleOptions>({
 
       if (isNuxt2(nuxt)) {
         nuxt.addHooks({
-        // @ts-expect-error Nuxt 2 only hook
+        // Nuxt 2 only hook
           'generate:page': createPageGenerateHook(nuxt, options, pages),
           'generate:done': createGenerateDoneHook(nuxt, options, pages)
         })
@@ -120,7 +118,7 @@ export default defineNuxtModule<ModuleOptions>({
       })
     }
     // Nuxt 3
-    // @ts-expect-error TODO: Workaround for rc.14 only
+    // Workaround for rc.14 only
     nuxt.options.runtimeConfig.public = nuxt.options.runtimeConfig.public || {}
     // @ts-ignore
     nuxt.options.runtimeConfig.public.algolia = defu(nuxt.options.runtimeConfig.algolia, {
@@ -153,8 +151,7 @@ export default defineNuxtModule<ModuleOptions>({
     // Polyfilling server packages for SSR support
     nuxt.hook('vite:extendConfig', (config, { isClient }) => {
       if (isClient) {
-        (config as any).resolve.alias['@algolia/requester-node-http'] =
-          'unenv/runtime/mock/empty'
+        (config as any).resolve.alias['@algolia/requester-node-http'] = resolveModulePath('mocked-exports/empty', { from: import.meta.url })
       }
     })
 
diff --git a/src/runtime/composables/useAlgoliaFacetedSearch.ts b/src/runtime/composables/useAlgoliaFacetedSearch.ts
@@ -2,7 +2,7 @@
 import { computed } from 'vue'
 import type { SearchForFacetValuesResponse } from '@algolia/client-search'
 import type { ComputedRef } from 'vue'
-import { AlgoliaIndices, RequestOptionsObject } from '../../types'
+import type { AlgoliaIndices, RequestOptionsObject } from '../../types'
 import { useAlgoliaInitIndex } from './useAlgoliaInitIndex'
 import { useState } from '#imports'
 
diff --git a/src/runtime/composables/useAlgoliaRecommend.ts b/src/runtime/composables/useAlgoliaRecommend.ts
@@ -1,6 +1,6 @@
-import { RecommendationsQuery, RecommendClient } from '@algolia/recommend'
-import { ComputedRef, computed } from 'vue'
-import { RequestOptionsObject, SearchResponse } from '../../types'
+import type { RecommendationsQuery, RecommendClient } from '@algolia/recommend'
+import { type ComputedRef, computed } from 'vue'
+import type { RequestOptionsObject, SearchResponse } from '../../types'
 import { useNuxtApp, useState } from '#imports'
 
 export type RecommendParams = { queries: RecommendationsQuery[] } & RequestOptionsObject
diff --git a/src/runtime/composables/useAlgoliaSearch.ts b/src/runtime/composables/useAlgoliaSearch.ts
@@ -1,5 +1,4 @@
-/* eslint-disable no-redeclare */
-import { computed } from 'vue'
+import { computed, onUnmounted } from 'vue'
 import type { SearchResponse } from '@algolia/client-search'
 import type { ComputedRef } from 'vue'
 import type { AlgoliaIndices, RequestOptionsObject } from '../../types'
@@ -19,26 +18,26 @@ export function useAlgoliaSearch (indexName?: string) {
   const config = useRuntimeConfig()
   const index = indexName || config.public.algolia.globalIndex
 
-  if (!index) throw new Error('`[@nuxtjs/algolia]` Cannot search in Algolia without `globalIndex` or `indexName` passed as a parameter')
+  if (!index) { throw new Error('`[@nuxtjs/algolia]` Cannot search in Algolia without `globalIndex` or `indexName` passed as a parameter') }
 
   const algoliaIndex = useAlgoliaInitIndex(index)
   const result = useState(`${index}-search-result`, () => null)
 
   const search = async ({ query, requestOptions }: SearchParams) => {
     if (import.meta.server) {
       const nuxtApp = useNuxtApp()
-      if (config.public.algolia.useFetch) {
-        nuxtApp.$algolia.transporter.requester = (await import("@algolia/requester-fetch").then((lib) => lib.default || lib)).createFetchRequester();
-      } else {
-        nuxtApp.$algolia.transporter.requester = (await import('@algolia/requester-node-http').then(lib => lib.default || lib)).createNodeHttpRequester()
-      }
+      nuxtApp.$algolia.transporter.requester = (await import('@algolia/requester-fetch').then(lib => lib.default || lib)).createFetchRequester()
     }
 
     const searchResult = await algoliaIndex.search(query, requestOptions)
     result.value = searchResult
     return searchResult
   }
 
+  onUnmounted(() => {
+    result.value = null
+  })
+
   return {
     result: computed(() => result.value),
     search
diff --git a/src/runtime/composables/useAsyncAlgoliaSearch.ts b/src/runtime/composables/useAsyncAlgoliaSearch.ts
@@ -1,27 +1,22 @@
-/* eslint-disable no-redeclare */
+import type { AsyncData } from '#app'
 import type { RequestOptionsObject, SearchResponse } from '../../types'
 import { useAlgoliaInitIndex } from './useAlgoliaInitIndex'
 import { useNuxtApp, useAsyncData, useRuntimeConfig } from '#imports'
-import type { AsyncData } from '#app';
 
 export type AsyncSearchParams = { query: string, indexName?: string, key?: string } & RequestOptionsObject;
 
 export async function useAsyncAlgoliaSearch ({ query, requestOptions, indexName, key }: AsyncSearchParams): Promise<AsyncData<SearchResponse<unknown>, Error>> {
   const config = useRuntimeConfig()
   const index = indexName || config.public.algolia.globalIndex
 
-  if (!index) throw new Error('`[@nuxtjs/algolia]` Cannot search in Algolia without `indexName`')
+  if (!index) { throw new Error('`[@nuxtjs/algolia]` Cannot search in Algolia without `indexName`') }
 
   const algoliaIndex = useAlgoliaInitIndex(index)
 
   const result = await useAsyncData(`${index}-async-search-result-${key ?? ''}`, async () => {
     if (import.meta.server) {
       const nuxtApp = useNuxtApp()
-      if (config.public.algolia.useFetch) {
-        nuxtApp.$algolia.transporter.requester = (await import('@algolia/requester-fetch').then((lib) => lib.default || lib)).createFetchRequester();
-      } else {
-        nuxtApp.$algolia.transporter.requester = (await import('@algolia/requester-node-http').then(lib => lib.default || lib)).createNodeHttpRequester()
-      }
+      nuxtApp.$algolia.transporter.requester = (await import('@algolia/requester-fetch').then(lib => lib.default || lib)).createFetchRequester()
     }
     return await algoliaIndex.search(query, requestOptions)
   })
diff --git a/src/runtime/server/api/storyblok.ts b/src/runtime/server/api/storyblok.ts
@@ -14,6 +14,12 @@ export default defineEventHandler((event) => {
     algoliaApiAdminToken: config.algoliaIndexer.storyblok.algoliaAdminApiKey,
     algoliaIndexName: config.algoliaIndexer.storyblok.indexName,
     storyblokContentDeliveryApiToken: config.algoliaIndexer.storyblok.accessToken,
+    options: {
+      per_page: 100,
+      page: 1,
+      version: config.algoliaIndexer.storyblok.contentVersion || 'draft',
+      ...config.algoliaIndexer.storyblok.options
+    }
   })
 
   return 'Algolia indexed with the data from Storyblok!'
diff --git a/src/types.ts b/src/types.ts
@@ -1,4 +1,3 @@
-
 import type { DocSearchTranslations } from '@docsearch/react'
 import type { InternalDocSearchHit, StoredDocSearchHit } from '@docsearch/react/dist/esm/types'
 import type { SearchIndex } from 'algoliasearch'
@@ -628,6 +627,9 @@ export declare type Settings = {
    * This is set via the settings for a default value and can be overridden via rules
    */
   readonly renderingContent?: {
+      readonly redirect?: {
+        url?: string
+      }
       /**
        * defining how facets should be ordered
        */
@@ -973,7 +975,7 @@ export type HitComponentFunc = (props: {
   hit: InternalDocSearchHit | StoredDocSearchHit;
   // Avoid importing React types there
   children: any; // React.ReactNode;
-}) => JSX.Element
+}) => any
 
 export enum InstantSearchThemes {
   'reset',
@@ -987,6 +989,7 @@ interface Indexer {
     algoliaAdminApiKey: string,
     indexName: string,
     secret: string;
+    contentVersion: 'draft' | 'published';
   }
 }
 
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,5 +1,5 @@
 {
-  "extends": "./.nuxt/tsconfig.json",
+  "extends": "./playground/.nuxt/tsconfig.json",
   "compilerOptions": {
     "types": ["./playground/types"],
     "strict": false
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,8 @@ Defaults:`
`51`	`51`	`secret: 'INDEXER_SECRET',`
`52`	`52`	`algoliaAdminApiKey: 'ALGOLIA_ADMIN_KEY',`
`53`	`53`	`indexName: 'ALGOLIA_INDEX_NAME',`
`54`		`- accessToken: 'STORYBLOK_ACCESS_TOKEN'`
	`54`	`+ accessToken: 'STORYBLOK_ACCESS_TOKEN',`
	`55`	`+ contentVersion: 'draft'`
`55`	`56`	`}`
`56`	`57`	`}`
`57`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,8 @@ export default defineNuxtConfig({`
`24`	`24`	`secret: process.env.INDEXER_SECRET,`
`25`	`25`	`algoliaAdminApiKey: process.env.ALGOLIA_ADMIN_KEY,`
`26`	`26`	`indexName: process.env.ALGOLIA_INDEX_NAME,`
`27`		`- accessToken: process.env.STORYBLOK_ACCESS_TOKEN`
	`27`	`+ accessToken: process.env.STORYBLOK_ACCESS_TOKEN,`
	`28`	`+ contentVersion: process.env.STORYBLOK_CONTENT_VERSION`
`28`	`29`	`}`
`29`	`30`	`}`
`30`	`31`	`})`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`{`
	`2`	`+ "$schema": "https://docs.renovatebot.com/renovate-schema.json",`
`2`	`3`	`"extends": [`
`3`		`- "@nuxtjs"`
	`4`	`+ "github>nuxt/renovate-config-nuxt"`
`4`	`5`	`]`
`5`		`-}`
	`6`	`+}`