@inseefr/lunatic 3.6.15-rc.0 → 3.6.15-rc.2

package/src/stories/behaviour/articulation/articulation.stories.tsx

@@ -1,11 +1,11 @@
 import source from './roundabout.json';
 import type { Meta, StoryObj } from '@storybook/react';
 import { useMemo, useState } from 'react';
-import { getArticulation } from '../../../utils/getArticulation';
+import { getArticulationState } from '../../../utils/getArticulationState';
 import { Orchestrator } from '../../utils/Orchestrator';
 
-type Source = Parameters<typeof getArticulation>[0];
-type Data = Parameters<typeof getArticulation>[1];
+type Source = Parameters<typeof getArticulationState>[0];
+type Data = Parameters<typeof getArticulationState>[1];
 
 type Props = {
 	source: Source;
@@ -16,7 +16,7 @@ function StoryComponent({ source, data }: Props) {
 	const [page, setPage] = useState(null as null | string);
 	const gotoNav = () => setPage(null);
 	const { items } = useMemo(
-		() => getArticulation(source, data),
+		() => getArticulationState(source, data),
 		[source, data]
 	);
 

package/src/stories/utils/Orchestrator.tsx

@@ -98,7 +98,7 @@ function OrchestratorForStories(props: Readonly<Props>) {
 		getData,
 		Provider,
 		hasPageResponse,
-		getMultiMode,
+		getMultimode,
 	} = useLunatic(source, data, {
 		initialPage,
 		disableFilters,
@@ -249,7 +249,7 @@ function OrchestratorForStories(props: Readonly<Props>) {
 					pageTag={pageTag}
 					pager={pager}
 					hasPageResponse={hasPageResponse()}
-					getMultiMode={props.multiMode ? getMultiMode : null}
+					getMultimode={props.multiMode ? getMultimode : null}
 					onLogData={() => console.log('Data', getData(true))}
 					onLogComponents={() => console.log('Components', components)}
 				>

package/src/stories/utils/OrchestratorSidebar.tsx

@@ -17,7 +17,7 @@ type Props = PropsWithChildren<
 > & {
 	hasPageResponse: unknown;
 	onLogData: () => void;
-	getMultiMode: LunaticState['getMultiMode'] | null;
+	getMultimode: LunaticState['getMultimode'] | null;
 	onLogComponents: () => void;
 };
 
@@ -30,7 +30,7 @@ export function OrchestratorSidebar({
 	pageTag,
 	pager,
 	children,
-	getMultiMode,
+	getMultimode,
 	hasPageResponse,
 	onLogData,
 	onLogComponents,
@@ -116,9 +116,9 @@ export function OrchestratorSidebar({
 					</li>
 				</ul>
 			</div>
-			{getMultiMode && (
+			{getMultimode && (
 				<div>
-					<MultiMode getMultiMode={getMultiMode} />
+					<MultiMode getMultimode={getMultimode} />
 				</div>
 			)}
 			{children}
@@ -126,10 +126,10 @@ export function OrchestratorSidebar({
 	);
 }
 
-function MultiMode(props: Pick<LunaticState, 'getMultiMode'>) {
-	const [state, setState] = useState<ReturnType<typeof props.getMultiMode>>({});
+function MultiMode(props: Pick<LunaticState, 'getMultimode'>) {
+	const [state, setState] = useState<ReturnType<typeof props.getMultimode>>({});
 	const onClick = () => {
-		setState(props.getMultiMode);
+		setState(props.getMultimode);
 	};
 	return (
 		<div className="space-y-2">

package/src/type.source.ts

@@ -1,4 +1,3 @@
-/* eslint-disable */
 /**
  * This file was automatically generated by json-schema-to-typescript.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
@@ -351,13 +350,13 @@ export type LunaticSource = {
 	multimode?: {
 		questionnaire: {
 			rules: {
-				[k: string]: VTLExpression1;
+				[k: string]: VTLExpression;
 			};
 		};
 		leaf: {
 			source: string;
 			rules: {
-				[k: string]: VTLExpression2;
+				[k: string]: VTLExpression;
 			};
 		};
 	};
@@ -501,25 +500,3 @@ export type SuggesterDefinition = {
 	 */
 	stopWords?: string[];
 };
-export type VTLExpression1 = {
-	/**
-	 * Valid VTL Expression
-	 */
-	value: string;
-	/**
-	 * Variables used in the expression
-	 */
-	bindingDependencies?: string[];
-	type: 'VTL' | 'VTL|MD' | 'TXT';
-};
-export type VTLExpression2 = {
-	/**
-	 * Valid VTL Expression
-	 */
-	value: string;
-	/**
-	 * Variables used in the expression
-	 */
-	bindingDependencies?: string[];
-	type: 'VTL' | 'VTL|MD' | 'TXT';
-};

package/src/use-lunatic/reducer/reduce-go-next-page.ts

@@ -5,6 +5,7 @@ import type { LunaticReducerState } from '../type';
 import { autoExploreLoop } from './commons/auto-explore-loop';
 import { reduceHandleChanges } from './reduce-handle-changes';
 import { ActionKind } from '../actions';
+import { ArticulationState } from '../../utils/getArticulationState';
 
 export function reduceGoNextPage(
 	state: LunaticReducerState
@@ -51,7 +52,7 @@ export function reduceGoNextPage(
 					responses: [
 						{
 							name: firstComponent.progressVariable,
-							value: 1,
+							value: ArticulationState.COMPLETED,
 							iteration: [newState.previousPager.iteration],
 						},
 					],

package/src/use-lunatic/type.ts

@@ -359,7 +359,7 @@ export type LunaticState = {
 	 */
 	handleChanges: LunaticChangesHandler;
 	/** Return the multimode state **/
-	getMultiMode: () => Record<string, boolean>;
+	getMultimode: () => Record<string, boolean>;
 };
 
 /** Function taking as arguments the various changes the user has made. */

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

@@ -33,7 +33,7 @@ import { useRefSync } from '../hooks/useRefSync';
 import { ConsoleLogger } from './logger/ConsoleLogger';
 import { useWarnDepChange } from './hooks/useWarnDepChange';
 import { useCallbackOnNextRender } from './hooks/useCallbackOnNextRender';
-import { useMultiMode } from '../hooks/useMultiMode';
+import { useMultimode } from '../hooks/useMultimode';
 
 const empty = {}; // Keep the same empty object (to avoid problem with useEffect dependencies)
 const DEFAULT_DATA = empty as LunaticData;
@@ -199,7 +199,7 @@ export function useLunatic(
 		(variableNames?: string[]) => getData(false, variableNames)
 	);
 
-	const { getMultiMode } = useMultiMode(source, state.variables);
+	const { getMultimode } = useMultimode(source, state.variables);
 
 	const pageTag = getPageTag(state.pager);
 	const { isFirstPage, isLastPage } = isFirstLastPage(state.pager);
@@ -244,6 +244,6 @@ export function useLunatic(
 		// Components
 		Provider,
 		handleChanges,
-		getMultiMode,
+		getMultimode,
 	} satisfies LunaticState;
 }

package/src/utils/{getArticulation.ts → getArticulationState.ts}

@@ -9,6 +9,12 @@ import { type ReactNode } from 'react';
 import { times } from './array';
 import { forceInt } from './number';
 
+export enum ArticulationState {
+	COMPLETED = 1,
+	STARTED = 0,
+	NOT_STARTED = -1,
+}
+
 type ArticulationItem = {
 	label: string;
 	value: string;
@@ -24,16 +30,14 @@ type Item = {
 		label: string;
 		value: ReactNode;
 	}[];
-	progress: number; // -1: not completed, 0: started, 1: finished
+	progress: ArticulationState; // -1: not completed, 0: started, 1: finished
 	page: PageTag;
 };
 
 /**
  * Retrieve the articulation state
  *
- * ## Why this hook
- *
- * The goal of this hook is to provide insights about a roundabout using extra information inserted in the JSON source
+ * The goal of this function is to provide insights about a roundabout using extra information inserted in the JSON source
  * provided to Lunatic.
  *
  * For instance
@@ -61,7 +65,7 @@ type Item = {
  * - source is the ID of the roundabout component
  * - items define the field to extract from the roundabout data
  */
-export function getArticulation(
+export function getArticulationState(
 	source: LunaticSource & { articulation: Articulation },
 	data: LunaticData
 ): { items: Item[] } {
@@ -90,7 +94,10 @@ export function getArticulation(
 	return {
 		items: rows.map((row, k) => ({
 			cells: row,
-			progress: forceInt(variables.get(roundabout.progressVariable, [k]) ?? -1),
+			progress: forceInt(
+				variables.get(roundabout.progressVariable, [k]) ??
+					ArticulationState.NOT_STARTED
+			),
 			page: (roundabout.page
 				? `${roundabout.page}.1#${k + 1}`
 				: '1') as PageTag,