@inseefr/lunatic 3.6.14 → 3.6.15-rc.0

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

@@ -33,6 +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';
 
 const empty = {}; // Keep the same empty object (to avoid problem with useEffect dependencies)
 const DEFAULT_DATA = empty as LunaticData;
@@ -198,6 +199,8 @@ export function useLunatic(
 		(variableNames?: string[]) => getData(false, variableNames)
 	);
 
+	const { getMultiMode } = useMultiMode(source, state.variables);
+
 	const pageTag = getPageTag(state.pager);
 	const { isFirstPage, isLastPage } = isFirstLastPage(state.pager);
 
@@ -241,5 +244,6 @@ export function useLunatic(
 		// Components
 		Provider,
 		handleChanges,
+		getMultiMode,
 	} satisfies LunaticState;
 }

package/src/utils/getArticulation.ts

@@ -0,0 +1,117 @@
+import type {
+	ComponentDefinition,
+	ComponentRoundaboutDefinition,
+	LunaticSource,
+} from '../type.source';
+import type { LunaticData, PageTag } from '../use-lunatic/type';
+import { reducerInitializer } from '../use-lunatic/reducer/reducerInitializer';
+import { type ReactNode } from 'react';
+import { times } from './array';
+import { forceInt } from './number';
+
+type ArticulationItem = {
+	label: string;
+	value: string;
+};
+
+type Articulation = {
+	source: string;
+	items: ArticulationItem[];
+};
+
+type Item = {
+	cells: {
+		label: string;
+		value: ReactNode;
+	}[];
+	progress: number; // -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
+ * provided to Lunatic.
+ *
+ * For instance
+ *
+ * ```
+ *  "articulation": {
+ *    "source": "roundabout",
+ *    "items": [
+ *      {
+ *        "label": "Prénom",
+ *        "value": "PRENOMS"
+ *      },
+ *      {
+ *        "label": "Sexe",
+ *        "value": "if SEXE = \"H\" then \"Homme\" else \"Femme\""
+ *      },
+ *      {
+ *        "label": "Age",
+ *        "value": "cast(AGE, string) || \" ans\""
+ *      }
+ *    ]
+ *  },
+ * ```
+ *
+ * - source is the ID of the roundabout component
+ * - items define the field to extract from the roundabout data
+ */
+export function getArticulation(
+	source: LunaticSource & { articulation: Articulation },
+	data: LunaticData
+): { items: Item[] } {
+	const roundabout = findComponentById(
+		source.components,
+		source.articulation.source
+	);
+	const { variables } = reducerInitializer({ source, data });
+	const iterations = forceInt(
+		variables.run(roundabout?.iterations.value ?? '0')
+	);
+
+	const rows = times(iterations, (k) =>
+		source.articulation.items.map((item) => ({
+			label: item.label,
+			value: variables.run(item.value, { iteration: [k] }) as ReactNode,
+		}))
+	);
+
+	if (!roundabout) {
+		return {
+			items: [],
+		};
+	}
+
+	return {
+		items: rows.map((row, k) => ({
+			cells: row,
+			progress: forceInt(variables.get(roundabout.progressVariable, [k]) ?? -1),
+			page: (roundabout.page
+				? `${roundabout.page}.1#${k + 1}`
+				: '1') as PageTag,
+		})),
+	};
+}
+
+export function findComponentById(
+	components: ComponentDefinition[],
+	id: string
+): (ComponentRoundaboutDefinition & { page?: string }) | null {
+	for (const c of components) {
+		if ('id' in c && c.id === id && c.componentType === 'Roundabout') {
+			return c;
+		}
+		if ('components' in c) {
+			const child = findComponentById(c.components, id);
+			if (child) {
+				return child;
+			}
+		}
+	}
+	return null;
+}