@inseefr/lunatic 3.4.10-rc.1 → 3.4.11-rc.0

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

@@ -1855,329 +1855,6 @@ exports[`use-lunatic() > overview > with loop > should handle initialPage 1`] =
 ]
 `;
 
-exports[`use-lunatic() > overview > with loop > should handle lastReachedPage 1`] = `
-[
-  {
-    "children": [
-      {
-        "children": [],
-        "current": false,
-        "description": undefined,
-        "id": "lujqeci5",
-        "label": <MDLabel
-          expression="Votre santé"
-        />,
-        "page": "2",
-        "reached": true,
-        "type": "Subsequence",
-      },
-      {
-        "children": [],
-        "current": false,
-        "description": undefined,
-        "id": "lujqbyzl",
-        "label": <MDLabel
-          expression="Votre logement"
-        />,
-        "page": "3",
-        "reached": true,
-        "type": "Subsequence",
-      },
-    ],
-    "current": true,
-    "description": undefined,
-    "id": "lujqfpva",
-    "label": <MDLabel
-      expression="I - Séquence 1"
-    />,
-    "page": "1",
-    "reached": true,
-    "type": "Sequence",
-  },
-  {
-    "children": [
-      {
-        "children": [],
-        "current": false,
-        "description": undefined,
-        "id": "lulbmyhr",
-        "label": <MDLabel
-          expression="Commentaire sur composition du logement"
-        />,
-        "page": "8",
-        "reached": true,
-        "type": "Subsequence",
-      },
-    ],
-    "current": false,
-    "description": undefined,
-    "id": "lujqrqmp",
-    "label": <MDLabel
-      expression="II - Habitants du logement"
-    />,
-    "page": "5",
-    "reached": true,
-    "type": "Sequence",
-  },
-  {
-    "children": [
-      {
-        "children": [],
-        "current": false,
-        "description": undefined,
-        "id": "lujykwaz",
-        "label": <MDLabel
-          expression="Caractéristiques de Quentin"
-        />,
-        "page": "10.1#1",
-        "reached": true,
-        "type": "Subsequence",
-      },
-      {
-        "children": [],
-        "current": false,
-        "description": undefined,
-        "id": "lujykwaz",
-        "label": <MDLabel
-          expression="Caractéristiques de Luna"
-        />,
-        "page": "10.1#2",
-        "reached": true,
-        "type": "Subsequence",
-      },
-      {
-        "children": [],
-        "current": false,
-        "description": undefined,
-        "id": "lujykwaz",
-        "label": <MDLabel
-          expression="Caractéristiques de Paul"
-        />,
-        "page": "10.1#3",
-        "reached": true,
-        "type": "Subsequence",
-      },
-      {
-        "children": [],
-        "current": false,
-        "description": undefined,
-        "id": "lujyik5q",
-        "label": <MDLabel
-          expression="Autres caractéristiques de Luna : filtrée pour le premier individu"
-        />,
-        "page": "11.1#2",
-        "reached": true,
-        "type": "Subsequence",
-      },
-      {
-        "children": [],
-        "current": false,
-        "description": undefined,
-        "id": "luk0swcz",
-        "label": <MDLabel
-          expression="Encore d'autres caractéristiques de Luna : filtrée pour le premier individu"
-        />,
-        "page": "11.2#2",
-        "reached": true,
-        "type": "Subsequence",
-      },
-      {
-        "children": [],
-        "current": false,
-        "description": undefined,
-        "id": "lujyik5q",
-        "label": <MDLabel
-          expression="Autres caractéristiques de Paul : filtrée pour le premier individu"
-        />,
-        "page": "11.1#3",
-        "reached": false,
-        "type": "Subsequence",
-      },
-      {
-        "children": [],
-        "current": false,
-        "description": undefined,
-        "id": "luk0swcz",
-        "label": <MDLabel
-          expression="Encore d'autres caractéristiques de Paul : filtrée pour le premier individu"
-        />,
-        "page": "11.2#3",
-        "reached": false,
-        "type": "Subsequence",
-      },
-    ],
-    "current": false,
-    "description": undefined,
-    "id": "lujyi4pe",
-    "label": <MDLabel
-      expression="III - Détail des individus"
-    />,
-    "page": "9",
-    "reached": true,
-    "type": "Sequence",
-  },
-  {
-    "children": [
-      {
-        "children": [],
-        "current": false,
-        "description": undefined,
-        "id": "lumfc98o",
-        "label": <MDLabel
-          expression="Belle sous-séquence pour Quentin"
-        />,
-        "page": "12.2#1",
-        "reached": false,
-        "type": "Subsequence",
-      },
-      {
-        "children": [],
-        "current": false,
-        "description": undefined,
-        "id": "lumfe3bj",
-        "label": <MDLabel
-          expression="Autre belle sous-seq"
-        />,
-        "page": "12.3#1",
-        "reached": false,
-        "type": "Subsequence",
-      },
-    ],
-    "current": false,
-    "description": undefined,
-    "id": "luk1ojt5",
-    "label": <MDLabel
-      expression="IV - Belle séquence pour Quentin"
-    />,
-    "page": "12.1#1",
-    "reached": false,
-    "type": "Sequence",
-  },
-  {
-    "children": [],
-    "current": false,
-    "description": undefined,
-    "id": "lulbelgr",
-    "label": <MDLabel
-      expression="V - Autre séquence pour Quentin"
-    />,
-    "page": "12.4#1",
-    "reached": false,
-    "type": "Sequence",
-  },
-  {
-    "children": [
-      {
-        "children": [],
-        "current": false,
-        "description": undefined,
-        "id": "lumfc98o",
-        "label": <MDLabel
-          expression="Belle sous-séquence pour Luna"
-        />,
-        "page": "12.2#2",
-        "reached": false,
-        "type": "Subsequence",
-      },
-      {
-        "children": [],
-        "current": false,
-        "description": undefined,
-        "id": "lumfe3bj",
-        "label": <MDLabel
-          expression="Autre belle sous-seq"
-        />,
-        "page": "12.3#2",
-        "reached": false,
-        "type": "Subsequence",
-      },
-    ],
-    "current": false,
-    "description": undefined,
-    "id": "luk1ojt5",
-    "label": <MDLabel
-      expression="IV - Belle séquence pour Luna"
-    />,
-    "page": "12.1#2",
-    "reached": false,
-    "type": "Sequence",
-  },
-  {
-    "children": [],
-    "current": false,
-    "description": undefined,
-    "id": "lulbelgr",
-    "label": <MDLabel
-      expression="V - Autre séquence pour Luna"
-    />,
-    "page": "12.4#2",
-    "reached": false,
-    "type": "Sequence",
-  },
-  {
-    "children": [
-      {
-        "children": [],
-        "current": false,
-        "description": undefined,
-        "id": "lumfc98o",
-        "label": <MDLabel
-          expression="Belle sous-séquence pour Paul"
-        />,
-        "page": "12.2#3",
-        "reached": false,
-        "type": "Subsequence",
-      },
-      {
-        "children": [],
-        "current": false,
-        "description": undefined,
-        "id": "lumfe3bj",
-        "label": <MDLabel
-          expression="Autre belle sous-seq"
-        />,
-        "page": "12.3#3",
-        "reached": false,
-        "type": "Subsequence",
-      },
-    ],
-    "current": false,
-    "description": undefined,
-    "id": "luk1ojt5",
-    "label": <MDLabel
-      expression="IV - Belle séquence pour Paul"
-    />,
-    "page": "12.1#3",
-    "reached": false,
-    "type": "Sequence",
-  },
-  {
-    "children": [],
-    "current": false,
-    "description": undefined,
-    "id": "lulbelgr",
-    "label": <MDLabel
-      expression="V - Autre séquence pour Paul"
-    />,
-    "page": "12.4#3",
-    "reached": false,
-    "type": "Sequence",
-  },
-  {
-    "children": [],
-    "current": false,
-    "description": undefined,
-    "id": "COMMENT-SEQ",
-    "label": <MDLabel
-      expression="Commentaire"
-    />,
-    "page": "13",
-    "reached": false,
-    "type": "Sequence",
-  },
-]
-`;
-
 exports[`use-lunatic() > overview > with loop > should work with loop 1`] = `
 [
   {

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

@@ -35,7 +35,8 @@ const isLoopComponent = (
 };
 
 /**
- * Check if components of the current page have errors, and return a map of error (indexed by component ID)
+ * Check if components of the current page have errors, and return a map of
+ * errors (indexed by component ID).
  */
 function checkComponents(
 	state: StateForControls,
@@ -93,7 +94,7 @@ function checkControls(
 }
 
 /**
- * Figure out the number of iterations of a component
+ * Figure out the number of iterations of a component.
  */
 function computeIterations(
 	component: InterpretedComponent | ComponentDefinition,
@@ -210,7 +211,7 @@ function hasCriticalError(errors?: Record<string, LunaticError[]>): boolean {
 }
 
 /**
- * Check controls for currently visible components and output errors
+ * Check controls for currently visible components and output errors.
  */
 export function compileControls(state: StateForControls) {
 	const components = replaceComponentSequence(getComponentsFromState(state));

package/src/use-lunatic/commons/variables/behaviours/resizing-behaviour.ts

@@ -1,9 +1,8 @@
 import type { LunaticVariablesStore } from '../lunatic-variables-store';
 import type { LunaticSource } from '../../../type';
 import { forceInt } from '../../../../utils/number';
-import { resizeArrayVariable } from '../../../reducer/commons';
 import { getExpressionAsString } from '../../../../utils/vtl';
-import { resizeArray } from '../../../../utils/array';
+import { resizeArray, resizeDownArrayWithIndex } from '../../../../utils/array';
 
 /**
  * Resizing behaviour for the store
@@ -42,8 +41,20 @@ export function resizingBehaviour(
 		const newSize = forceInt(store.run(resizingInfo.size));
 		for (const variableName of resizingInfo.variables) {
 			const value = store.get(variableName);
-			if (!Array.isArray(value) || value.length !== newSize) {
-				store.set(variableName, resizeArrayVariable(value, newSize, null), {
+			if (Array.isArray(value) && e.detail.removedIndex) {
+				store.set(
+					variableName,
+					resizeDownArrayWithIndex(value, e.detail.removedIndex),
+					{
+						cause: 'resizing',
+					}
+				);
+			}
+			if (
+				!e.detail.removedIndex &&
+				(!Array.isArray(value) || value.length !== newSize)
+			) {
+				store.set(variableName, resizeArray(value, newSize, null), {
 					cause: 'resizing',
 				});
 			}
@@ -61,6 +72,7 @@ function resizePairwise(
 	},
 	args: {
 		iteration?: number[];
+		removedIndex?: number;
 	}
 ) {
 	// Handle expression being sent as an array or an object (ensure backward compatibility)
@@ -78,12 +90,25 @@ function resizePairwise(
 	});
 	resizingInfo.linksVariables.forEach((variable) => {
 		const value = store.get(variable, args.iteration);
-		const resizedValue = resizeArray(
-			// The value is not an array, force an array
-			Array.isArray(value) ? value.map((i) => resizeArray(i, ySize, null)) : [],
-			xSize,
-			new Array(ySize).fill(null)
-		);
+		let resizedValue;
+		if (args.removedIndex) {
+			const removedIndex = args.removedIndex;
+			resizedValue = resizeDownArrayWithIndex(
+				Array.isArray(value)
+					? value.map((i) => resizeDownArrayWithIndex(i, removedIndex))
+					: [],
+				removedIndex
+			);
+		} else {
+			resizedValue = resizeArray(
+				// The value is not an array, force an array
+				Array.isArray(value)
+					? value.map((i) => resizeArray(i, ySize, null))
+					: [],
+				xSize,
+				new Array(ySize).fill(null)
+			);
+		}
 		store.set(variable, resizedValue);
 	});
 }

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

@@ -281,6 +281,28 @@ describe('lunatic-variables-store', () => {
 				cause: 'resizing',
 			});
 		});
+
+		it('should resize variables with Index', () => {
+			variables.set('PRENOM', ['John', 'Jane', 'Marc']);
+			variables.set('AGE', [20, 30, 40]);
+			const spy = vi.fn();
+			variables.on('change', (e) => spy(e.detail));
+			resizingBehaviour(variables, {
+				PRENOM: {
+					size: 'count(PRENOM)',
+					variables: ['AGE'],
+				},
+			});
+			variables.set('PRENOM', ['John', 'Marc'], { removedIndex: 1 });
+			expect((variables.get('PRENOM') as string[]).length).toEqual(2);
+			expect((variables.get('AGE') as string[]).length).toEqual(2);
+			expect(spy).toHaveBeenLastCalledWith({
+				name: 'AGE',
+				value: [20, 40],
+				cause: 'resizing',
+			});
+		});
+
 		it('should resize pairwise with the array syntax', () => {
 			variables.set('PRENOM', []);
 			variables.set('LINKS', [[]]);
@@ -316,7 +338,29 @@ describe('lunatic-variables-store', () => {
 				[null, null, null],
 			]);
 		});
-		it('should handle both pairwise and normal resize', () => {
+		it('should resize pairwise with the object syntax with index', () => {
+			variables.set('PRENOM', ['John', 'Jane', 'Marc']);
+			variables.set('LINKS', [
+				[null, 2, 4],
+				[1, null, 2],
+				[3, 2, null],
+			]);
+			resizingBehaviour(variables, {
+				PRENOM: {
+					sizeForLinksVariables: {
+						xAxisSize: 'count(PRENOM)',
+						yAxisSize: 'count(PRENOM)',
+					},
+					linksVariables: ['LINKS'],
+				},
+			});
+			variables.set('PRENOM', ['John', 'Marc'], { removedIndex: 1 });
+			expect(variables.get('LINKS') as string[][]).toEqual([
+				[null, 4],
+				[3, null],
+			]);
+		});
+		it('should handle both: pairwise and normal resize', () => {
 			variables.set('PRENOM', []);
 			variables.set('NOM', []);
 			variables.set('LINKS', [[]]);
@@ -336,6 +380,29 @@ describe('lunatic-variables-store', () => {
 			]);
 			expect(variables.get('NOM') as string[]).toEqual([null, null, null]);
 		});
+		it('should handle both: pairwise and normal resize with index', () => {
+			variables.set('PRENOM', ['John', 'Jane', 'Marc']);
+			variables.set('AGE', [40, 30, 20]);
+			variables.set('LINKS', [
+				[null, 2, 4],
+				[1, null, 2],
+				[3, 2, null],
+			]);
+			resizingBehaviour(variables, {
+				PRENOM: {
+					sizeForLinksVariables: ['count(PRENOM)', 'count(PRENOM)'],
+					linksVariables: ['LINKS'],
+					size: 'count(PRENOM)',
+					variables: ['AGE'],
+				},
+			});
+			variables.set('PRENOM', ['John', 'Marc'], { removedIndex: 1 });
+			expect(variables.get('LINKS') as string[][]).toEqual([
+				[null, 4],
+				[3, null],
+			]);
+			expect(variables.get('AGE') as string[]).toEqual([40, 20]);
+		});
 	});
 
 	describe('cleaning', () => {

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

@@ -19,23 +19,25 @@ import {
 	VTLMissingDependency,
 } from './errors';
 
-// Interpret counter, used for testing purpose
+/** Interpret counter. Used for testing purpose. */
 let interpretCount = 0;
-// Special variable that will take the current iteration value
+/** Special variable that will take the current iteration value. */
 const iterationVariableName = 'GLOBAL_ITERATION_INDEX';
 
 type IterationLevel = number[];
 export type EventArgs = {
 	change: {
-		// Name of the changed variable
+		/** Name of the changed variable. */
 		name: string;
-		// New value for the variable
+		/** New value for the variable. */
 		value: unknown;
-		// Iteration changed (for array)
+		/** Iteration changed (for array). */
 		iteration?: IterationLevel | undefined;
-		// What triggered this change
+		/** removedIndex: when resize an array directly with only one handleChange (remove one line in tableLoop) */
+		removedIndex?: number;
+		/** What triggered this change. */
 		cause?: 'resizing' | 'cleaning';
-		// Extra sent when setting the variable
+		/** Extra sent when setting the variable. */
 		[extra: string]: unknown;
 	};
 };
@@ -123,7 +125,7 @@ export class LunaticVariablesStore {
 	public set(
 		name: string,
 		value: unknown,
-		args: Pick<EventArgs['change'], 'iteration' | 'cause'> = {}
+		args: Pick<EventArgs['change'], 'iteration' | 'cause' | 'removedIndex'> = {}
 	): LunaticVariable {
 		if (!this.dictionary.has(name)) {
 			this.dictionary.set(
@@ -220,7 +222,7 @@ export class LunaticVariablesStore {
 		this.eventTarget.removeEventListener(eventName, cb as EventListener);
 	}
 
-	// Retrieve the number of interpret() run (used in testing only)
+	/** Retrieve the number of interpret() run (used in testing only). */
 	get interpretCount() {
 		return interpretCount;
 	}
@@ -249,25 +251,25 @@ export class LunaticVariablesStore {
 }
 
 class LunaticVariable {
-	// Last time the value was updated (changed)
+	/** Last time the value was updated (changed). */
 	public updatedAt = new Map<undefined | string, number>();
-	// Last time "calculation" was run (for calculated variable)
+	/** Last time "calculation" was run (for calculated variable). */
 	private calculatedAt = new Map<undefined | string, number>();
-	// Internal value for the variable
+	/** Internal value for the variable. */
 	private value: unknown;
-	// List of dependencies, ex: ['FIRSTNAME', 'LASTNAME']
+	/** List of dependencies, ex: ['FIRSTNAME', 'LASTNAME']. */
 	private dependencies?: string[];
-	// Expression for calculated variable
+	/** Expression for calculated variable. */
 	public readonly expression?: string;
-	// Dictionary holding all the available variables
+	/** Dictionary holding all the available variables. */
 	private readonly dictionary?: Map<string, LunaticVariable>;
-	// Specific iteration depth to get value from dependencies (used for yAxis for instance)
+	/** Specific iteration depth to get value from dependencies (used for yAxis for instance). */
 	private readonly iterationDepth?: number;
-	// For calculated variable, shape is copied from another variable
+	/** For calculated variable, shape is copied from another variable. */
 	private readonly shapeFrom?: string[];
-	// Keep a record of variable name (optional, used for debug)
+	/** Keep a record of variable name (optional, used for debug). */
 	public readonly name?: string;
-	// Count the number of calculation
+	/** Count the number of calculation. */
 	public calculatedCount = 0;
 
 	constructor(

package/src/use-lunatic/hooks/use-loop-variables.ts

@@ -2,7 +2,7 @@ import type { LunaticComponentDefinition, LunaticReducerState } from '../type';
 import { useMemo } from 'react';
 
 /**
- * Extract the list of variables used for the current loop
+ * Extract the list of variables used for the current loop.
  */
 export function useLoopVariables(
 	pager: LunaticReducerState['pager'],

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

@@ -4,7 +4,7 @@ import type { LunaticComponentDefinition, LunaticReducerState } from '../type';
 import type { LunaticComponentProps } from '../../components/type';
 
 /**
- * Check if a page has one response (value is filled for at least one field)
+ * Check if a page has one response (value is filled for at least one field).
  */
 export function usePageHasResponse(
 	components: LunaticComponentProps[],
@@ -67,10 +67,10 @@ export function usePageHasResponse(
 }
 
 /**
- * Check if a value is empty
- * - null ou undefined ou ''
- * - for arrays, every item must be empty
- * - for objects, every value must be empty
+ * Check if a value is empty.
+ * - `null`, `undefined` or `''`.
+ * - for arrays, every item must be empty.
+ * - for objects, every value must be empty.
  */
 function isEmpty(value: unknown): boolean {
 	// Array is empty if all items are empty
@@ -86,7 +86,7 @@ function isEmpty(value: unknown): boolean {
 }
 
 /**
- * For complex component we need to inspect child components, interpret the response value
+ * For complex component we need to inspect child components, interpret the response value.
  */
 function isSubComponentsEmpty(
 	components: (LunaticComponentProps | LunaticComponentDefinition)[],

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

@@ -18,7 +18,7 @@ export type InterpretedLunaticOverviewItem = {
 };
 
 /**
- * Hook to build a filled overview everytime the deps change
+ * Build a filled overview everytime the deps change.
  */
 export const useOverview = (
 	{
@@ -36,7 +36,7 @@ export const useOverview = (
 };
 
 /**
- * Use lunatic data to interpret the static overview (calculated on init) with the real data
+ * Use Lunatic data to interpret the static overview (calculated on init) with the real data.
  */
 const interpretOverview = (
 	overviewItems: LunaticOverviewItem[],
@@ -71,7 +71,7 @@ const interpretOverview = (
 };
 
 /**
- * Interpret expression inside an item (label & condition)
+ * Interpret expression inside an item (label & condition).
  */
 const interpretOverviewItem = (
 	items: InterpretedLunaticOverviewItem[],
@@ -127,7 +127,7 @@ const interpretOverviewItem = (
 };
 
 /**
- * Set the current property in the correct overview item
+ * Set the current property in the correct overview item.
  */
 const applyCurrentPage = (
 	items: InterpretedLunaticOverviewItem[],