@inseefr/lunatic 3.4.14 → 3.4.16

package/src/use-lunatic/commons/variables/get-questionnaire-data.ts

@@ -13,10 +13,6 @@ export function getQuestionnaireData(
 		COLLECTED: {} as Record<
 			string,
 			{
-				EDITED: unknown;
-				FORCED: unknown;
-				INPUTTED: unknown;
-				PREVIOUS: unknown;
 				COLLECTED: unknown;
 			}
 		>,
@@ -34,10 +30,6 @@ export function getQuestionnaireData(
 				variableNames.map((name) => [
 					name,
 					{
-						EDITED: null,
-						FORCED: null,
-						INPUTTED: null,
-						PREVIOUS: null,
 						COLLECTED: store.get(name),
 					},
 				])
@@ -53,10 +45,6 @@ export function getQuestionnaireData(
 
 		if (variable.variableType === 'COLLECTED') {
 			result.COLLECTED[variable.name] = {
-				PREVIOUS: null,
-				FORCED: null,
-				EDITED: null,
-				INPUTTED: null,
 				...variable.values,
 				COLLECTED: store.get(variable.name),
 			};

package/src/use-lunatic/commons/variables/lunatic-variables-store.spec.ts

@@ -449,10 +449,6 @@ describe('lunatic-variables-store', () => {
 						{
 							name: 'PRENOM',
 							values: {
-								EDITED: null,
-								FORCED: null,
-								INPUTTED: null,
-								PREVIOUS: null,
 								COLLECTED: 'John',
 							},
 							variableType: 'COLLECTED',
@@ -460,10 +456,6 @@ describe('lunatic-variables-store', () => {
 						{
 							name: 'NOM',
 							values: {
-								EDITED: null,
-								FORCED: null,
-								INPUTTED: null,
-								PREVIOUS: null,
 								COLLECTED: '',
 							},
 							variableType: 'COLLECTED',

package/src/use-lunatic/hooks/useOverview.spec.ts

@@ -0,0 +1,42 @@
+import { renderHook } from '@testing-library/react';
+import { describe, expect, it } from 'vitest';
+import source from '../../stories/overview/sourceWithHierarchy.json';
+import { useLunatic } from '../use-lunatic';
+import { dataFromObject } from '../test.utils';
+
+describe('use-overview test with useLunatic()', () => {
+	it('should initialize correctly with disableFilters: false (without data)', () => {
+		const params = [
+			source as any,
+			dataFromObject({}),
+			{ withOverview: true },
+		] as const;
+		const { result } = renderHook(() => useLunatic(...params));
+		expect(result.current.overview.length).toBe(3);
+	});
+
+	it('should initialize correctly with disableFilters: false (with data)', () => {
+		const params = [
+			source as any,
+			dataFromObject({
+				READY: true,
+			}),
+			{ withOverview: true },
+		] as const;
+
+		const { result } = renderHook(() => useLunatic(...params));
+		expect(result.current.overview.length).toBe(9);
+	});
+
+	it('should initialize correctly with disableFilters: true (without data)', () => {
+		const params = [
+			source as any,
+			dataFromObject({}),
+			{ withOverview: true, disableFilters: true },
+		] as const;
+
+		const { result } = renderHook(() => useLunatic(...params));
+		// All elements have to be presents
+		expect(result.current.overview.length).toBe(9);
+	});
+});

package/src/use-lunatic/hooks/useOverview.ts

@@ -1,4 +1,5 @@
 import type {
+	LunaticOptions,
 	LunaticOverviewItem,
 	LunaticReducerState,
 	PageTag,
@@ -25,13 +26,23 @@ export const useOverview = (
 		overview,
 		executeExpression,
 		pager,
-	}: Pick<LunaticReducerState, 'executeExpression' | 'overview' | 'pager'>,
+		options,
+	}: Pick<
+		LunaticReducerState,
+		'executeExpression' | 'overview' | 'pager' | 'options'
+	>,
 	deps: DependencyList
 ) => {
 	return useMemo(
-		() => interpretOverview(overview, executeExpression, pager),
+		() =>
+			interpretOverview(
+				overview,
+				executeExpression,
+				pager,
+				options.disableFilters
+			),
 		// eslint-disable-next-line react-hooks/exhaustive-deps
-		[...deps, overview]
+		[...deps, overview, options.disableFilters]
 	);
 };
 
@@ -41,11 +52,16 @@ export const useOverview = (
 const interpretOverview = (
 	overviewItems: LunaticOverviewItem[],
 	executeExpression: LunaticReducerState['executeExpression'],
-	pager?: LunaticReducerState['pager']
+	pager?: LunaticReducerState['pager'],
+	disableFilters?: LunaticOptions['disableFilters']
 ) => {
 	// Flat structure of the overview
 	let items = overviewItems.reduce(
-		(acc, item) => interpretOverviewItem(acc, item, executeExpression, pager),
+		(acc, item) =>
+			interpretOverviewItem(acc, item, executeExpression, {
+				pager,
+				disableFilters,
+			}),
 		[] as InterpretedLunaticOverviewItem[]
 	);
 	// Sort using the page logic
@@ -77,7 +93,11 @@ const interpretOverviewItem = (
 	items: InterpretedLunaticOverviewItem[],
 	item: LunaticOverviewItem,
 	executeExpression: LunaticReducerState['executeExpression'],
-	pager?: LunaticReducerState['pager'],
+	state: {
+		pager?: LunaticReducerState['pager'];
+		disableFilters?: LunaticOptions['disableFilters'];
+	},
+
 	iteration?: number
 ): InterpretedLunaticOverviewItem[] => {
 	// We reached a loop item, we need to add it multiple time
@@ -85,19 +105,21 @@ const interpretOverviewItem = (
 		const iterations = executeExpression<number>(item.iterations) ?? 0;
 		return Array.from({ length: iterations }).reduce(
 			(acc: InterpretedLunaticOverviewItem[], _, k) => {
-				return interpretOverviewItem(acc, item, executeExpression, pager, k);
+				return interpretOverviewItem(acc, item, executeExpression, state, k);
 			},
 			items
 		);
 	}
 
-	const isVisible = item.conditionFilter
-		? Boolean(
-				executeExpression(item.conditionFilter, {
-					iteration: iteration,
-				})
-			)
-		: true;
+	// if disableFilters is set to true, item are visible and reached by default
+	const isVisible = (() => {
+		if (state.disableFilters || !item.conditionFilter) return true;
+		return Boolean(
+			executeExpression(item.conditionFilter, {
+				iteration: iteration,
+			})
+		);
+	})();
 
 	if (!isVisible) {
 		return items;
@@ -106,6 +128,10 @@ const interpretOverviewItem = (
 	// Append the item to the list of items
 	const page =
 		`${item.pageTag}${iteration !== undefined ? `#${iteration + 1}` : ''}` as PageTag;
+
+	const reached =
+		pageTagComparator(state.pager ? getPageTag(state.pager) : '-1', page) >= 0;
+
 	return [
 		...items,
 		{
@@ -116,10 +142,7 @@ const interpretOverviewItem = (
 				? executeExpression(item.description, { iteration })
 				: undefined,
 			children: [],
-			reached:
-				pageTagComparator(pager ? getPageTag(pager) : '-1', page) >= 0
-					? true
-					: false,
+			reached: reached,
 			page: page,
 			current: false,
 		},

package/src/use-lunatic/test.utils.ts

@@ -0,0 +1,17 @@
+import { LunaticData } from './type';
+
+export const dataFromObject = (o: Record<string, unknown>): LunaticData => {
+	return {
+		EXTERNAL: {},
+		COLLECTED: Object.keys(o).reduce(
+			(acc, k) => ({
+				...acc,
+				[k]: {
+					COLLECTED: o[k],
+				},
+			}),
+			{}
+		),
+		CALCULATED: {},
+	};
+};

package/src/use-lunatic/type.ts

@@ -74,10 +74,6 @@ export type PageTag = `${number}.${number}#${number}` | `${number}`;
 export type LunaticVariable = Variable;
 export type LunaticCollectedValue = Partial<{
 	COLLECTED: unknown;
-	EDITED: unknown;
-	FORCED: unknown;
-	INPUTTED: unknown;
-	PREVIOUS: unknown;
 }>;
 
 // We need a mapped type to correlate type and variableType

package/src/use-lunatic/use-lunatic.test.ts

@@ -9,29 +9,10 @@ import sourceCheckboxGroup from '../stories/checkbox-group/source.json';
 import dataOverview from '../stories/overview/dataLoop.json';
 import sourceCleaningLoop from '../stories/behaviour/cleaning/source-loop.json';
 import sourceCleaningResizing from '../stories/behaviour/resizing/source-resizing-cleaning.json';
-import type { LunaticData, PageTag } from './type';
+import type { PageTag } from './type';
 import { useLunatic } from './use-lunatic';
 import { useCallback } from 'react';
-
-const dataFromObject = (o: Record<string, unknown>): LunaticData => {
-	return {
-		EXTERNAL: {},
-		COLLECTED: Object.keys(o).reduce(
-			(acc, k) => ({
-				...acc,
-				[k]: {
-					EDITED: null,
-					FORCED: null,
-					INPUTTED: null,
-					PREVIOUS: null,
-					COLLECTED: o[k],
-				},
-			}),
-			{}
-		),
-		CALCULATED: {},
-	};
-};
+import { dataFromObject } from './test.utils';
 
 describe('use-lunatic()', () => {
 	const defaultParams = [

package/src/utils/constants/variable-status.ts

@@ -1,5 +1 @@
-export const PREVIOUS = 'PREVIOUS' as const;
 export const COLLECTED = 'COLLECTED' as const;
-export const FORCED = 'FORCED' as const;
-export const EDITED = 'EDITED' as const;
-export const INPUTTED = 'INPUTTED' as const;

package/src/utils/variables.spec.ts

@@ -15,10 +15,6 @@ const data = {
 		},
 		PRENOMS: {
 			COLLECTED: ['Paul', 'Pierre'],
-			EDITED: [],
-			INPUTTED: [],
-			FORCED: [],
-			PREVIOUS: [],
 		},
 		AGE: {},
 	},
@@ -49,10 +45,6 @@ const loopCollectedVariable = {
 	variableType: 'COLLECTED',
 	values: {
 		COLLECTED: [],
-		PREVIOUS: [],
-		FORCED: [],
-		EDITED: [],
-		INPUTTED: [],
 	},
 	name: 'PRENOMS',
 } as LunaticVariable;