Update typo tolerance tests using snapshots

Author: Strift

src/indexes.ts

@@ -963,7 +963,9 @@ export class Index<T extends RecordAny = RecordAny> {
    *   settings.
    * @returns Promise containing object of the enqueued update
    */
-  updateTypoTolerance(typoTolerance: TypoTolerance): EnqueuedTaskPromise {
+  updateTypoTolerance(
+    typoTolerance: Partial<TypoTolerance> | null,
+  ): EnqueuedTaskPromise {
     return this.#httpRequestsWithTask.patch({
       path: `indexes/${this.uid}/settings/typo-tolerance`,
       body: typoTolerance,

src/types/types.ts

@@ -522,14 +522,15 @@ export type RankingRules = string[] | null;
 export type StopWords = string[] | null;
 export type Synonyms = Record<string, string[]> | null;
 export type TypoTolerance = {
-  enabled?: boolean | null;
-  disableOnAttributes?: string[] | null;
-  disableOnWords?: string[] | null;
-  minWordSizeForTypos?: {
-    oneTypo?: number | null;
-    twoTypos?: number | null;
+  enabled: boolean;
+  disableOnAttributes: string[];
+  disableOnNumbers: boolean;
+  disableOnWords: string[];
+  minWordSizeForTypos: {
+    oneTypo: number;
+    twoTypos: number;
   };
-} | null;
+};
 export type SeparatorTokens = string[] | null;
 export type NonSeparatorTokens = string[] | null;
 export type Dictionary = string[] | null;

tests/__snapshots__/typo_tolerance.test.ts.snap

@@ -0,0 +1,79 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`Tests on typo tolerance > Admin key: Get default typo tolerance settings 1`] = `
+{
+  "disableOnAttributes": [],
+  "disableOnNumbers": false,
+  "disableOnWords": [],
+  "enabled": true,
+  "minWordSizeForTypos": {
+    "oneTypo": 5,
+    "twoTypos": 9,
+  },
+}
+`;
+
+exports[`Tests on typo tolerance > Admin key: Reset typo tolerance settings 1`] = `
+{
+  "disableOnAttributes": [],
+  "disableOnNumbers": false,
+  "disableOnWords": [],
+  "enabled": true,
+  "minWordSizeForTypos": {
+    "oneTypo": 5,
+    "twoTypos": 9,
+  },
+}
+`;
+
+exports[`Tests on typo tolerance > Admin key: Update typo tolerance using null as value 1`] = `
+{
+  "disableOnAttributes": [],
+  "disableOnNumbers": false,
+  "disableOnWords": [],
+  "enabled": true,
+  "minWordSizeForTypos": {
+    "oneTypo": 5,
+    "twoTypos": 9,
+  },
+}
+`;
+
+exports[`Tests on typo tolerance > Master key: Get default typo tolerance settings 1`] = `
+{
+  "disableOnAttributes": [],
+  "disableOnNumbers": false,
+  "disableOnWords": [],
+  "enabled": true,
+  "minWordSizeForTypos": {
+    "oneTypo": 5,
+    "twoTypos": 9,
+  },
+}
+`;
+
+exports[`Tests on typo tolerance > Master key: Reset typo tolerance settings 1`] = `
+{
+  "disableOnAttributes": [],
+  "disableOnNumbers": false,
+  "disableOnWords": [],
+  "enabled": true,
+  "minWordSizeForTypos": {
+    "oneTypo": 5,
+    "twoTypos": 9,
+  },
+}
+`;
+
+exports[`Tests on typo tolerance > Master key: Update typo tolerance using null as value 1`] = `
+{
+  "disableOnAttributes": [],
+  "disableOnNumbers": false,
+  "disableOnWords": [],
+  "enabled": true,
+  "minWordSizeForTypos": {
+    "oneTypo": 5,
+    "twoTypos": 9,
+  },
+}
+`;

tests/typo_tolerance.test.ts

@@ -13,16 +13,6 @@ const index = {
   uid: "movies_test",
 };
 
-const defaultTypoTolerance = {
-  enabled: true,
-  minWordSizeForTypos: {
-    oneTypo: 5,
-    twoTypos: 9,
-  },
-  disableOnWords: [],
-  disableOnAttributes: [],
-};
-
 afterAll(() => {
   return clearAllIndexes(config);
 });
@@ -39,7 +29,7 @@ describe.each([{ permission: "Master" }, { permission: "Admin" }])(
     test(`${permission} key: Get default typo tolerance settings`, async () => {
       const client = await getClient(permission);
       const response = await client.index(index.uid).getTypoTolerance();
-      expect(response).toEqual(defaultTypoTolerance);
+      expect(response).toMatchSnapshot();
     });
 
     test(`${permission} key: Update typo tolerance settings`, async () => {
@@ -52,14 +42,14 @@ describe.each([{ permission: "Master" }, { permission: "Admin" }])(
         },
         disableOnWords: ["title"],
         disableOnAttributes: ["hello"],
+        disableOnNumbers: true,
       };
       await client
         .index(index.uid)
         .updateTypoTolerance(newTypoTolerance)
         .waitTask();
 
       const response = await client.index(index.uid).getTypoTolerance();
-
       expect(response).toEqual(newTypoTolerance);
     });
 
@@ -69,7 +59,7 @@ describe.each([{ permission: "Master" }, { permission: "Admin" }])(
 
       const response = await client.index(index.uid).getTypoTolerance();
 
-      expect(response).toEqual(defaultTypoTolerance);
+      expect(response).toMatchSnapshot();
     });
 
     test(`${permission} key: Reset typo tolerance settings`, async () => {
@@ -78,7 +68,7 @@ describe.each([{ permission: "Master" }, { permission: "Admin" }])(
 
       const response = await client.index(index.uid).getTypoTolerance();
 
-      expect(response).toEqual(defaultTypoTolerance);
+      expect(response).toMatchSnapshot();
     });
   },
 );