@inseefr/lunatic 3.5.6 → 3.5.8

package/src/stories/utils/OrchestratorSidebar.tsx

@@ -0,0 +1,119 @@
+import type { useLunatic } from '../../use-lunatic/use-lunatic';
+import { objectKeys } from '../../utils/object';
+import type { PropsWithChildren } from 'react';
+
+type Props = PropsWithChildren<
+	Pick<
+		ReturnType<typeof useLunatic>,
+		| 'goPreviousPage'
+		| 'goNextPage'
+		| 'goToPage'
+		| 'isLastPage'
+		| 'isFirstPage'
+		| 'pageTag'
+		| 'pager'
+	>
+> & {
+	hasPageResponse: unknown;
+	onLogData: () => void;
+	onLogComponents: () => void;
+};
+
+export function OrchestratorSidebar({
+	goPreviousPage,
+	goNextPage,
+	goToPage,
+	isLastPage,
+	isFirstPage,
+	pageTag,
+	pager,
+	children,
+	hasPageResponse,
+	onLogData,
+	onLogComponents,
+}: Props) {
+	return (
+		<aside className="space-y-4 card card-border border-base-300 p-2">
+			<div className="space-y-4">
+				{/* Next / Prev button */}
+				<div>
+					<div className="join mb-2 w-full">
+						<button
+							className="btn join-item btn-block shrink btn-primary"
+							onClick={goPreviousPage}
+							disabled={isFirstPage}
+						>
+							Previous
+						</button>
+						<button
+							className="btn join-item btn-block shrink btn-primary"
+							onClick={goNextPage}
+							disabled={isLastPage}
+						>
+							Next
+						</button>
+					</div>
+					<div className="textarea-sm text-base-content/70 text-center">
+						You can use PgDown / PgUp shortcut
+					</div>
+				</div>
+
+				{/* Reach a specific page */}
+				<form
+					className="join w-full"
+					onSubmit={(e) => {
+						e.preventDefault();
+						goToPage({
+							page: e.currentTarget.querySelector('input')!.valueAsNumber,
+						});
+					}}
+				>
+					<label className="input join-item">
+						<span className="label">Page</span>
+						<input type="number" placeholder="1" />
+					</label>
+					<button type="submit" className="join-item btn btn-neutral">
+						Reach
+					</button>
+				</form>
+
+				{/* Pager informations */}
+				<div>
+					<h3 className="text-lg font-bold mb-4">Pager</h3>
+					<ul className="flex flex-col">
+						<li className="flex gap-2">
+							<span>PageTag</span>
+							<span className="dot-leader">{JSON.stringify(pageTag)}</span>
+						</li>
+						{objectKeys(pager).map((key) => (
+							<li className="flex gap-2" key={key}>
+								<span>{key}</span>{' '}
+								<span className="dot-leader">{JSON.stringify(pager[key])}</span>
+							</li>
+						))}
+					</ul>
+				</div>
+			</div>
+			<div className="flex gap-2 w-full">
+				<button className="btn btn-warning grow" onClick={onLogComponents}>
+					Log components
+				</button>
+				<button className="btn btn-warning grow" onClick={onLogData}>
+					Log data
+				</button>
+			</div>
+			<div>
+				<h3 className="text-lg font-bold mb-2">Misc</h3>
+				<ul className="flex flex-col">
+					<li className="flex gap-2">
+						<span>pageHasResponse:</span>{' '}
+						<span className="dot-leader">
+							{JSON.stringify(hasPageResponse)}
+						</span>
+					</li>
+				</ul>
+			</div>
+			{children}
+		</aside>
+	);
+}

package/src/stories/utils/SchemaValidator.tsx

@@ -0,0 +1,29 @@
+import type { ErrorObject } from 'ajv';
+
+type Props = {
+	errors: ErrorObject<string, Record<string, any>, unknown>[];
+};
+
+export function SchemaValidator({ errors }: Readonly<Props>) {
+	if (!errors) {
+		return null;
+	}
+
+	return (
+		<div className="alert alert-error alert-outline text-xs">
+			<div>
+				<h4 className="mb-2">
+					<strong>{errors.length}</strong> erreurs
+				</h4>
+				<ul>
+					{errors.map((err) => (
+						<li key={err.instancePath}>
+							<strong>{err.instancePath}</strong> : {err.message}{' '}
+							<small>({err.schemaPath})</small>
+						</li>
+					))}
+				</ul>
+			</div>
+		</div>
+	);
+}

package/src/stories/utils/referentiel.ts

@@ -0,0 +1,9 @@
+import type { IndexEntry } from '../../utils/search/SearchInterface';
+
+export const getReferentiel = async (name: string) => {
+	return fetch(`./${name}.json`)
+		.then((r) => r.json())
+		.catch(() => {
+			throw new Error(`Unknown référentiel ${name}`);
+		}) as Promise<IndexEntry[]>;
+};

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;

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],
@@ -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`);
 }
 

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/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;
+}