Add sort order for facet values for Meilisearch v1.3 (#1536)

* Add sort order for facet values for Meilisearch v1.3 * Change type casting of the settings object in settings tests
meilisearch · Jul 10, 2023 · 4338c47 · 4338c47
1 parent 15c183c
commit 4338c47
Show file tree

Hide file tree

Showing 5 changed files with 875 additions and 130 deletions.
diff --git a/src/types/types.ts b/src/types/types.ts
@@ -255,9 +255,13 @@ export type TypoTolerance = {
   }
 } | null
 
+export type FacetOrder = 'alpha' | 'count'
+
 export type Faceting = {
   maxValuesPerFacet?: number | null
+  sortFacetValuesBy?: Record<string, FacetOrder> | null
 }
+
 export type PaginationSettings = {
   maxTotalHits?: number | null
 }

diff --git a/tests/__snapshots__/faceting.test.ts.snap b/tests/__snapshots__/faceting.test.ts.snap
@@ -0,0 +1,75 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Test on faceting Admin key: Get default faceting object 1`] = `
+Object {
+  "maxValuesPerFacet": 100,
+  "sortFacetValuesBy": Object {
+    "*": "alpha",
+  },
+}
+`;
+
+exports[`Test on faceting Admin key: Reset faceting 1`] = `
+Object {
+  "maxValuesPerFacet": 100,
+  "sortFacetValuesBy": Object {
+    "*": "alpha",
+  },
+}
+`;
+
+exports[`Test on faceting Admin key: Update faceting at null 1`] = `
+Object {
+  "maxValuesPerFacet": 100,
+  "sortFacetValuesBy": Object {
+    "*": "alpha",
+  },
+}
+`;
+
+exports[`Test on faceting Admin key: Update faceting settings 1`] = `
+Object {
+  "maxValuesPerFacet": 12,
+  "sortFacetValuesBy": Object {
+    "*": "alpha",
+    "test": "count",
+  },
+}
+`;
+
+exports[`Test on faceting Master key: Get default faceting object 1`] = `
+Object {
+  "maxValuesPerFacet": 100,
+  "sortFacetValuesBy": Object {
+    "*": "alpha",
+  },
+}
+`;
+
+exports[`Test on faceting Master key: Reset faceting 1`] = `
+Object {
+  "maxValuesPerFacet": 100,
+  "sortFacetValuesBy": Object {
+    "*": "alpha",
+  },
+}
+`;
+
+exports[`Test on faceting Master key: Update faceting at null 1`] = `
+Object {
+  "maxValuesPerFacet": 100,
+  "sortFacetValuesBy": Object {
+    "*": "alpha",
+  },
+}
+`;
+
+exports[`Test on faceting Master key: Update faceting settings 1`] = `
+Object {
+  "maxValuesPerFacet": 12,
+  "sortFacetValuesBy": Object {
+    "*": "alpha",
+    "test": "count",
+  },
+}
+`;