Merge pull request #176 from vilhelmjosander/feature/add-fetch-transp…

…orter

Add option to enable requester-fetch instead of requester-node-http for edge-environments like Cloudflare Workers

docs/content/1.getting-started/2.configuration.md

@@ -37,7 +37,8 @@ Defaults:
   globalIndex: '',
   lite: true,
   cache: false,
-  instantSearch: true,
+  instantSearch: true, 
+  useFetch: false,
   crawler: {
     apiKey: '<YOUR_API_KEY>',
     indexName: '<YOUR_INDEX_NAME>',
@@ -94,6 +95,11 @@ By default set to false. The client caches requests to Algolia and their respons
 More information available in the official [Algolia docs](https://www.algolia.com/doc/api-client/getting-started/customize/javascript/?client=javascript#caching-requests-and-responses).
 ::
 
+### `useFetch`
+
+By default set to false. If set to true, it will use @algolia/requester-fetch instead of @algolia/requester-node-http. This enables SSR-support for using this module in V8-based environments like Vercel Edge, Cloudflare Workers etc.
+
+
 ### `instantSearch`
 
 By default set to false. Indicates whether to install the official [vue-instantsearch](https://github.com/algolia/vue-instantsearch) plugin. This option can also be an object (see below).

package.json

@@ -35,6 +35,7 @@
     "lint": "eslint --ext .js,.ts,.vue"
   },
   "dependencies": {
+    "@algolia/requester-fetch": "^4.20.0",
     "@algolia/cache-in-memory": "^4.14.2",
     "@algolia/recommend": "^4.12.2",
     "@nuxt/kit": "^3.7.0",

src/module.ts

@@ -37,6 +37,7 @@ export default defineNuxtModule<ModuleOptions>({
     cache: false,
     instantSearch: false,
     docSearch: {},
+    useFetch: false,
     crawler: {
       apiKey: '',
       indexName: '',
@@ -113,7 +114,8 @@ export default defineNuxtModule<ModuleOptions>({
         instantSearch: options.instantSearch,
         docSearch: options.docSearch,
         recommend: options.recommend,
-        globalIndex: options.globalIndex
+        globalIndex: options.globalIndex,
+        useFetch: options.useFetch
       })
     }
     // Nuxt 3
@@ -128,7 +130,8 @@ export default defineNuxtModule<ModuleOptions>({
       instantSearch: options.instantSearch,
       docSearch: options.docSearch,
       recommend: options.recommend,
-      globalIndex: options.globalIndex
+      globalIndex: options.globalIndex,
+      useFetch: options.useFetch
     })
 
     if (options.instantSearch) {

src/runtime/composables/useAlgoliaSearch.ts

@@ -27,7 +27,11 @@ export function useAlgoliaSearch (indexName?: string) {
   const search = async ({ query, requestOptions }: SearchParams) => {
     if (process.server) {
       const nuxtApp = useNuxtApp()
-      nuxtApp.$algolia.transporter.requester = (await import('@algolia/requester-node-http').then(lib => lib.default || lib)).createNodeHttpRequester()
+      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()
+      }
     }
 
     const searchResult = await algoliaIndex.search(query, requestOptions)

src/runtime/composables/useAsyncAlgoliaSearch.ts

@@ -16,7 +16,11 @@ export async function useAsyncAlgoliaSearch ({ query, requestOptions, indexName,
   const result = await useAsyncData(`${index}-async-search-result-${key ?? ''}`, async () => {
     if (process.server) {
       const nuxtApp = useNuxtApp()
-      nuxtApp.$algolia.transporter.requester = (await import('@algolia/requester-node-http').then(lib => lib.default || lib)).createNodeHttpRequester()
+      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()
+      }
     }
     return await algoliaIndex.search(query, requestOptions)
   })

src/types.ts

@@ -1002,4 +1002,5 @@ export interface ModuleBaseOptions {
   recommend?: boolean;
   docSearch?: Partial<DocSearchOptions>;
   indexer?: Indexer;
+  useFetch?: boolean;
 }