@inseefr/lunatic 3.8.0-rc.ucq-options-variable.0 → 3.8.1-rc.0

package/src/use-lunatic/props/propOptions.spec.ts

@@ -1,14 +1,46 @@
 import { beforeEach, describe, expect, it, vi } from 'vitest';
 import { LunaticVariablesStore } from '../commons/variables/lunatic-variables-store';
-import { computeOptionsFromComponent, InterpretedOption } from './propOptions';
+import { getOptionsProp } from './propOptions';
 import type { DeepTranslateExpression } from '../commons/fill-components/fill-component-expressions';
 import type {
 	LunaticChangesHandler,
 	LunaticComponentDefinition,
 } from '../type';
 
-describe('computeOptionsFromComponent', () => {
+describe('getOptionsProp()', () => {
 	let variables: LunaticVariablesStore;
+	const checkboxGroupDefinition = {
+		id: 'CheckboxGroup',
+		componentType: 'CheckboxGroup',
+		responses: [
+			{
+				label: 'Option 1',
+				response: { name: 'O1' },
+				id: 'id1',
+			},
+			{
+				label: 'Option 2',
+				response: { name: 'O2' },
+				id: 'id2',
+			},
+		],
+	} satisfies DeepTranslateExpression<LunaticComponentDefinition>;
+
+	const radioDefinition = {
+		id: 'RadioGroup',
+		componentType: 'Radio',
+		response: { name: 'RADIO' },
+		options: [
+			{
+				label: 'Option 1',
+				value: 'id1',
+			},
+			{
+				label: 'Option 2',
+				value: 'id2',
+			},
+		],
+	} satisfies DeepTranslateExpression<LunaticComponentDefinition>;
 
 	let mockChange: LunaticChangesHandler;
 	const mockLogger = vi.fn();
@@ -18,97 +50,69 @@ describe('computeOptionsFromComponent', () => {
 		variables = new LunaticVariablesStore();
 	});
 
-	describe('Options based on a fixed list', () => {
-		const checkboxGroupDefinition = {
-			id: 'CheckboxGroup',
-			componentType: 'CheckboxGroup',
-			responses: [
-				{
-					label: 'Option 1',
-					response: { name: 'O1' },
-					id: 'id1',
-				},
-				{
-					label: 'Option 2',
-					response: { name: 'O2' },
-					id: 'id2',
-				},
-			],
-		} satisfies DeepTranslateExpression<LunaticComponentDefinition>;
-
-		const radioDefinition = {
-			id: 'RadioGroup',
-			componentType: 'Radio',
-			response: { name: 'RADIO' },
-			options: [
-				{
-					label: 'Option 1',
-					value: 'id1',
-				},
-				{
-					label: 'Option 2',
-					value: 'id2',
-				},
-			],
-		} satisfies DeepTranslateExpression<LunaticComponentDefinition>;
-
+	describe('CheckboxGroup', () => {
 		it('should check boxes', () => {
 			variables.set('O2', false);
-			let options = computeOptionsFromComponent(checkboxGroupDefinition, {
+			let options = getOptionsProp(
+				checkboxGroupDefinition,
 				variables,
-				handleChanges: mockChange,
-				pagerIteration: undefined,
-				value: undefined,
-				logger: mockLogger,
-			});
+				mockChange,
+				undefined,
+				undefined,
+				mockLogger
+			);
 			expect(options[1].checked).toBe(false);
 			variables.set('O2', true);
-			options = computeOptionsFromComponent(checkboxGroupDefinition, {
+			options = getOptionsProp(
+				checkboxGroupDefinition,
 				variables,
-				handleChanges: mockChange,
-				pagerIteration: undefined,
-				value: undefined,
-				logger: mockLogger,
-			});
+				mockChange,
+				undefined,
+				undefined,
+				mockLogger
+			);
 			expect(options[1].checked).toBe(true);
 		});
 		it('should check boxes correctly within iteration', () => {
 			variables.set('O1', []);
 			variables.set('O2', []);
-			let options = computeOptionsFromComponent(checkboxGroupDefinition, {
+			let options = getOptionsProp(
+				checkboxGroupDefinition,
 				variables,
-				handleChanges: mockChange,
-				pagerIteration: 0,
-				value: undefined,
-				logger: mockLogger,
-			});
+				mockChange,
+				0,
+				undefined,
+				mockLogger
+			);
 			expect(
 				options.filter((o) => o.checked),
 				'Nothing checked when variable empty'
 			).toHaveLength(0);
 
 			variables.set('O1', [true, 0]);
-			options = computeOptionsFromComponent(checkboxGroupDefinition, {
+			options = getOptionsProp(
+				checkboxGroupDefinition,
 				variables,
-				handleChanges: mockChange,
-				pagerIteration: 0,
-				value: undefined,
-				logger: mockLogger,
-			});
+				mockChange,
+				0,
+				undefined,
+				mockLogger
+			);
 			expect(options[0].checked).toBe(true);
 			expect(options[1].checked).toBe(false);
 		});
 		it('should create handleChange correctly', () => {
 			variables.set('O1', [true, false]);
 			variables.set('O2', [false, true]);
-			const options = computeOptionsFromComponent(checkboxGroupDefinition, {
+			const options = getOptionsProp(
+				checkboxGroupDefinition,
 				variables,
-				handleChanges: mockChange,
-				pagerIteration: 1,
-				value: undefined,
-				logger: mockLogger,
-			});
-			options[1].onCheck?.(false);
+				mockChange,
+				1,
+				undefined,
+				mockLogger
+			);
+			options[1].onCheck(false);
 			expect(mockChange).toHaveBeenLastCalledWith([
 				{ name: 'O2', value: false },
 			]);
@@ -141,13 +145,14 @@ describe('computeOptionsFromComponent', () => {
 
 			variables.set('DETAIL', true);
 
-			const options = computeOptionsFromComponent(definition, {
+			const options = getOptionsProp(
+				definition,
 				variables,
-				handleChanges: mockChange,
-				pagerIteration: undefined,
-				value: undefined,
-				logger: mockLogger,
-			});
+				mockChange,
+				undefined,
+				undefined,
+				mockLogger
+			);
 
 			expect(options).toHaveLength(2);
 			expect(options[0].detailLabel).toBe('Precize:');
@@ -183,13 +188,14 @@ describe('computeOptionsFromComponent', () => {
 
 			variables.set('DETAIL', true);
 
-			const options = computeOptionsFromComponent(definition, {
+			const options = getOptionsProp(
+				definition,
 				variables,
-				handleChanges: mockChange,
-				pagerIteration: undefined,
-				value: undefined,
-				logger: mockLogger,
-			});
+				mockChange,
+				undefined,
+				undefined,
+				mockLogger
+			);
 
 			expect(options).toHaveLength(2);
 			expect(options[0].detailLabel).toBe('Precize:');
@@ -218,13 +224,14 @@ describe('computeOptionsFromComponent', () => {
 				],
 			} satisfies DeepTranslateExpression<LunaticComponentDefinition>;
 
-			const options = computeOptionsFromComponent(definition, {
+			const options = getOptionsProp(
+				definition,
 				variables,
-				handleChanges: mockChange,
-				pagerIteration: undefined,
-				value: undefined,
-				logger: mockLogger,
-			});
+				mockChange,
+				undefined,
+				undefined,
+				mockLogger
+			);
 
 			// First option should be filtered out since its conditionFilter is evaluated to false
 			expect(options).toHaveLength(1);
@@ -247,13 +254,14 @@ describe('computeOptionsFromComponent', () => {
 				],
 			} as any as DeepTranslateExpression<LunaticComponentDefinition>;
 
-			const options = computeOptionsFromComponent(definition, {
+			const options = getOptionsProp(
+				definition,
 				variables,
-				handleChanges: mockChange,
-				pagerIteration: undefined,
-				value: undefined,
-				logger: mockLogger,
-			});
+				mockChange,
+				undefined,
+				undefined,
+				mockLogger
+			);
 
 			// First option should be filtered out since its conditionFilter is evaluated to false
 			expect(options).toHaveLength(1);
@@ -277,13 +285,14 @@ describe('computeOptionsFromComponent', () => {
 				throw new Error('Test error');
 			});
 
-			const options = computeOptionsFromComponent(definition, {
+			const options = getOptionsProp(
+				definition,
 				variables,
-				handleChanges: mockChange,
-				pagerIteration: undefined,
-				value: undefined,
-				logger: mockLogger,
-			});
+				mockChange,
+				undefined,
+				undefined,
+				mockLogger
+			);
 
 			// Ensure the option is not filtered
 			expect(options).toHaveLength(1);
@@ -306,13 +315,14 @@ describe('computeOptionsFromComponent', () => {
 				throw new Error('Test error');
 			});
 
-			const options = computeOptionsFromComponent(definition, {
+			const options = getOptionsProp(
+				definition,
 				variables,
-				handleChanges: mockChange,
-				pagerIteration: undefined,
-				value: undefined,
-				logger: mockLogger,
-			});
+				mockChange,
+				undefined,
+				undefined,
+				mockLogger
+			);
 
 			// Ensure the option is not filtered
 			expect(options).toHaveLength(1);
@@ -336,14 +346,15 @@ describe('computeOptionsFromComponent', () => {
 				return false;
 			});
 
-			const options = computeOptionsFromComponent(definition, {
+			const options = getOptionsProp(
+				definition,
 				variables,
-				handleChanges: mockChange,
-				pagerIteration: undefined,
-				value: undefined,
-				logger: mockLogger,
-				disableFilters: true,
-			});
+				mockChange,
+				undefined,
+				undefined,
+				mockLogger,
+				true // disableFilters = true
+			);
 
 			// Ensure the option is not filtered
 			expect(options).toHaveLength(1);
@@ -367,14 +378,15 @@ describe('computeOptionsFromComponent', () => {
 				return false;
 			});
 
-			const options = computeOptionsFromComponent(definition, {
+			const options = getOptionsProp(
+				definition,
 				variables,
-				handleChanges: mockChange,
-				pagerIteration: undefined,
-				value: undefined,
-				logger: mockLogger,
-				disableFilters: true,
-			});
+				mockChange,
+				undefined,
+				undefined,
+				mockLogger,
+				true // disableFilters = true
+			);
 
 			// Ensure the option is not filtered
 			expect(options).toHaveLength(1);
@@ -394,15 +406,16 @@ describe('computeOptionsFromComponent', () => {
 				],
 			} satisfies DeepTranslateExpression<LunaticComponentDefinition>;
 
-			const options = computeOptionsFromComponent(definition, {
+			const options = getOptionsProp(
+				definition,
 				variables,
-				handleChanges: mockChange,
-				pagerIteration: undefined,
-				value: undefined,
-				logger: mockLogger,
-				disableFilters: true,
-				shouldParentBeFiltered: true,
-			});
+				mockChange,
+				undefined,
+				undefined,
+				mockLogger,
+				true, // disableFilters = true
+				true // parent component should be filtered
+			);
 
 			// Ensure the option is not filtered
 			expect(options).toHaveLength(1);
@@ -421,15 +434,16 @@ describe('computeOptionsFromComponent', () => {
 				],
 			} as any as DeepTranslateExpression<LunaticComponentDefinition>;
 
-			const options = computeOptionsFromComponent(definition, {
+			const options = getOptionsProp(
+				definition,
 				variables,
-				handleChanges: mockChange,
-				pagerIteration: undefined,
-				value: undefined,
-				logger: mockLogger,
-				disableFilters: true,
-				shouldParentBeFiltered: true,
-			});
+				mockChange,
+				undefined,
+				undefined,
+				mockLogger,
+				true, // disableFilters = true
+				true // parent component should be filtered
+			);
 
 			// Ensure the option is not filtered
 			expect(options).toHaveLength(1);
@@ -437,88 +451,4 @@ describe('computeOptionsFromComponent', () => {
 			expect(options[0].shouldBeFiltered).toBe(true);
 		});
 	});
-
-	describe('Options based on a source variable', () => {
-		const radioOptionSourceDefinition = {
-			id: 'RadioGroupDynamic',
-			componentType: 'Radio',
-			response: { name: 'RADIO' },
-			optionSource: 'NAME',
-		} satisfies DeepTranslateExpression<LunaticComponentDefinition>;
-
-		it('should build options when the source variable is an array of strings', () => {
-			variables.set('NAME', ['Maëlle', 'Verso']);
-			const options = computeOptionsFromComponent(radioOptionSourceDefinition, {
-				variables,
-				handleChanges: mockChange,
-				pagerIteration: undefined,
-				value: undefined,
-				logger: mockLogger,
-			}) as InterpretedOption[]; // force type but it should infer type correctly
-
-			expect(options).toHaveLength(2);
-			expect(options[0].value).toBe('Maëlle');
-			expect(options[0].label).toBe('Maëlle');
-			expect(options[1].value).toBe('Verso');
-			expect(options[1].label).toBe('Verso');
-		});
-
-		it('should build options when the source variable is an array of numbers', () => {
-			variables.set('NAME', [10, 20]);
-			const options = computeOptionsFromComponent(radioOptionSourceDefinition, {
-				variables,
-				handleChanges: mockChange,
-				pagerIteration: undefined,
-				value: undefined,
-				logger: mockLogger,
-			}) as InterpretedOption[]; // force type but it should infer type correctly
-
-			expect(options).toHaveLength(2);
-			expect(options[0].value).toBe(10);
-			expect(options[0].label).toBe('10');
-			expect(options[1].value).toBe(20);
-			expect(options[1].label).toBe('20');
-		});
-
-		it('should set the response when selecting a dynamic option', () => {
-			variables.set('NAME', ['Maëlle', 'Verso']);
-			const options = computeOptionsFromComponent(radioOptionSourceDefinition, {
-				variables,
-				handleChanges: mockChange,
-				pagerIteration: undefined,
-				value: undefined,
-				logger: mockLogger,
-			}) as InterpretedOption[]; // force type but it should infer type correctly
-
-			options[0].onCheck?.();
-			expect(mockChange).toHaveBeenLastCalledWith([
-				{ name: 'RADIO', value: 'Maëlle' },
-			]);
-
-			options[1].onCheck?.();
-			expect(mockChange).toHaveBeenLastCalledWith([
-				{ name: 'RADIO', value: 'Verso' },
-			]);
-		});
-
-		it('should filter options based on the optionFilter expression', () => {
-			const definition = {
-				...radioOptionSourceDefinition,
-				optionFilter: { type: 'VTL', value: 'AGE >= 18' },
-			} satisfies DeepTranslateExpression<LunaticComponentDefinition>;
-
-			variables.set('NAME', ['Maëlle', 'Verso', 'Aline']);
-			variables.set('AGE', [16, 30, 50]);
-
-			const options = computeOptionsFromComponent(definition, {
-				variables,
-				handleChanges: mockChange,
-				pagerIteration: undefined,
-				value: undefined,
-				logger: mockLogger,
-			}) as InterpretedOption[]; // force type but it should infer type correctly
-
-			expect(options.map((option) => option.value)).toEqual(['Verso', 'Aline']);
-		});
-	});
 });

package/src/use-lunatic/props/propOptions.ts

@@ -28,25 +28,15 @@ export type InterpretedOption = {
 /**
  * Compute options for checkboxes / radios / dropdown
  */
-export function computeOptionsFromComponent(
+export function getOptionsProp(
 	definition: DeepTranslateExpression<LunaticComponentDefinition>,
-	{
-		variables,
-		handleChanges,
-		pagerIteration,
-		value,
-		logger,
-		disableFilters,
-		shouldParentBeFiltered,
-	}: {
-		variables: LunaticVariablesStore;
-		handleChanges: LunaticChangesHandler;
-		pagerIteration: LunaticState['pager']['iteration'];
-		value: unknown;
-		logger: LunaticLogger;
-		disableFilters?: boolean;
-		shouldParentBeFiltered?: boolean;
-	}
+	variables: LunaticVariablesStore,
+	handleChanges: LunaticChangesHandler,
+	pagerIteration: LunaticState['pager']['iteration'],
+	value: unknown,
+	logger: LunaticLogger,
+	disableFilters?: boolean,
+	shouldParentBeFiltered?: boolean
 ) {
 	const iteration = isNumber(pagerIteration) ? [pagerIteration] : undefined;
 
@@ -95,27 +85,10 @@ export function computeOptionsFromComponent(
 			}));
 	}
 
-	// options based on another variable
-	if ('optionSource' in definition && definition.optionSource) {
-		return computeOptionsFromSource(definition.optionSource, {
-			variables,
-			value,
-			handleChanges,
-			responseName: definition.response.name,
-			logger,
-			shouldParentBeFiltered,
-			optionFilter: definition.optionFilter,
-		});
-	}
-
 	if (!('options' in definition)) {
 		return [];
 	}
 
-	if (!definition.options) {
-		return [];
-	}
-
 	return definition.options
 		.filter((option) => {
 			if (
@@ -171,68 +144,6 @@ export function computeOptionsFromComponent(
 		}));
 }
 
-/**
- * Get all options from a source variable, applying filters.
- */
-function computeOptionsFromSource(
-	optionSource: string,
-	{
-		variables,
-		value,
-		handleChanges,
-		responseName,
-		logger,
-		shouldParentBeFiltered,
-		optionFilter,
-	}: {
-		variables: LunaticVariablesStore;
-		value: unknown;
-		handleChanges: LunaticChangesHandler;
-		responseName: string;
-		logger: LunaticLogger;
-		shouldParentBeFiltered?: boolean;
-		optionFilter?: VtlExpression;
-	}
-): InterpretedOption[] {
-	// we don't know the type of the optionSource values (string, numbers, boolean)
-	const optionValues = variables.get<unknown>(optionSource);
-	if (!optionValues) {
-		return [];
-	}
-
-	const normalizedValues = Array.isArray(optionValues)
-		? optionValues
-		: [optionValues];
-
-	return normalizedValues
-		.filter((option, index) => {
-			// option is an empty value, we remove it from the options list
-			if (option === null || option === undefined) {
-				return false;
-			}
-			// no filter expression, we keep the option
-			if (!optionFilter) {
-				return true;
-			}
-			// apply filter expression on option (applied to its iteration)
-			return !isFilteredOutOption(variables, [index], logger, optionFilter);
-		})
-		.map((option) => {
-			return {
-				label: String(option),
-				value: option,
-				checked: value === option,
-				onCheck: () => {
-					handleChanges([{ name: responseName, value: option }]);
-				},
-				onUncheck: () => {
-					handleChanges([{ name: responseName, value: null }]);
-				},
-				shouldBeFiltered: shouldParentBeFiltered,
-			};
-		});
-}
-
 /**
  * Check if an option should be filtered, depending on its conditionFilter.
  */

package/src/utils/search/SearchInterface.ts

@@ -14,4 +14,6 @@ export interface SearchInterface<T extends IndexEntry> {
 	index(data: T[]): Promise<void>;
 
 	search(q: string): Promise<T[]>;
+
+	getFieldsById(id: any): T;
 }

package/src/utils/search/SearchMinisearch.ts

@@ -51,4 +51,11 @@ export class SearchMinisearch<T extends IndexEntry>
 
 		return data;
 	}
+
+	getFieldsById(id: any) {
+		if (!this.db) {
+			return {} as T;
+		}
+		return this.db.getStoredFields(id) as T;
+	}
 }

package/src/utils/search/SuggestersDatabase.ts

@@ -23,6 +23,16 @@ export function registerSuggesters(
 	}
 }
 
+export type SearchStore =
+	| {
+			error: string;
+	  }
+	| {
+			error?: null;
+			search: SearchInterface<IndexEntry>;
+			index: () => Promise<void>;
+	  };
+
 export function getSearchForStore(storeName: string) {
 	const search = suggesters.get(storeName);
 	if (!search) {