Skip to content

Commit 6667133

Browse files
bors[bot]bidoubiwa
andauthored
Merge #394
394: Change transform naming to adapt r=bidoubiwa a=bidoubiwa Adapt is a better word to what instantMeiliSearch does ![image (1)](https://user-images.githubusercontent.com/33010418/117422444-e540ac80-af1f-11eb-888e-e6c1cef2b036.png) Co-authored-by: Charlotte Vermandel <[email protected]>
2 parents 23cf7ae + c92bd5f commit 6667133

14 files changed

+22
-187
lines changed

src/transformers/__tests__/pagination.tests.ts renamed to src/adapter/__tests__/pagination.tests.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { getNumberPages, paginateHits } from '../'
1+
import { getNumberPages, paginateHits } from '..'
22
import { defaultContext } from './utils'
33

44
const numberPagesTestParameters = [
File renamed without changes.

src/transformers/index.ts renamed to src/adapter/index.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
export * from './to-meilisearch-params'
2-
export * from './to-meilisearch-filters'
32
export * from './to-instantsearch-response'
43
export * from './to-instantsearch-hits'
54
export * from './to-instantsearch-highlight'
File renamed without changes.
File renamed without changes.

src/transformers/to-instantsearch-hits.ts renamed to src/adapter/to-instantsearch-hits.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
import { TransformToISHitsm } from '../types'
1+
import { AdaptToISHitsm } from '../types'
22
import { paginateHits } from './pagination'
33
import {
44
createHighlighResult,
55
createSnippetResult,
66
} from './to-instantsearch-highlight'
77

8-
export const transformToISHits: TransformToISHitsm = function (
8+
export const adaptToISHits: AdaptToISHitsm = function (
99
meiliSearchHits,
1010
instantSearchParams,
1111
instantMeiliSearchContext

src/transformers/to-instantsearch-response.ts renamed to src/adapter/to-instantsearch-response.ts

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
import { TransformToISResponse } from '../types'
1+
import { AdaptToISResponse } from '../types'
22
import { getNumberPages } from './pagination'
3-
import { transformToISHits } from './to-instantsearch-hits'
3+
import { adaptToISHits } from './to-instantsearch-hits'
44

5-
export const transformToISResponse: TransformToISResponse = function (
5+
export const adaptToISResponse: AdaptToISResponse = function (
66
indexUid,
77
{
88
exhaustiveFacetsCount,
@@ -29,11 +29,7 @@ export const transformToISResponse: TransformToISResponse = function (
2929
nbHits,
3030
processingTimeMS: processingTimeMs,
3131
query,
32-
hits: transformToISHits(
33-
hits,
34-
instantSearchParams,
35-
instantMeiliSearchContext
36-
),
32+
hits: adaptToISHits(hits, instantSearchParams, instantMeiliSearchContext),
3733
}
3834
return {
3935
results: [ISResponse],

src/transformers/to-meilisearch-params.ts renamed to src/adapter/to-meilisearch-params.ts

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
import { TransformToMeiliSearchParams } from '../types'
2-
import { mergeFiltersAndNumericFilters } from './to-meilisearch-filters'
1+
import { AdaptToMeiliSearchParams } from '../types'
32

4-
export const transformToMeiliSearchParams: TransformToMeiliSearchParams = function (
3+
export const adaptToMeiliSearchParams: AdaptToMeiliSearchParams = function (
54
{
65
query,
76
facets,
@@ -15,7 +14,10 @@ export const transformToMeiliSearchParams: TransformToMeiliSearchParams = functi
1514
{ paginationTotalHits, placeholderSearch }
1615
) {
1716
const limit = paginationTotalHits
18-
const filter = mergeFiltersAndNumericFilters(filters, numericFilters)
17+
const filter = [numericFilters.join(' AND '), filters.trim()]
18+
.filter((x) => x)
19+
.join(' AND ')
20+
.trim()
1921

2022
// Creates search params object compliant with MeiliSearch
2123
return {

src/client/index.ts

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
11
import { MeiliSearch } from 'meilisearch'
22
import { InstantMeiliSearchOptions, InstantMeiliSearchInstance } from '../types'
33

4-
import {
5-
transformToMeiliSearchParams,
6-
transformToISResponse,
7-
} from '../transformers'
4+
import { adaptToMeiliSearchParams, adaptToISResponse } from '../adapter'
85

96
export function instantMeiliSearch(
107
hostUrl: string,
@@ -32,8 +29,9 @@ export function instantMeiliSearch(
3229
hitsPerPage: hitsPerPage === undefined ? 20 : hitsPerPage, // 20 is the MeiliSearch's default limit value. `hitsPerPage` can be changed with `InsantSearch.configure`.
3330
page: page || 0, // default page is 0 if none is provided
3431
}
35-
// Transform IS params to MeiliSearch params
36-
const msSearchParams = transformToMeiliSearchParams(
32+
33+
// Adapt IS params to MeiliSearch params
34+
const msSearchParams = adaptToMeiliSearchParams(
3735
instantSearchParams,
3836
context
3937
)
@@ -44,7 +42,7 @@ export function instantMeiliSearch(
4442
.search(msSearchParams.q, msSearchParams)
4543

4644
// Parses the MeiliSearch response and returns it for InstantSearch
47-
const ISresponse = transformToISResponse(
45+
const ISresponse = adaptToISResponse(
4846
indexUid,
4947
searchResponse,
5048
instantSearchParams,

src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
export * from './client'
2-
export * from './transformers'
2+
export * from './adapter'
33
export * from './types'

0 commit comments

Comments
 (0)