@inseefr/lunatic 3.5.7 → 3.6.0

package/src/type.source.ts

@@ -239,6 +239,8 @@ export type Variable =
 			variableType: 'EXTERNAL';
 			name: string;
 			value: VariableValue;
+			iterationReference?: string;
+			dimension?: number;
 	  }
 	| {
 			variableType: 'COLLECTED';
@@ -246,6 +248,8 @@ export type Variable =
 			values?: {
 				COLLECTED: VariableValue;
 			};
+			iterationReference?: string;
+			dimension?: number;
 	  }
 	| {
 			variableType: 'CALCULATED';
@@ -253,6 +257,8 @@ export type Variable =
 			expression: VTLExpression;
 			bindingDependencies?: string[];
 			shapeFrom?: string[] | string;
+			iterationReference?: string;
+			dimension?: number;
 	  };
 export type VariableValue = VariableScalarValue | unknown[];
 export type VariableScalarValue = string | number | null;
@@ -340,6 +346,7 @@ export type ComponentDefinitionBase = {
 	id: string;
 	isMandatory?: boolean;
 	missingResponse?: ResponseDefinition;
+	conditionReadOnly?: VTLScalarExpression;
 };
 export type Declaration = {
 	id: string;
@@ -371,7 +378,7 @@ export type VTLScalarExpression = {
 export type ControlDefinition = {
 	id: string;
 	criticality: 'INFO' | 'WARN' | 'ERROR';
-	typeOfControl?: 'FORMAT' | 'CONSISTENCY';
+	typeOfControl?: 'FORMAT' | 'CONSISTENCY' | 'MANDATORY';
 	control: VTLExpression;
 	errorMessage: VTLExpression;
 	bindingDependencies?: string[];

package/src/use-lunatic/commons/compile-controls.ts

@@ -1,4 +1,3 @@
-import { replaceComponentSequence } from '../replace-component-sequence';
 import type {
 	LunaticComponentDefinition,
 	LunaticControl,
@@ -27,22 +26,29 @@ type InterpretedLoopComponent = DeepTranslateExpression<
 >;
 
 const isLoopComponent = (
-	component: InterpretedComponent
+	component: ComponentDefinition | InterpretedComponent
 ): component is InterpretedLoopComponent => {
 	return ['Loop', 'RosterForLoop', 'Roundabout'].includes(
 		component.componentType
 	);
 };
 
+const isQuestionComponent = (
+	component: ComponentDefinition | InterpretedComponent
+) => {
+	return 'Question' === component.componentType;
+};
+
 /**
  * Check if components of the current page have errors, and return a map of
  * errors (indexed by component ID).
  */
 function checkComponents(
 	state: StateForControls,
-	components: InterpretedComponent[]
+	components: (ComponentDefinition | InterpretedComponent)[],
+	currentErrors?: Record<string, LunaticError[]>
 ): Record<string, LunaticError[]> {
-	let errors = {} as Record<string, LunaticError[]>;
+	let errors = currentErrors ?? ({} as Record<string, LunaticError[]>);
 
 	for (const component of components) {
 		// The component has global level controls
@@ -58,24 +64,36 @@ function checkComponents(
 		}
 
 		// For loop, inspect children
-		if (isLoopComponent(component)) {
-			const rowControls = component.controls?.filter((c) => c.type === 'ROW');
-			if (rowControls?.length) {
-				errors = checkComponentInLoop(
-					state,
-					{ ...component, controls: rowControls },
-					errors
-				);
-			}
-			for (const child of component.components) {
-				errors = checkComponentInLoop(state, child, errors);
-			}
-		}
+		if (isLoopComponent(component))
+			errors = checkLoop(state, component, errors);
+
+		// For Question, loop over children
+		if (isQuestionComponent(component))
+			errors = checkComponents(state, component.components, errors);
 	}
 
 	return errors;
 }
 
+function checkLoop(
+	state: StateForControls,
+	component: InterpretedLoopComponent,
+	errors: Record<string, LunaticError[]>
+) {
+	const rowControls = component.controls?.filter((c) => c.type === 'ROW');
+	if (rowControls?.length) {
+		errors = checkComponentInLoop(
+			state,
+			{ ...component, controls: rowControls },
+			errors
+		);
+	}
+	for (const child of component.components) {
+		errors = checkComponentInLoop(state, child, errors);
+	}
+	return errors;
+}
+
 function checkControls(
 	controls: LunaticControl[],
 	executeExpression: LunaticReducerState['executeExpression'],
@@ -214,7 +232,7 @@ function hasCriticalError(errors?: Record<string, LunaticError[]>): boolean {
  * Check controls for currently visible components and output errors.
  */
 export function compileControls(state: StateForControls) {
-	const components = replaceComponentSequence(getComponentsFromState(state));
+	const components = getComponentsFromState(state);
 	const componentFiltered = components
 		.map((component) => fillComponentExpressions(component, state))
 		.filter((component) => {

package/src/use-lunatic/commons/fill-components/fill-component-expressions.ts

@@ -1,10 +1,10 @@
 import type { ReactNode } from 'react';
-import { isObject } from '../../../utils/is-object';
 import type {
 	LunaticComponentDefinition,
 	LunaticExpression,
 	LunaticReducerState,
 } from '../../type';
+import { isObject } from '../../../utils/object';
 
 const VTL_ATTRIBUTES = [
 	['label', null],
@@ -28,7 +28,7 @@ const VTL_ATTRIBUTES = [
 	['conditionFilter', castBool],
 	['header.label', null],
 	['disabled', castBool],
-	['readOnly', castBool],
+	['conditionReadOnly', castBool],
 	// For suggesters
 	['arbitrary.label', castString],
 	['arbitrary.inputLabel', castString],
@@ -47,6 +47,9 @@ function castNumber(v: unknown): number {
 	if (Array.isArray(v) && v.length > 0) {
 		return castNumber(v[0]);
 	}
+	if (v === null) {
+		return 0;
+	}
 	throw new Error(`Cannot cast "${v}" to number`);
 }
 
@@ -87,6 +90,7 @@ type UntranslatedProperties =
 	| 'item'
 	| 'controls'
 	| 'conditionFilter'
+	| 'conditionReadOnly'
 	| 'components';
 export type DeepTranslateExpression<T> = T extends LunaticExpression
 	? ReactNode

package/src/use-lunatic/commons/fill-components/fill-component.spec.ts

@@ -704,4 +704,56 @@ describe('fillComponents', () => {
 		expect(radio.options[1].conditionFilter).toBe(undefined);
 		expect(radio.options[1].shouldBeFiltered).toBe(true);
 	});
+
+	it('should set component (and all its children) as readOnly if conditionReadOnly is evaluated to true', () => {
+		const components = [
+			{
+				id: 'question-m8ilvkbt',
+				componentType: 'Question',
+				page: '1',
+				label: {
+					value: '"Question label"',
+					type: 'VTL|MD',
+				},
+				conditionReadOnly: {
+					type: 'VTL',
+					value: 'true',
+				},
+				components: [
+					{
+						id: 'm8ilvkbt',
+						componentType: 'Input',
+						page: '1',
+						maxLength: 249,
+						response: {
+							name: 'TESTTEXTE',
+						},
+					},
+				],
+			},
+		];
+
+		const mockVariables = LunaticVariablesStore.makeFromObject({
+			TESTTEXTE: 'some value',
+		});
+
+		const mockState = {
+			...defaultMockState,
+			disableFilters: true,
+			variables: mockVariables,
+		};
+
+		const filledComponents = fillComponents(
+			components as LunaticComponentDefinition[],
+			mockState as unknown as FillComponentArgs
+		) as any;
+
+		const question = filledComponents[0];
+
+		expect(question.componentType).toBe('Question');
+		expect(question.readOnly).toBe(true);
+
+		const input = question.components[0];
+		expect(input.readOnly).toBe(true);
+	});
 });

package/src/use-lunatic/commons/fill-components/fill-components.ts

@@ -38,12 +38,24 @@ export const fillComponent = (
 	component: LunaticComponentDefinition,
 	state: FillComponentArgs,
 	// the given parentConditionFilter is typed as VTLScalarExpression, but it's actually a boolean or undefined
-	parentConditionFilter?: any
+	parentConditionFilter?: any,
+	// the given parentReadonly is typed as VTLScalarExpression, but it's actually a boolean or undefined
+	parentReadOnly?: any
 ): LunaticComponentProps & { conditionFilter?: boolean } => {
 	const interpretedProps = fillComponentExpressions(component, state);
 
 	const shouldParentBeFiltered = parentConditionFilter === false;
 
+	const isParentReadOnly = parentReadOnly === true;
+
+	// if a parent component is readOnly, then the children also are
+	const readOnly =
+		isParentReadOnly ||
+		('conditionReadOnly' in interpretedProps
+			? interpretedProps.conditionReadOnly
+			: false);
+
+	// if a parent component is filtered, then the children also are
 	const shouldBeFiltered =
 		shouldParentBeFiltered ||
 		('conditionFilter' in interpretedProps
@@ -60,6 +72,7 @@ export const fillComponent = (
 		shortcut: state.shortcut,
 		goNextPage: state.goNextPage,
 		goPreviousPage: state.goPreviousPage,
+		readOnly: readOnly,
 		shouldBeFiltered: shouldBeFiltered,
 		iteration: state.pager.iteration,
 		required: 'isMandatory' in component ? component.isMandatory : false,
@@ -89,7 +102,8 @@ export function fillComponents(
 	components: LunaticComponentDefinition[],
 	state: FillComponentArgs,
 	parentType?: LunaticComponentDefinition['componentType'],
-	parentConditionFilter?: VTLScalarExpression
+	parentConditionFilter?: VTLScalarExpression,
+	parentReadOnly?: VTLScalarExpression
 ): LunaticComponentProps[] {
 	// Flatmap to directly remove FilterDescription components if disableFiltersDescription is true
 	const filledComponents = components.flatMap((component) => {
@@ -100,7 +114,9 @@ export function fillComponents(
 			return [];
 		}
 
-		return [fillComponent(component, state, parentConditionFilter)];
+		return [
+			fillComponent(component, state, parentConditionFilter, parentReadOnly),
+		];
 	});
 
 	if (state.disableFilters) {

package/src/use-lunatic/hooks/use-page-has-response.ts

@@ -1,7 +1,7 @@
 import { useCallback } from 'react';
-import { isObject } from '../../utils/is-object';
 import type { LunaticComponentDefinition, LunaticReducerState } from '../type';
 import type { LunaticComponentProps } from '../../components/type';
+import { isObject } from '../../utils/object';
 
 /**
  * Check if a page has one response (value is filled for at least one field).

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

@@ -1,8 +1,9 @@
 import { renderHook } from '@testing-library/react';
 import { describe, expect, it } from 'vitest';
-import source from '../../stories/overview/sourceWithHierarchy.json';
+import source from '../../stories/behaviour/overview/source.json';
 import { useLunatic } from '../use-lunatic';
-import { dataFromObject } from '../test.utils';
+
+import { dataFromObject } from '../../utils/object';
 
 describe('use-overview test with useLunatic()', () => {
 	it('should initialize correctly with disableFilters: false (without data)', () => {

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

@@ -49,7 +49,8 @@ function getChildComponents(
 			component.components,
 			state,
 			undefined,
-			component.conditionFilter
+			component.conditionFilter,
+			component.conditionReadOnly
 		),
 	};
 }

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

@@ -1,25 +1,19 @@
 import { act, renderHook } from '@testing-library/react';
 import { beforeEach, describe, expect, it, vi } from 'vitest';
 
-import sourceWithoutHierarchy from '../stories/overview/source.json';
 import sourceLogement from '../stories/questionnaires/logement/source.json';
 import sourceSimpsons from '../stories/questionnaires/simpsons/source.json';
-import sourceOverview from '../stories/overview/sourceLoop.json';
-import sourceCheckboxGroup from '../stories/checkbox-group/source.json';
-import dataOverview from '../stories/overview/dataLoop.json';
+import sourceOverview from '../stories/behaviour/overview/sourceLoop.json';
+import sourceCheckboxGroup from '../stories/checkbox/sourceGroup.json';
 import sourceCleaningLoop from '../stories/behaviour/cleaning/source-loop.json';
 import sourceCleaningResizing from '../stories/behaviour/resizing/source-resizing-cleaning.json';
 import type { PageTag } from './type';
 import { useLunatic } from './use-lunatic';
 import { useCallback } from 'react';
-import { dataFromObject } from './test.utils';
+import { dataFromObject } from '../utils/object';
 
 describe('use-lunatic()', () => {
-	const defaultParams = [
-		sourceSimpsons as any,
-		dataFromObject({}),
-		{},
-	] as const;
+	const defaultParams = [sourceSimpsons, dataFromObject({}), {}] as const;
 
 	it('should initialize correctly', () => {
 		const { result } = renderHook(() => useLunatic(...defaultParams));
@@ -39,7 +33,7 @@ describe('use-lunatic()', () => {
 	});
 	it('should jump to a specific page', () => {
 		const params = [
-			sourceSimpsons as any,
+			sourceSimpsons,
 			dataFromObject({
 				COMMENT: 'Hello world',
 				READY: true,
@@ -102,7 +96,7 @@ describe('use-lunatic()', () => {
 		it('should not generate a new Provider every render', () => {
 			const { result } = renderHook(() => {
 				const missingStrategy = useCallback(() => {}, []);
-				return useLunatic(sourceSimpsons as any, undefined, {
+				return useLunatic(sourceSimpsons, undefined, {
 					management: false,
 					missing: false,
 					missingStrategy,
@@ -146,7 +140,7 @@ describe('use-lunatic()', () => {
 		it('should not calculate overview by default', function () {
 			const { result } = renderHook(() =>
 				useLunatic(
-					sourceLogement as any,
+					sourceLogement,
 					undefined,
 					lunaticConfigurationWithoutOverview
 				)
@@ -156,7 +150,7 @@ describe('use-lunatic()', () => {
 		});
 		it('should make the first sequence visible', function () {
 			const { result } = renderHook(() =>
-				useLunatic(sourceLogement as any, undefined, {
+				useLunatic(sourceLogement, undefined, {
 					...lunaticConfiguration,
 				})
 			);
@@ -167,11 +161,7 @@ describe('use-lunatic()', () => {
 		});
 		it('should be empty when no hierarchy', function () {
 			const { result } = renderHook(() =>
-				useLunatic(
-					sourceWithoutHierarchy as any,
-					undefined,
-					lunaticConfiguration
-				)
+				useLunatic(sourceCheckboxGroup, undefined, lunaticConfiguration)
 			);
 			expect(result.current.overview).toHaveLength(0);
 		});
@@ -179,7 +169,7 @@ describe('use-lunatic()', () => {
 		describe('with initial data', function () {
 			it('should make second sequence visible', function () {
 				const { result } = renderHook(() =>
-					useLunatic(sourceLogement as any, advancedQestionnaireData, {
+					useLunatic(sourceLogement, advancedQestionnaireData, {
 						...lunaticConfiguration,
 						initialPage: '16',
 					})
@@ -192,19 +182,42 @@ describe('use-lunatic()', () => {
 		});
 
 		describe('with loop', function () {
+			const data = dataFromObject({
+				ETAT: '1',
+				SATISFAIT: '1',
+				T_NHAB: 3,
+				T_PRENOM: ['Quentin', 'Luna', 'Paul'],
+				COMMCOMPO: 'super',
+				T_SEXE: ['1', '2', '1'],
+				T_DATENAIS: [null, null, null],
+				REMARQUES: [null, 'a', 'b'],
+				SUPERQUEST: ['ok', 'ok', null],
+				AUTRESUPERQUEST: ['a', 'c', 'ras'],
+				ENCOREUNEQ: ['wow', 'b', null],
+				COMMENT_QE: null,
+				ETAT_MISSING: null,
+				SATISFAIT_MISSING: null,
+				T_NHAB_MISSING: null,
+				T_PRENOM_MISSING: null,
+				COMMCOMPO_MISSING: null,
+				T_SEXE_MISSING: null,
+				T_DATENAIS_MISSING: [null, 'DK', 'RF'],
+				REMARQUES_MISSING: [null, null, null],
+				SUPERQUEST_MISSING: [null, null, 'DK'],
+				ENCOREUNEQ_MISSING: [null, null, 'RF'],
+				AUTRESUPERQUEST_MISSING: null,
+				COMMENT_QE_MISSING: null,
+			});
+
 			it('should work with loop', async () => {
 				const { result } = renderHook(() =>
-					useLunatic(
-						sourceOverview as any,
-						dataOverview.data,
-						lunaticConfiguration
-					)
+					useLunatic(sourceOverview, data, lunaticConfiguration)
 				);
 				expect(result.current.overview).toMatchSnapshot();
 			});
 			it('should handle initialPage', async () => {
 				const { result } = renderHook(() =>
-					useLunatic(sourceOverview as any, dataOverview.data, {
+					useLunatic(sourceOverview, data, {
 						...lunaticConfiguration,
 						initialPage: '10.1#1',
 					})
@@ -230,7 +243,7 @@ describe('use-lunatic()', () => {
 		it('should filter out some components by default', function () {
 			const { result } = renderHook(() =>
 				useLunatic(
-					sourceLogement as any,
+					sourceLogement,
 					undefined,
 					lunaticConfigurationWithoutDisableFilters
 				)
@@ -241,7 +254,7 @@ describe('use-lunatic()', () => {
 		});
 		it('should filter out some components when false', function () {
 			const { result } = renderHook(() =>
-				useLunatic(sourceLogement as any, undefined, {
+				useLunatic(sourceLogement, undefined, {
 					...lunaticConfigurationWithoutDisableFilters,
 					disableFilters: false,
 				})
@@ -252,7 +265,7 @@ describe('use-lunatic()', () => {
 		});
 		it('should not filter any component when true', function () {
 			const { result } = renderHook(() =>
-				useLunatic(sourceLogement as any, undefined, {
+				useLunatic(sourceLogement, undefined, {
 					...lunaticConfigurationWithoutDisableFilters,
 					disableFilters: true,
 				})
@@ -269,7 +282,7 @@ describe('use-lunatic()', () => {
 	describe('cleaning', () => {
 		it('should handle cleaning in a loop', () => {
 			const { result } = renderHook(() =>
-				useLunatic(sourceCleaningLoop as any, undefined)
+				useLunatic(sourceCleaningLoop, undefined)
 			);
 			act(() => {
 				result.current.handleChanges([
@@ -284,9 +297,9 @@ describe('use-lunatic()', () => {
 				result.current.goNextPage();
 			});
 			const expectCollectedAgeToEqual = (expectation: unknown[]) => {
-				expect(
-					(result.current.getData(false).COLLECTED as any).AGE.COLLECTED
-				).toEqual(expectation);
+				expect(result.current.getData(false).COLLECTED?.AGE.COLLECTED).toEqual(
+					expectation
+				);
 			};
 			expectCollectedAgeToEqual([18, 18, 18]);
 			act(() => {
@@ -306,17 +319,17 @@ describe('use-lunatic()', () => {
 		it('should resize after cleaning', () => {
 			const spy = vi.fn();
 			const { result } = renderHook(() =>
-				useLunatic(sourceCleaningResizing as any, undefined, {
+				useLunatic(sourceCleaningResizing, undefined, {
 					onChange: spy,
 				})
 			);
 			act(() => result.current.handleChanges([{ name: 'NB', value: 3 }]));
 			expect(
-				(result.current.getData(true).COLLECTED?.PRENOMS as any).COLLECTED
+				result.current.getData(true).COLLECTED?.PRENOMS?.COLLECTED
 			).toEqual([null, null, null]);
 			act(() => result.current.handleChanges([{ name: 'NB', value: 2 }]));
 			expect(
-				(result.current.getData(true).COLLECTED?.PRENOMS as any).COLLECTED
+				result.current.getData(true).COLLECTED?.PRENOMS?.COLLECTED
 			).toEqual([null, null]);
 		});
 	});
@@ -325,7 +338,7 @@ describe('use-lunatic()', () => {
 		let hookRef: { current: ReturnType<typeof useLunatic> };
 		beforeEach(() => {
 			const { result } = renderHook(() =>
-				useLunatic(sourceSimpsons as any, undefined, {})
+				useLunatic(sourceSimpsons, undefined, {})
 			);
 			act(() => {
 				result.current.handleChanges([
@@ -353,7 +366,7 @@ describe('use-lunatic()', () => {
 		let hookRef: { current: ReturnType<typeof useLunatic> };
 		beforeEach(() => {
 			const { result } = renderHook(() =>
-				useLunatic(sourceSimpsons as any, undefined, { trackChanges: true })
+				useLunatic(sourceSimpsons, undefined, { trackChanges: true })
 			);
 			hookRef = result;
 		});
@@ -425,7 +438,7 @@ describe('use-lunatic()', () => {
 	describe('pageHasResponse', () => {
 		it('should detect change on a field', () => {
 			const { result } = renderHook(() =>
-				useLunatic(sourceCheckboxGroup as any, undefined, {})
+				useLunatic(sourceCheckboxGroup, undefined, {})
 			);
 			act(() => {
 				result.current.handleChanges([{ name: 'NATIO1N1', value: true }]);
@@ -434,7 +447,7 @@ describe('use-lunatic()', () => {
 		});
 		it('should not detect unchecked box has a response', () => {
 			const { result } = renderHook(() =>
-				useLunatic(sourceCheckboxGroup as any, undefined, {})
+				useLunatic(sourceCheckboxGroup, undefined, {})
 			);
 			act(() => {
 				result.current.handleChanges([{ name: 'NATIO1N1', value: false }]);

package/src/utils/number.ts

@@ -31,3 +31,16 @@ export function between(n: number, min: number, max: number): number {
 export function isNumber(n: unknown): n is number {
 	return typeof n === 'number' && Number.isFinite(n);
 }
+
+/**
+ * Convert an unknown value into a number
+ */
+export function toNumber(v: unknown): number | null {
+	if (typeof v === 'number') {
+		return v;
+	}
+	if (typeof v === 'string') {
+		return parseInt(v, 10);
+	}
+	return null;
+}

package/src/utils/object.ts

@@ -1,3 +1,5 @@
+import { LunaticData } from '../use-lunatic/type';
+
 /**
  * Array.map() but for objet
  */
@@ -18,6 +20,21 @@ export function objectMap<T extends Record<string, any>, V>(
 		{} as Record<keyof T, V>
 	);
 }
+
+/**
+ * Filter items from an object
+ */
+export function objectFilter<T extends Record<string, any>>(
+	object: T,
+	callback: (k: keyof T, v: T[keyof T]) => boolean
+): T {
+	return Object.fromEntries(
+		Object.entries(object).filter(([k, v]) => {
+			return callback(k, v);
+		})
+	) as T;
+}
+
 // Adds the possibility of preserving the original type of the object's keys.
 // The native function produces an array of strings. (Object.keys)
 export function objectKeys<T extends Record<string, unknown>>(object: T) {
@@ -33,3 +50,26 @@ export function mergeDefault<
 		return [k, obj[k] ?? defaults[k]] as const;
 	});
 }
+
+export const dataFromObject = (o: Record<string, unknown>): LunaticData => {
+	return {
+		EXTERNAL: {},
+		COLLECTED: Object.keys(o).reduce(
+			(acc, k) => ({
+				...acc,
+				[k]: {
+					COLLECTED: o[k],
+				},
+			}),
+			{}
+		),
+		CALCULATED: {},
+	};
+};
+
+/**
+ * isObject function with type narrowing
+ */
+export function isObject(v: unknown): v is Record<string, unknown> {
+	return typeof v === 'object' && v !== null;
+}