@inseefr/lunatic 3.4.7 → 3.4.8

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@inseefr/lunatic",
-    "version": "3.4.7",
+    "version": "3.4.8",
     "description": "Library of questionnaire components",
     "repository": {
         "type": "git",
@@ -457,9 +457,12 @@
         "src/utils/number.ts",
         "src/utils/object.ts",
         "src/utils/search/SearchInterface.ts",
+        "src/utils/search/SearchMiniSearch.spec.ts",
         "src/utils/search/SearchMinisearch.ts",
         "src/utils/search/SuggestersDatabase.ts",
+        "src/utils/search/melauto.spec.ts",
         "src/utils/search/melauto.ts",
+        "src/utils/search/tokenizer.spec.ts",
         "src/utils/search/tokenizer.ts",
         "src/utils/to-number.ts",
         "src/utils/variables.spec.ts",
@@ -1619,6 +1622,9 @@
         "esm/utils/search/SearchInterface.d.ts",
         "esm/utils/search/SearchInterface.js",
         "esm/utils/search/SearchInterface.js.map",
+        "esm/utils/search/SearchMiniSearch.spec.d.ts",
+        "esm/utils/search/SearchMiniSearch.spec.js",
+        "esm/utils/search/SearchMiniSearch.spec.js.map",
         "esm/utils/search/SearchMinisearch.d.ts",
         "esm/utils/search/SearchMinisearch.js",
         "esm/utils/search/SearchMinisearch.js.map",
@@ -1628,9 +1634,15 @@
         "esm/utils/search/melauto.d.ts",
         "esm/utils/search/melauto.js",
         "esm/utils/search/melauto.js.map",
+        "esm/utils/search/melauto.spec.d.ts",
+        "esm/utils/search/melauto.spec.js",
+        "esm/utils/search/melauto.spec.js.map",
         "esm/utils/search/tokenizer.d.ts",
         "esm/utils/search/tokenizer.js",
         "esm/utils/search/tokenizer.js.map",
+        "esm/utils/search/tokenizer.spec.d.ts",
+        "esm/utils/search/tokenizer.spec.js",
+        "esm/utils/search/tokenizer.spec.js.map",
         "esm/utils/to-number.d.ts",
         "esm/utils/to-number.js",
         "esm/utils/to-number.js.map",
@@ -1934,6 +1946,9 @@
         "utils/search/SearchInterface.d.ts",
         "utils/search/SearchInterface.js",
         "utils/search/SearchInterface.js.map",
+        "utils/search/SearchMiniSearch.spec.d.ts",
+        "utils/search/SearchMiniSearch.spec.js",
+        "utils/search/SearchMiniSearch.spec.js.map",
         "utils/search/SearchMinisearch.d.ts",
         "utils/search/SearchMinisearch.js",
         "utils/search/SearchMinisearch.js.map",
@@ -1943,9 +1958,15 @@
         "utils/search/melauto.d.ts",
         "utils/search/melauto.js",
         "utils/search/melauto.js.map",
+        "utils/search/melauto.spec.d.ts",
+        "utils/search/melauto.spec.js",
+        "utils/search/melauto.spec.js.map",
         "utils/search/tokenizer.d.ts",
         "utils/search/tokenizer.js",
         "utils/search/tokenizer.js.map",
+        "utils/search/tokenizer.spec.d.ts",
+        "utils/search/tokenizer.spec.js",
+        "utils/search/tokenizer.spec.js.map",
         "utils/to-number.d.ts",
         "utils/to-number.js",
         "utils/to-number.js.map",
@@ -2007,6 +2028,7 @@
         "@types/react": "^18.3.3",
         "@types/react-dom": "^18.3.0",
         "@vitejs/plugin-react": "^4.3.1",
+        "@vitest/coverage-v8": "2.1.2",
         "ajv": "^8.17.1",
         "concurrently": "^8.2.2",
         "eslint": "^9.9.0",

package/src/type.source.ts

@@ -1,3 +1,4 @@
+/* eslint-disable */
 /**
  * This file was automatically generated by json-schema-to-typescript.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
@@ -34,20 +35,18 @@ export type ComponentDefinition =
 	| ComponentSummaryDefinition
 	| ComponentText
 	| ComponentAccordion;
-export type ComponentInputDefinition = ComponentInputDefinition1 & {
+export type ComponentInputDefinition = ComponentDefinitionBaseWithResponse & {
 	componentType: 'Input' | 'Textarea';
 	maxLength?: number;
 };
-export type ComponentInputDefinition1 = ComponentDefinitionBaseWithResponse;
 export type ComponentDefinitionBaseWithResponse = ComponentDefinitionBase & {
 	response: ResponseDefinition;
 };
-export type ComponentSequenceDefinition = ComponentSequenceDefinition1 & {
+export type ComponentSequenceDefinition = ComponentDefinitionBase & {
 	componentType: 'Sequence' | 'Subsequence';
 	goToPage?: string;
 };
-export type ComponentSequenceDefinition1 = ComponentDefinitionBase;
-export type ComponentRoundaboutDefinition = ComponentRoundaboutDefinition1 & {
+export type ComponentRoundaboutDefinition = ComponentDefinitionBase & {
 	componentType: 'Roundabout';
 	iterations: VTLScalarExpression;
 	locked: boolean;
@@ -59,25 +58,22 @@ export type ComponentRoundaboutDefinition = ComponentRoundaboutDefinition1 & {
 	};
 	components: ComponentDefinitionWithPage[];
 };
-export type ComponentRoundaboutDefinition1 = ComponentDefinitionBase;
 export type ComponentLoopDefinition = {
 	componentType: 'Loop';
 	loopDependencies?: string[];
 } & ComponentLoopDefinition1;
 export type ComponentLoopDefinition1 = PaginatedLoop | BlockLoop;
-export type PaginatedLoop = PaginatedLoop1 & {
+export type PaginatedLoop = ComponentDefinitionBase & {
 	components: ComponentDefinitionWithPage[];
 	iterations: VTLScalarExpression;
 	maxPage: string;
 	paginatedLoop: true;
 };
-export type PaginatedLoop1 = ComponentDefinitionBase;
-export type BlockLoop = BlockLoop1 & {
+export type BlockLoop = ComponentDefinitionBase & {
 	paginatedLoop: false;
 	components: ComponentDefinition[];
-} & BlockLoop2;
-export type BlockLoop1 = ComponentDefinitionBase;
-export type BlockLoop2 =
+} & BlockLoop1;
+export type BlockLoop1 =
 	| {
 			lines: {
 				min: VTLExpression;
@@ -87,17 +83,15 @@ export type BlockLoop2 =
 	| {
 			iterations: VTLExpression;
 	  };
-export type ComponentRosterForLoopDefinition =
-	ComponentRosterForLoopDefinition1 & {
-		componentType: 'RosterForLoop';
-		components: ComponentDefinition[];
-		lines: {
-			min: VTLScalarExpression;
-			max: VTLScalarExpression;
-		};
-		header?: TableHeader;
+export type ComponentRosterForLoopDefinition = ComponentDefinitionBase & {
+	componentType: 'RosterForLoop';
+	components: ComponentDefinition[];
+	lines: {
+		min: VTLScalarExpression;
+		max: VTLScalarExpression;
 	};
-export type ComponentRosterForLoopDefinition1 = ComponentDefinitionBase;
+	header?: TableHeader;
+};
 export type Options = {
 	value: string | boolean;
 	label: VTLExpression;
@@ -111,7 +105,7 @@ export type TableHeader = {
 	rowspan?: number;
 	options?: Options;
 }[];
-export type ComponentTableDefinition = ComponentTableDefinition1 & {
+export type ComponentTableDefinition = ComponentDefinitionBase & {
 	componentType: 'Table';
 	header?: TableHeader;
 	body: (
@@ -121,57 +115,49 @@ export type ComponentTableDefinition = ComponentTableDefinition1 & {
 		  }
 	)[][];
 };
-export type ComponentTableDefinition1 = ComponentDefinitionBase;
-export type ComponentNumberDefinition = ComponentNumberDefinition1 & {
+export type ComponentNumberDefinition = ComponentDefinitionBaseWithResponse & {
 	componentType: 'InputNumber';
 	unit?: string | VTLExpression;
 	min?: number;
 	max?: number;
 	decimals?: number;
 };
-export type ComponentNumberDefinition1 = ComponentDefinitionBaseWithResponse;
-export type ComponentDurationDefinition = ComponentDurationDefinition1 & {
-	componentType: 'Duration';
-	format: 'PnYnM' | 'PTnHnM';
-};
-export type ComponentDurationDefinition1 = ComponentDefinitionBaseWithResponse;
-export type ComponentDatePickerDefinition = ComponentDatePickerDefinition1 & {
-	componentType: 'Datepicker';
-	dateFormat: 'YYYY-MM-DD' | 'YYYY' | 'YYYY-MM';
-	min?: string;
-	max?: string;
-};
-export type ComponentDatePickerDefinition1 =
-	ComponentDefinitionBaseWithResponse;
-export type ComponentCheckboxGroupDefinition =
-	ComponentCheckboxGroupDefinition1 & {
-		componentType: 'CheckboxGroup';
-		orientation?: 'horizontal' | 'vertical';
-		responses: {
-			label: VTLExpression;
-			description?: VTLExpression;
-			response: ResponseDefinition;
-			conditionFilter?: VTLExpression;
-			id: string;
-			detail?: {
-				label?: VTLExpression;
-				response: ResponseDefinition;
-			};
-		}[];
+export type ComponentDurationDefinition =
+	ComponentDefinitionBaseWithResponse & {
+		componentType: 'Duration';
+		format: 'PnYnM' | 'PTnHnM';
 	};
-export type ComponentCheckboxGroupDefinition1 = ComponentDefinitionBase;
+export type ComponentDatePickerDefinition =
+	ComponentDefinitionBaseWithResponse & {
+		componentType: 'Datepicker';
+		dateFormat: 'YYYY-MM-DD' | 'YYYY' | 'YYYY-MM';
+		min?: string;
+		max?: string;
+	};
+export type ComponentCheckboxGroupDefinition = ComponentDefinitionBase & {
+	componentType: 'CheckboxGroup';
+	orientation?: 'horizontal' | 'vertical';
+	responses: {
+		label: VTLExpression;
+		description?: VTLExpression;
+		response: ResponseDefinition;
+		conditionFilter?: VTLExpression;
+		id: string;
+		detail?: {
+			label?: VTLExpression;
+			response: ResponseDefinition;
+		};
+	}[];
+};
 export type ComponentCheckboxBooleanDefinition =
-	ComponentCheckboxBooleanDefinition1 & {
+	ComponentDefinitionBaseWithResponse & {
 		componentType: 'CheckboxBoolean';
 	};
-export type ComponentCheckboxBooleanDefinition1 =
-	ComponentDefinitionBaseWithResponse;
-export type ComponentRadioDefinition = ComponentRadioDefinition1 & {
+export type ComponentRadioDefinition = ComponentDefinitionBaseWithResponse & {
 	componentType: 'Radio';
 	orientation?: 'horizontal' | 'vertical';
 	options: OptionsWithDetail;
 };
-export type ComponentRadioDefinition1 = ComponentDefinitionBaseWithResponse;
 export type OptionsWithDetail = {
 	value: string | boolean;
 	label: VTLExpression;
@@ -183,63 +169,59 @@ export type OptionsWithDetail = {
 		};
 	};
 }[];
-export type ComponentDropdownDefinition = ComponentDropdownDefinition1 & {
-	componentType: 'Dropdown';
-	options: Options;
-};
-export type ComponentDropdownDefinition1 = ComponentDefinitionBaseWithResponse;
-export type ComponentQuestionDefinition = ComponentQuestionDefinition1 & {
+export type ComponentDropdownDefinition =
+	ComponentDefinitionBaseWithResponse & {
+		componentType: 'Dropdown';
+		options: Options;
+	};
+export type ComponentQuestionDefinition = ComponentDefinitionBase & {
 	componentType: 'Question';
 	components: ComponentDefinition[];
 };
-export type ComponentQuestionDefinition1 = ComponentDefinitionBase;
-export type ComponentCheckboxOneDefinition = ComponentCheckboxOneDefinition1 & {
-	componentType: 'CheckboxOne';
-	options: OptionsWithDetail;
-};
-export type ComponentCheckboxOneDefinition1 =
-	ComponentDefinitionBaseWithResponse;
-export type ComponentSuggesterDefinition = ComponentSuggesterDefinition1 & {
-	componentType: 'Suggester';
-	/**
-	 * Nom / Index du référentiel à utiliser
-	 */
-	storeName: string;
-	/**
-	 * Permet l'entrée d'une valeur arbitraire (Autre)
-	 */
-	arbitrary?: {
-		response: ResponseDefinition;
+export type ComponentCheckboxOneDefinition =
+	ComponentDefinitionBaseWithResponse & {
+		componentType: 'CheckboxOne';
+		options: OptionsWithDetail;
 	};
-	/**
-	 * Liste des attributs de la nomenclature à sauvegarder dans une variable
-	 */
-	optionResponses?: {
+export type ComponentSuggesterDefinition =
+	ComponentDefinitionBaseWithResponse & {
+		componentType: 'Suggester';
 		/**
-		 * Nom de la variable
+		 * Nom / Index du référentiel à utiliser
 		 */
-		name: string;
+		storeName: string;
 		/**
-		 * Nom de la propriété dans la nomenclature
+		 * Permet l'entrée d'une valeur arbitraire (Autre)
 		 */
-		attribute: string;
-	}[];
-};
-export type ComponentSuggesterDefinition1 = ComponentDefinitionBaseWithResponse;
-export type ComponentPairWiseLinksDefinition =
-	ComponentPairWiseLinksDefinition1 & {
-		componentType: 'PairwiseLinks';
-		xAxisIterations: VTLScalarExpression;
-		yAxisIterations: VTLScalarExpression;
-		symLinks: {
-			[k: string]: {
-				[k: string]: string | null;
-			};
+		arbitrary?: {
+			response: ResponseDefinition;
+		};
+		/**
+		 * Liste des attributs de la nomenclature à sauvegarder dans une variable
+		 */
+		optionResponses?: {
+			/**
+			 * Nom de la variable
+			 */
+			name: string;
+			/**
+			 * Nom de la propriété dans la nomenclature
+			 */
+			attribute: string;
+		}[];
+	};
+export type ComponentPairWiseLinksDefinition = ComponentDefinitionBase & {
+	componentType: 'PairwiseLinks';
+	xAxisIterations: VTLScalarExpression;
+	yAxisIterations: VTLScalarExpression;
+	symLinks: {
+		[k: string]: {
+			[k: string]: string | null;
 		};
-		components: ComponentDefinition[];
 	};
-export type ComponentPairWiseLinksDefinition1 = ComponentDefinitionBase;
-export type ComponentSummaryDefinition = ComponentSummaryDefinition1 & {
+	components: ComponentDefinition[];
+};
+export type ComponentSummaryDefinition = ComponentDefinitionBase & {
 	componentType: 'Summary';
 	sections: {
 		id: string;
@@ -252,7 +234,6 @@ export type ComponentSummaryDefinition = ComponentSummaryDefinition1 & {
 		}[];
 	}[];
 };
-export type ComponentSummaryDefinition1 = ComponentDefinitionBase;
 export type Variable =
 	| {
 			variableType: 'EXTERNAL';
@@ -465,4 +446,8 @@ export type SuggesterDefinition = {
 		| {
 				type: 'soft';
 		  };
+	/**
+	 * list of words to exclude from the searching
+	 */
+	stopWords?: string[];
 };

package/src/utils/search/SearchMiniSearch.spec.ts

@@ -0,0 +1,58 @@
+import { describe, it, expect, vi, beforeAll, afterEach } from 'vitest';
+import { SearchMinisearch } from './SearchMinisearch';
+
+vi.mock('minisearch', () => {
+	return {
+		default: vi.fn().mockImplementation(() => ({
+			addAll: vi.fn(),
+			search: vi.fn(),
+		})),
+	};
+});
+
+vi.mock('./melauto', () => ({
+	applyMelauto: vi.fn(),
+}));
+
+describe('SearchMinisearch', () => {
+	let searchInstance: SearchMinisearch<any>;
+	const mockData = [
+		{ id: '1', label: 'First Item' },
+		{ id: '2', label: 'Second Item' },
+	];
+
+	beforeAll(() => {
+		searchInstance = new SearchMinisearch({
+			name: 'test-suggester',
+			fields: [{ name: 'id' }, { name: 'label' }],
+			queryParser: {
+				type: 'tokenized',
+				params: { language: 'English', pattern: '\\w+', min: 1 },
+			},
+			max: 10,
+		});
+	});
+
+	afterEach(() => {
+		const miniSearchMock = searchInstance.db as any;
+		miniSearchMock.addAll.mockClear();
+	});
+
+	it('should initialize and index data correctly', async () => {
+		await searchInstance.index(mockData);
+
+		// Check if MiniSearch instance was created and indexed
+		expect(searchInstance.db).not.toBeNull();
+		expect(searchInstance.isIndexed()).toBe(true);
+
+		// Check if addAll was called with the correct data
+		expect(searchInstance.db?.addAll).toHaveBeenCalledWith(mockData);
+	});
+
+	it('should not re-index if already indexed', async () => {
+		searchInstance.indexed = true;
+		await searchInstance.index(mockData);
+
+		expect(searchInstance.db?.addAll).not.toHaveBeenCalled();
+	});
+});

package/src/utils/search/melauto.spec.ts

@@ -0,0 +1,75 @@
+import { describe, it, expect } from 'vitest';
+import { applyMelauto, melautoScore } from './melauto';
+
+// Mock data to test the sorting and scoring
+const data = [
+	{ id: '1', label: 'Hello world' },
+	{ id: '2', label: 'Bonjour le monde' },
+	{ id: '3', label: 'Hello everyone' },
+	{ id: '4', label: 'Greetings planet' },
+];
+
+describe('applyMelauto', () => {
+	it('should sort data by relevance to the query', () => {
+		const sortedData = applyMelauto('hello', data);
+		const expectedSortedData = [
+			{ id: '1', label: 'Hello world' },
+			{ id: '3', label: 'Hello everyone' },
+			{ id: '2', label: 'Bonjour le monde' },
+			{ id: '4', label: 'Greetings planet' },
+		];
+		expect(sortedData).toStrictEqual(expectedSortedData);
+	});
+
+	it('should return data in original order if query is empty', () => {
+		const sortedData = applyMelauto('', data);
+		expect(sortedData).toEqual(data);
+	});
+
+	it('should handle data without labels by using id instead', () => {
+		const noLabelData = [
+			{ id: 'a' },
+			{ id: 'b', label: 'Hello' },
+			{ id: 'hello-w' },
+		];
+		const sortedData = applyMelauto('hello', noLabelData);
+		const expectedSortedData = [
+			{ id: 'b', label: 'Hello' },
+			{ id: 'hello-w' },
+			{ id: 'a' },
+		];
+		expect(sortedData).toStrictEqual(expectedSortedData);
+	});
+});
+
+describe('melautoScore', () => {
+	it('should return a non-null score', () => {
+		const score = melautoScore('Hello world', 'hello');
+		const expectedScore = 1;
+		expect(score).toBeCloseTo(expectedScore, 2);
+	});
+
+	it('should give a higher score for a closer match', () => {
+		const score1 = melautoScore('Hello beautiful world', 'hello world');
+		const score2 = melautoScore('Hello beautiful world', 'hello');
+		expect(score1).toBeGreaterThan(score2);
+	});
+
+	it('should give the same score for a same query if the comparison string is longer', () => {
+		const score1 = melautoScore('Hello world', 'hello');
+		const score2 = melautoScore('Hello beautiful world', 'hello');
+		expect(score1).toBeCloseTo(score2, 2);
+	});
+
+	it('should calculate a null score', () => {
+		const score = melautoScore('Greetings planet', 'hello');
+		const expectedScore = 0;
+		expect(score).toBe(expectedScore);
+	});
+
+	it('should handle accent and special characters correctly', () => {
+		const score1 = melautoScore('Héllo wörld', 'hello world');
+		const score2 = melautoScore('Hello world', 'héllo-wOrld');
+		expect(score1).toBeCloseTo(score2, 2);
+	});
+});

package/src/utils/search/melauto.ts

@@ -7,7 +7,7 @@ export function applyMelauto<T extends { id: string; label?: string }>(
 ): T[] {
 	return data.sort(
 		(a, b) =>
-			melautoScore(b.label ?? a.id, query) -
+			melautoScore(b.label ?? b.id, query) -
 			melautoScore(a.label ?? a.id, query)
 	);
 }