@meilisearch/instant-meilisearch/src/adapter/search-response-adapter/hits-adapter.ts

The search client to use Meilisearch with InstantSearch.

import type {
  PaginationState,
  MeilisearchMultiSearchResult,
  InstantMeiliSearchConfig,
} from '../../types/index.js'
import { adaptFormattedFields } from './format-adapter/index.js'
import { adaptGeoResponse } from './geo-reponse-adapter.js'

/**
 * @param {MeilisearchMultiSearchResult} searchResult
 * @param {SearchContext} searchContext
 * @returns {Record<string, any>[]}
 */
export function adaptHits(
  searchResponse: MeilisearchMultiSearchResult & {
    pagination: PaginationState
  },
  config: InstantMeiliSearchConfig
): any {
  const { hits } = searchResponse
  const { hitsPerPage, page } = searchResponse.pagination
  const { finitePagination, primaryKey } = config // Needs: finite, hitsPerPage

  // if the length of the hits is bigger than the hitsPerPage
  // It means that there is still pages to come as we append limit by hitsPerPage + 1
  // In which case we still need to remove the additional hit returned by Meilisearch
  if (!finitePagination && hits.length > hitsPerPage) {
    hits.splice(hits.length - 1, 1)
  }

  let adaptedHits = hits.map((hit: Record<string, any>, hitIndex: number) => {
    // Creates Hit object compliant with InstantSearch
    if (Object.keys(hit).length > 0) {
      const {
        _formatted: formattedHit,
        _matchesPosition,
        ...documentFields
      } = hit

      const adaptedHit: Record<string, any> = Object.assign(
        documentFields,
        adaptFormattedFields(formattedHit)
      )

      if (config?.meiliSearchParams?.showMatchesPosition) {
        adaptedHit._matchesPosition = _matchesPosition
      }

      if (primaryKey) {
        adaptedHit.objectID = hit[primaryKey]
      }

      // Inject position for analytics (1-based, accounting for pagination)
      adaptedHit.__position = page * hitsPerPage + hitIndex + 1

      return adaptedHit
    }
    return hit
  })
  adaptedHits = adaptGeoResponse(adaptedHits)
  return adaptedHits
}