@inseefr/lunatic 3.5.0-rc.3 → 3.5.1-rc.1743691949561

package/src/utils/getArticulation.ts

@@ -1,117 +0,0 @@
-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,
-		})),
-	};
-}
-
-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;
-}

package/utils/getArticulation.d.ts

@@ -1,58 +0,0 @@
-import type { LunaticSource } from '../type.source';
-import type { LunaticData, PageTag } from '../use-lunatic/type';
-import { type ReactNode } from 'react';
-type ArticulationItem = {
-    label: string;
-    value: string;
-};
-type Articulation = {
-    source: string;
-    items: ArticulationItem[];
-};
-type Item = {
-    cells: {
-        label: string;
-        value: ReactNode;
-    }[];
-    progress: number;
-    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 declare function getArticulation(source: LunaticSource & {
-    articulation: Articulation;
-}, data: LunaticData): {
-    items: Item[];
-};
-export {};

package/utils/getArticulation.js

@@ -1,77 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getArticulation = getArticulation;
-const reducerInitializer_1 = require("../use-lunatic/reducer/reducerInitializer");
-const array_1 = require("./array");
-const number_1 = require("./number");
-/**
- * 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
- */
-function getArticulation(source, data) {
-    const roundabout = findComponentById(source.components, source.articulation.source);
-    const { variables } = (0, reducerInitializer_1.reducerInitializer)({ source, data });
-    const iterations = (0, number_1.forceInt)(variables.run(roundabout?.iterations.value ?? '0'));
-    const rows = (0, array_1.times)(iterations, (k) => source.articulation.items.map((item) => ({
-        label: item.label,
-        value: variables.run(item.value, { iteration: [k] }),
-    })));
-    if (!roundabout) {
-        return {
-            items: [],
-        };
-    }
-    return {
-        items: rows.map((row, k) => ({
-            cells: row,
-            progress: (0, number_1.forceInt)(variables.get(roundabout.progressVariable, [k]) ?? -1),
-            page: (roundabout.page
-                ? `${roundabout.page}.1#${k + 1}`
-                : '1'),
-        })),
-    };
-}
-function findComponentById(components, id) {
-    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;
-}
-//# sourceMappingURL=getArticulation.js.map

package/utils/getArticulation.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"getArticulation.js","sourceRoot":"","sources":["../src/utils/getArticulation.ts"],"names":[],"mappings":";;AA+DA,0CAmCC;AA5FD,kFAA+E;AAE/E,mCAAgC;AAChC,qCAAoC;AAqBpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,SAAgB,eAAe,CAC9B,MAAsD,EACtD,IAAiB;IAEjB,MAAM,UAAU,GAAG,iBAAiB,CACnC,MAAM,CAAC,UAAU,EACjB,MAAM,CAAC,YAAY,CAAC,MAAM,CAC1B,CAAC;IACF,MAAM,EAAE,SAAS,EAAE,GAAG,IAAA,uCAAkB,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;IAC3D,MAAM,UAAU,GAAG,IAAA,iBAAQ,EAC1B,SAAS,CAAC,GAAG,CAAC,UAAU,EAAE,UAAU,CAAC,KAAK,IAAI,GAAG,CAAC,CAClD,CAAC;IAEF,MAAM,IAAI,GAAG,IAAA,aAAK,EAAC,UAAU,EAAE,CAAC,CAAC,EAAE,EAAE,CACpC,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACxC,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,KAAK,EAAE,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAc;KACjE,CAAC,CAAC,CACH,CAAC;IAEF,IAAI,CAAC,UAAU,EAAE,CAAC;QACjB,OAAO;YACN,KAAK,EAAE,EAAE;SACT,CAAC;IACH,CAAC;IAED,OAAO;QACN,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;YAC5B,KAAK,EAAE,GAAG;YACV,QAAQ,EAAE,IAAA,iBAAQ,EAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;YACzE,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI;gBACrB,CAAC,CAAC,GAAG,UAAU,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,EAAE;gBACjC,CAAC,CAAC,GAAG,CAAY;SAClB,CAAC,CAAC;KACH,CAAC;AACH,CAAC;AAED,SAAS,iBAAiB,CACzB,UAAiC,EACjC,EAAU;IAEV,KAAK,MAAM,CAAC,IAAI,UAAU,EAAE,CAAC;QAC5B,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,aAAa,KAAK,YAAY,EAAE,CAAC;YAClE,OAAO,CAAC,CAAC;QACV,CAAC;QACD,IAAI,YAAY,IAAI,CAAC,EAAE,CAAC;YACvB,MAAM,KAAK,GAAG,iBAAiB,CAAC,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;YAClD,IAAI,KAAK,EAAE,CAAC;gBACX,OAAO,KAAK,CAAC;YACd,CAAC;QACF,CAAC;IACF,CAAC;IACD,OAAO,IAAI,CAAC;AACb,CAAC"}