@inseefr/lunatic 3.5.0-rc.0 → 3.5.0-rc.3

package/esm/index.d.ts

@@ -7,6 +7,7 @@ export { ModalControls } from './components/shared/ModalControls/ModalControls';
 export { Button } from './components/shared/Button/Button';
 export { LunaticComponents } from './components/LunaticComponents';
 export { useLunatic } from './use-lunatic/use-lunatic';
+export { getArticulation } from './utils/getArticulation';
 export type { LunaticComponentDefinition, LunaticControl, LunaticData, LunaticValues, LunaticError, LunaticExpression, LunaticVariable, LunaticCollectedValue, LunaticStateVariable, LunaticState, LunaticPager, LunaticOptions, LunaticChangesHandler, } from './use-lunatic/type';
 export type { LunaticComponentProps, LunaticExtraProps, } from './components/type';
 export type { LunaticSlotComponents } from './components/shared/HOC/slottableComponent';

package/esm/index.js

@@ -7,6 +7,7 @@ export { ModalControls } from './components/shared/ModalControls/ModalControls';
 export { Button } from './components/shared/Button/Button';
 export { LunaticComponents } from './components/LunaticComponents';
 export { useLunatic } from './use-lunatic/use-lunatic';
+export { getArticulation } from './utils/getArticulation';
 // Export errors (useful for typeof)
 export { VTLMissingDependencies, VTLExpressionError, VTLMissingDependency, VTLInterpretationError, } from './use-lunatic/commons/variables/errors';
 //# sourceMappingURL=index.js.map

package/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,iDAAiD,CAAC;AAChF,OAAO,EAAE,MAAM,EAAE,MAAM,mCAAmC,CAAC;AAE3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAyBvD,oCAAoC;AACpC,OAAO,EACN,sBAAsB,EACtB,kBAAkB,EAClB,oBAAoB,EACpB,sBAAsB,GACtB,MAAM,wCAAwC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,iDAAiD,CAAC;AAChF,OAAO,EAAE,MAAM,EAAE,MAAM,mCAAmC,CAAC;AAE3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAyB1D,oCAAoC;AACpC,OAAO,EACN,sBAAsB,EACtB,kBAAkB,EAClB,oBAAoB,EACpB,sBAAsB,GACtB,MAAM,wCAAwC,CAAC"}

package/esm/{hooks/useArticulation.d.ts → utils/getArticulation.d.ts}

@@ -1,5 +1,5 @@
 import type { LunaticSource } from '../type.source';
-import type { LunaticData } from '../use-lunatic/type';
+import type { LunaticData, PageTag } from '../use-lunatic/type';
 import { type ReactNode } from 'react';
 type ArticulationItem = {
     label: string;
@@ -13,12 +13,12 @@ type Item = {
     cells: {
         label: string;
         value: ReactNode;
-        page?: string;
     }[];
     progress: number;
+    page: PageTag;
 };
 /**
- * Hook to get articulation state
+ * Retrieve the articulation state
  *
  * ## Why this hook
  *
@@ -50,7 +50,7 @@ type Item = {
  * - source is the ID of the roundabout component
  * - items define the field to extract from the roundabout data
  */
-export declare function useArticulation(source: LunaticSource & {
+export declare function getArticulation(source: LunaticSource & {
     articulation: Articulation;
 }, data: LunaticData): {
     items: Item[];

package/esm/{hooks/useArticulation.js → utils/getArticulation.js}

@@ -1,9 +1,8 @@
 import { reducerInitializer } from '../use-lunatic/reducer/reducerInitializer';
-import { useMemo } from 'react';
-import { times } from '../utils/array';
-import { forceInt } from '../utils/number';
+import { times } from './array';
+import { forceInt } from './number';
 /**
- * Hook to get articulation state
+ * Retrieve the articulation state
  *
  * ## Why this hook
  *
@@ -35,19 +34,15 @@ import { forceInt } from '../utils/number';
  * - source is the ID of the roundabout component
  * - items define the field to extract from the roundabout data
  */
-export function useArticulation(source, data) {
-    const roundabout = useMemo(() => findComponentById(source.components, source.articulation.source), [source]);
-    const { variables } = useMemo(() => reducerInitializer({ source, data }), [source, data]);
-    const iterations = useMemo(() => { var _a; return forceInt(variables.run((_a = roundabout === null || roundabout === void 0 ? void 0 : roundabout.iterations.value) !== null && _a !== void 0 ? _a : '0')); }, 
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-    [source, data]);
-    const rows = useMemo(() => {
-        return times(iterations, (k) => source.articulation.items.map((item) => ({
-            label: item.label,
-            value: variables.run(item.value, { iteration: [k] }),
-        })));
-        // eslint-disable-next-line react-hooks/exhaustive-deps
-    }, [source, data, iterations, roundabout === null || roundabout === void 0 ? void 0 : roundabout.progressVariable]);
+export function getArticulation(source, data) {
+    var _a;
+    const roundabout = findComponentById(source.components, source.articulation.source);
+    const { variables } = reducerInitializer({ source, data });
+    const iterations = forceInt(variables.run((_a = roundabout === null || roundabout === void 0 ? void 0 : roundabout.iterations.value) !== null && _a !== void 0 ? _a : '0'));
+    const rows = times(iterations, (k) => source.articulation.items.map((item) => ({
+        label: item.label,
+        value: variables.run(item.value, { iteration: [k] }),
+    })));
     if (!roundabout) {
         return {
             items: [],
@@ -59,7 +54,9 @@ export function useArticulation(source, data) {
             return ({
                 cells: row,
                 progress: forceInt((_a = variables.get(roundabout.progressVariable, [k])) !== null && _a !== void 0 ? _a : -1),
-                page: roundabout.page ? `${roundabout.page}.1#${k + 1}` : '1',
+                page: (roundabout.page
+                    ? `${roundabout.page}.1#${k + 1}`
+                    : '1'),
             });
         }),
     };
@@ -78,4 +75,4 @@ function findComponentById(components, id) {
     }
     return null;
 }
-//# sourceMappingURL=useArticulation.js.map
+//# sourceMappingURL=getArticulation.js.map

package/esm/utils/getArticulation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getArticulation.js","sourceRoot":"","sources":["../../src/utils/getArticulation.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAC;AAE/E,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAqBpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,UAAU,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,kBAAkB,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;IAC3D,MAAM,UAAU,GAAG,QAAQ,CAC1B,SAAS,CAAC,GAAG,CAAC,MAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,UAAU,CAAC,KAAK,mCAAI,GAAG,CAAC,CAClD,CAAC;IAEF,MAAM,IAAI,GAAG,KAAK,CAAC,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;;YAAC,OAAA,CAAC;gBAC5B,KAAK,EAAE,GAAG;gBACV,QAAQ,EAAE,QAAQ,CAAC,MAAA,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC,CAAC,mCAAI,CAAC,CAAC,CAAC;gBACzE,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI;oBACrB,CAAC,CAAC,GAAG,UAAU,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,EAAE;oBACjC,CAAC,CAAC,GAAG,CAAY;aAClB,CAAC,CAAA;SAAA,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"}

package/index.d.ts

@@ -7,6 +7,7 @@ export { ModalControls } from './components/shared/ModalControls/ModalControls';
 export { Button } from './components/shared/Button/Button';
 export { LunaticComponents } from './components/LunaticComponents';
 export { useLunatic } from './use-lunatic/use-lunatic';
+export { getArticulation } from './utils/getArticulation';
 export type { LunaticComponentDefinition, LunaticControl, LunaticData, LunaticValues, LunaticError, LunaticExpression, LunaticVariable, LunaticCollectedValue, LunaticStateVariable, LunaticState, LunaticPager, LunaticOptions, LunaticChangesHandler, } from './use-lunatic/type';
 export type { LunaticComponentProps, LunaticExtraProps, } from './components/type';
 export type { LunaticSlotComponents } from './components/shared/HOC/slottableComponent';

package/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.VTLInterpretationError = exports.VTLMissingDependency = exports.VTLExpressionError = exports.VTLMissingDependencies = exports.useLunatic = exports.LunaticComponents = exports.Button = exports.ModalControls = exports.components = void 0;
+exports.VTLInterpretationError = exports.VTLMissingDependency = exports.VTLExpressionError = exports.VTLMissingDependencies = exports.getArticulation = exports.useLunatic = exports.LunaticComponents = exports.Button = exports.ModalControls = exports.components = void 0;
 /**
  * We should remove this export to avoid `import * as lunatic from "@inseefr/lunatic"` in orchestrators
  *  but this is a breaking change
@@ -15,6 +15,8 @@ var LunaticComponents_1 = require("./components/LunaticComponents");
 Object.defineProperty(exports, "LunaticComponents", { enumerable: true, get: function () { return LunaticComponents_1.LunaticComponents; } });
 var use_lunatic_1 = require("./use-lunatic/use-lunatic");
 Object.defineProperty(exports, "useLunatic", { enumerable: true, get: function () { return use_lunatic_1.useLunatic; } });
+var getArticulation_1 = require("./utils/getArticulation");
+Object.defineProperty(exports, "getArticulation", { enumerable: true, get: function () { return getArticulation_1.getArticulation; } });
 // Export errors (useful for typeof)
 var errors_1 = require("./use-lunatic/commons/variables/errors");
 Object.defineProperty(exports, "VTLMissingDependencies", { enumerable: true, get: function () { return errors_1.VTLMissingDependencies; } });

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,gDAA6D;AAApD,qGAAA,OAAO,OAAc;AAC9B,iFAAgF;AAAvE,8GAAA,aAAa,OAAA;AACtB,4DAA2D;AAAlD,gGAAA,MAAM,OAAA;AAEf,oEAAmE;AAA1D,sHAAA,iBAAiB,OAAA;AAC1B,yDAAuD;AAA9C,yGAAA,UAAU,OAAA;AAyBnB,oCAAoC;AACpC,iEAKgD;AAJ/C,gHAAA,sBAAsB,OAAA;AACtB,4GAAA,kBAAkB,OAAA;AAClB,8GAAA,oBAAoB,OAAA;AACpB,gHAAA,sBAAsB,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,gDAA6D;AAApD,qGAAA,OAAO,OAAc;AAC9B,iFAAgF;AAAvE,8GAAA,aAAa,OAAA;AACtB,4DAA2D;AAAlD,gGAAA,MAAM,OAAA;AAEf,oEAAmE;AAA1D,sHAAA,iBAAiB,OAAA;AAC1B,yDAAuD;AAA9C,yGAAA,UAAU,OAAA;AACnB,2DAA0D;AAAjD,kHAAA,eAAe,OAAA;AAyBxB,oCAAoC;AACpC,iEAKgD;AAJ/C,gHAAA,sBAAsB,OAAA;AACtB,4GAAA,kBAAkB,OAAA;AAClB,8GAAA,oBAAoB,OAAA;AACpB,gHAAA,sBAAsB,OAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@inseefr/lunatic",
-    "version": "3.5.0-rc.0",
+    "version": "3.5.0-rc.3",
     "description": "Library of questionnaire components",
     "repository": {
         "type": "git",
@@ -219,7 +219,6 @@
         "src/hooks/use-auto-focus.ts",
         "src/hooks/use-track-changes.ts",
         "src/hooks/use-why-render.ts",
-        "src/hooks/useArticulation.ts",
         "src/hooks/useDebounce.ts",
         "src/hooks/useDocumentEvent.ts",
         "src/hooks/useKeyboardKey.ts",
@@ -458,6 +457,7 @@
         "src/utils/dom.ts",
         "src/utils/env.ts",
         "src/utils/function.ts",
+        "src/utils/getArticulation.ts",
         "src/utils/is-element.ts",
         "src/utils/is-object.ts",
         "src/utils/logger.ts",
@@ -1349,9 +1349,6 @@
         "esm/hooks/use-why-render.d.ts",
         "esm/hooks/use-why-render.js",
         "esm/hooks/use-why-render.js.map",
-        "esm/hooks/useArticulation.d.ts",
-        "esm/hooks/useArticulation.js",
-        "esm/hooks/useArticulation.js.map",
         "esm/hooks/useDebounce.d.ts",
         "esm/hooks/useDebounce.js",
         "esm/hooks/useDebounce.js.map",
@@ -1612,6 +1609,9 @@
         "esm/utils/function.d.ts",
         "esm/utils/function.js",
         "esm/utils/function.js.map",
+        "esm/utils/getArticulation.d.ts",
+        "esm/utils/getArticulation.js",
+        "esm/utils/getArticulation.js.map",
         "esm/utils/is-element.d.ts",
         "esm/utils/is-element.js",
         "esm/utils/is-element.js.map",
@@ -1675,9 +1675,6 @@
         "hooks/use-why-render.d.ts",
         "hooks/use-why-render.js",
         "hooks/use-why-render.js.map",
-        "hooks/useArticulation.d.ts",
-        "hooks/useArticulation.js",
-        "hooks/useArticulation.js.map",
         "hooks/useDebounce.d.ts",
         "hooks/useDebounce.js",
         "hooks/useDebounce.js.map",
@@ -1939,6 +1936,9 @@
         "utils/function.d.ts",
         "utils/function.js",
         "utils/function.js.map",
+        "utils/getArticulation.d.ts",
+        "utils/getArticulation.js",
+        "utils/getArticulation.js.map",
         "utils/is-element.d.ts",
         "utils/is-element.js",
         "utils/is-element.js.map",

package/src/index.ts

@@ -8,6 +8,7 @@ export { Button } from './components/shared/Button/Button';
 
 export { LunaticComponents } from './components/LunaticComponents';
 export { useLunatic } from './use-lunatic/use-lunatic';
+export { getArticulation } from './utils/getArticulation';
 
 export type {
 	LunaticComponentDefinition,

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

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

package/src/{hooks/useArticulation.ts → utils/getArticulation.ts}

@@ -3,11 +3,11 @@ import type {
 	ComponentRoundaboutDefinition,
 	LunaticSource,
 } from '../type.source';
-import type { LunaticData } from '../use-lunatic/type';
+import type { LunaticData, PageTag } from '../use-lunatic/type';
 import { reducerInitializer } from '../use-lunatic/reducer/reducerInitializer';
-import { type ReactNode, useMemo } from 'react';
-import { times } from '../utils/array';
-import { forceInt } from '../utils/number';
+import { type ReactNode } from 'react';
+import { times } from './array';
+import { forceInt } from './number';
 
 type ArticulationItem = {
 	label: string;
@@ -23,13 +23,13 @@ type Item = {
 	cells: {
 		label: string;
 		value: ReactNode;
-		page?: string;
 	}[];
 	progress: number; // -1: not completed, 0: started, 1: finished
+	page: PageTag;
 };
 
 /**
- * Hook to get articulation state
+ * Retrieve the articulation state
  *
  * ## Why this hook
  *
@@ -61,35 +61,26 @@ type Item = {
  * - source is the ID of the roundabout component
  * - items define the field to extract from the roundabout data
  */
-export function useArticulation(
+export function getArticulation(
 	source: LunaticSource & { articulation: Articulation },
 	data: LunaticData
 ): { items: Item[] } {
-	const roundabout = useMemo(
-		() => findComponentById(source.components, source.articulation.source),
-		[source]
+	const roundabout = findComponentById(
+		source.components,
+		source.articulation.source
 	);
-	const { variables } = useMemo(
-		() => reducerInitializer({ source, data }),
-		[source, data]
+	const { variables } = reducerInitializer({ source, data });
+	const iterations = forceInt(
+		variables.run(roundabout?.iterations.value ?? '0')
 	);
 
-	const iterations = useMemo(
-		() => forceInt(variables.run(roundabout?.iterations.value ?? '0')),
-		// eslint-disable-next-line react-hooks/exhaustive-deps
-		[source, data]
+	const rows = times(iterations, (k) =>
+		source.articulation.items.map((item) => ({
+			label: item.label,
+			value: variables.run(item.value, { iteration: [k] }) as ReactNode,
+		}))
 	);
 
-	const rows = useMemo(() => {
-		return times(iterations, (k) =>
-			source.articulation.items.map((item) => ({
-				label: item.label,
-				value: variables.run(item.value, { iteration: [k] }) as ReactNode,
-			}))
-		);
-		// eslint-disable-next-line react-hooks/exhaustive-deps
-	}, [source, data, iterations, roundabout?.progressVariable]);
-
 	if (!roundabout) {
 		return {
 			items: [],
@@ -100,7 +91,9 @@ export function useArticulation(
 		items: rows.map((row, k) => ({
 			cells: row,
 			progress: forceInt(variables.get(roundabout.progressVariable, [k]) ?? -1),
-			page: roundabout.page ? `${roundabout.page}.1#${k + 1}` : '1',
+			page: (roundabout.page
+				? `${roundabout.page}.1#${k + 1}`
+				: '1') as PageTag,
 		})),
 	};
 }