@inseefr/lunatic 3.4.15 → 3.4.16

package/esm/use-lunatic/hooks/useOverview.d.ts

@@ -13,4 +13,4 @@ export type InterpretedLunaticOverviewItem = {
 /**
  * Build a filled overview everytime the deps change.
  */
-export declare const useOverview: ({ overview, executeExpression, pager, }: Pick<LunaticReducerState, "executeExpression" | "overview" | "pager">, deps: DependencyList) => InterpretedLunaticOverviewItem[];
+export declare const useOverview: ({ overview, executeExpression, pager, options, }: Pick<LunaticReducerState, "executeExpression" | "overview" | "pager" | "options">, deps: DependencyList) => InterpretedLunaticOverviewItem[];

package/esm/use-lunatic/hooks/useOverview.js

@@ -3,17 +3,20 @@ import { getPageTag, pageTagComparator } from '../commons/page-tag';
 /**
  * Build a filled overview everytime the deps change.
  */
-export const useOverview = ({ overview, executeExpression, pager, }, deps) => {
-    return useMemo(() => interpretOverview(overview, executeExpression, pager), 
+export const useOverview = ({ overview, executeExpression, pager, options, }, deps) => {
+    return useMemo(() => interpretOverview(overview, executeExpression, pager, options.disableFilters), 
     // eslint-disable-next-line react-hooks/exhaustive-deps
-    [...deps, overview]);
+    [...deps, overview, options.disableFilters]);
 };
 /**
  * Use Lunatic data to interpret the static overview (calculated on init) with the real data.
  */
-const interpretOverview = (overviewItems, executeExpression, pager) => {
+const interpretOverview = (overviewItems, executeExpression, pager, disableFilters) => {
     // Flat structure of the overview
-    let items = overviewItems.reduce((acc, item) => interpretOverviewItem(acc, item, executeExpression, pager), []);
+    let items = overviewItems.reduce((acc, item) => interpretOverviewItem(acc, item, executeExpression, {
+        pager,
+        disableFilters,
+    }), []);
     // Sort using the page logic
     items = items.sort((a, b) => pageTagComparator(a.page, b.page));
     // Build a tree with nested item, a subsequence will be a child of the previous sequence
@@ -36,25 +39,29 @@ const interpretOverview = (overviewItems, executeExpression, pager) => {
 /**
  * Interpret expression inside an item (label & condition).
  */
-const interpretOverviewItem = (items, item, executeExpression, pager, iteration) => {
+const interpretOverviewItem = (items, item, executeExpression, state, iteration) => {
     var _a;
     // We reached a loop item, we need to add it multiple time
     if (item.iterations && iteration === undefined) {
         const iterations = (_a = executeExpression(item.iterations)) !== null && _a !== void 0 ? _a : 0;
         return Array.from({ length: iterations }).reduce((acc, _, k) => {
-            return interpretOverviewItem(acc, item, executeExpression, pager, k);
+            return interpretOverviewItem(acc, item, executeExpression, state, k);
         }, items);
     }
-    const isVisible = item.conditionFilter
-        ? Boolean(executeExpression(item.conditionFilter, {
+    // if disableFilters is set to true, item are visible and reached by default
+    const isVisible = (() => {
+        if (state.disableFilters || !item.conditionFilter)
+            return true;
+        return Boolean(executeExpression(item.conditionFilter, {
             iteration: iteration,
-        }))
-        : true;
+        }));
+    })();
     if (!isVisible) {
         return items;
     }
     // Append the item to the list of items
     const page = `${item.pageTag}${iteration !== undefined ? `#${iteration + 1}` : ''}`;
+    const reached = pageTagComparator(state.pager ? getPageTag(state.pager) : '-1', page) >= 0;
     return [
         ...items,
         {
@@ -65,9 +72,7 @@ const interpretOverviewItem = (items, item, executeExpression, pager, iteration)
                 ? executeExpression(item.description, { iteration })
                 : undefined,
             children: [],
-            reached: pageTagComparator(pager ? getPageTag(pager) : '-1', page) >= 0
-                ? true
-                : false,
+            reached: reached,
             page: page,
             current: false,
         },

package/esm/use-lunatic/hooks/useOverview.js.map

@@ -1 +1 @@
-{"version":3,"file":"useOverview.js","sourceRoot":"","sources":["../../../src/use-lunatic/hooks/useOverview.ts"],"names":[],"mappings":"AAKA,OAAO,EAAuC,OAAO,EAAE,MAAM,OAAO,CAAC;AACrE,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAapE;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAC1B,EACC,QAAQ,EACR,iBAAiB,EACjB,KAAK,GACkE,EACxE,IAAoB,EACnB,EAAE;IACH,OAAO,OAAO,CACb,GAAG,EAAE,CAAC,iBAAiB,CAAC,QAAQ,EAAE,iBAAiB,EAAE,KAAK,CAAC;IAC3D,uDAAuD;IACvD,CAAC,GAAG,IAAI,EAAE,QAAQ,CAAC,CACnB,CAAC;AACH,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,iBAAiB,GAAG,CACzB,aAAoC,EACpC,iBAA2D,EAC3D,KAAoC,EACnC,EAAE;IACH,iCAAiC;IACjC,IAAI,KAAK,GAAG,aAAa,CAAC,MAAM,CAC/B,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,qBAAqB,CAAC,GAAG,EAAE,IAAI,EAAE,iBAAiB,EAAE,KAAK,CAAC,EACzE,EAAsC,CACtC,CAAC;IACF,4BAA4B;IAC5B,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAChE,wFAAwF;IACxF,MAAM,SAAS,GAAG,EAAkB,CAAC;IACrC,IAAI,MAAM,GAAG,IAA6C,CAAC;IAE3D,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QAC1B,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YAC9B,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACrB,MAAM,GAAG,IAAI,CAAC;QACf,CAAC;aAAM,CAAC;YACP,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7B,CAAC;IACF,CAAC;IAED,IAAI,KAAK,EAAE,CAAC;QACX,gBAAgB,CAAC,SAAS,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IAChD,CAAC;IAED,OAAO,SAAS,CAAC;AAClB,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,qBAAqB,GAAG,CAC7B,KAAuC,EACvC,IAAyB,EACzB,iBAA2D,EAC3D,KAAoC,EACpC,SAAkB,EACiB,EAAE;;IACrC,0DAA0D;IAC1D,IAAI,IAAI,CAAC,UAAU,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAChD,MAAM,UAAU,GAAG,MAAA,iBAAiB,CAAS,IAAI,CAAC,UAAU,CAAC,mCAAI,CAAC,CAAC;QACnE,OAAO,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC,MAAM,CAC/C,CAAC,GAAqC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE;YAC/C,OAAO,qBAAqB,CAAC,GAAG,EAAE,IAAI,EAAE,iBAAiB,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;QACtE,CAAC,EACD,KAAK,CACL,CAAC;IACH,CAAC;IAED,MAAM,SAAS,GAAG,IAAI,CAAC,eAAe;QACrC,CAAC,CAAC,OAAO,CACP,iBAAiB,CAAC,IAAI,CAAC,eAAe,EAAE;YACvC,SAAS,EAAE,SAAS;SACpB,CAAC,CACF;QACF,CAAC,CAAC,IAAI,CAAC;IAER,IAAI,CAAC,SAAS,EAAE,CAAC;QAChB,OAAO,KAAK,CAAC;IACd,CAAC;IAED,uCAAuC;IACvC,MAAM,IAAI,GACT,GAAG,IAAI,CAAC,OAAO,GAAG,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,SAAS,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAa,CAAC;IACnF,OAAO;QACN,GAAG,KAAK;QACR;YACC,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,KAAK,EAAE,iBAAiB,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,SAAS,EAAE,CAAC;YACnD,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC5B,CAAC,CAAC,iBAAiB,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,CAAC;gBACpD,CAAC,CAAC,SAAS;YACZ,QAAQ,EAAE,EAAE;YACZ,OAAO,EACN,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC;gBAC7D,CAAC,CAAC,IAAI;gBACN,CAAC,CAAC,KAAK;YACT,IAAI,EAAE,IAAI;YACV,OAAO,EAAE,KAAK;SACd;KACD,CAAC;AACH,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,gBAAgB,GAAG,CACxB,KAAuC,EACvC,WAAoB,EACe,EAAE;IACrC,mDAAmD;IACnD,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,CACjC,CAAC,IAAI,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC,CACxD,CAAC;IAEF,IAAI,CAAC,WAAW,EAAE,CAAC;QAClB,OAAO,KAAK,CAAC;IACd,CAAC;IAED,2BAA2B;IAC3B,WAAW,CAAC,OAAO,GAAG,IAAI,CAAC;IAC3B,IAAI,WAAW,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrC,gBAAgB,CAAC,WAAW,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IACrD,CAAC;IAED,OAAO,KAAK,CAAC;AACd,CAAC,CAAC"}
+{"version":3,"file":"useOverview.js","sourceRoot":"","sources":["../../../src/use-lunatic/hooks/useOverview.ts"],"names":[],"mappings":"AAMA,OAAO,EAAuC,OAAO,EAAE,MAAM,OAAO,CAAC;AACrE,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAapE;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAC1B,EACC,QAAQ,EACR,iBAAiB,EACjB,KAAK,EACL,OAAO,GAIP,EACD,IAAoB,EACnB,EAAE;IACH,OAAO,OAAO,CACb,GAAG,EAAE,CACJ,iBAAiB,CAChB,QAAQ,EACR,iBAAiB,EACjB,KAAK,EACL,OAAO,CAAC,cAAc,CACtB;IACF,uDAAuD;IACvD,CAAC,GAAG,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,cAAc,CAAC,CAC3C,CAAC;AACH,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,iBAAiB,GAAG,CACzB,aAAoC,EACpC,iBAA2D,EAC3D,KAAoC,EACpC,cAAiD,EAChD,EAAE;IACH,iCAAiC;IACjC,IAAI,KAAK,GAAG,aAAa,CAAC,MAAM,CAC/B,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CACb,qBAAqB,CAAC,GAAG,EAAE,IAAI,EAAE,iBAAiB,EAAE;QACnD,KAAK;QACL,cAAc;KACd,CAAC,EACH,EAAsC,CACtC,CAAC;IACF,4BAA4B;IAC5B,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAChE,wFAAwF;IACxF,MAAM,SAAS,GAAG,EAAkB,CAAC;IACrC,IAAI,MAAM,GAAG,IAA6C,CAAC;IAE3D,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QAC1B,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YAC9B,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACrB,MAAM,GAAG,IAAI,CAAC;QACf,CAAC;aAAM,CAAC;YACP,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7B,CAAC;IACF,CAAC;IAED,IAAI,KAAK,EAAE,CAAC;QACX,gBAAgB,CAAC,SAAS,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IAChD,CAAC;IAED,OAAO,SAAS,CAAC;AAClB,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,qBAAqB,GAAG,CAC7B,KAAuC,EACvC,IAAyB,EACzB,iBAA2D,EAC3D,KAGC,EAED,SAAkB,EACiB,EAAE;;IACrC,0DAA0D;IAC1D,IAAI,IAAI,CAAC,UAAU,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAChD,MAAM,UAAU,GAAG,MAAA,iBAAiB,CAAS,IAAI,CAAC,UAAU,CAAC,mCAAI,CAAC,CAAC;QACnE,OAAO,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC,MAAM,CAC/C,CAAC,GAAqC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE;YAC/C,OAAO,qBAAqB,CAAC,GAAG,EAAE,IAAI,EAAE,iBAAiB,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;QACtE,CAAC,EACD,KAAK,CACL,CAAC;IACH,CAAC;IAED,4EAA4E;IAC5E,MAAM,SAAS,GAAG,CAAC,GAAG,EAAE;QACvB,IAAI,KAAK,CAAC,cAAc,IAAI,CAAC,IAAI,CAAC,eAAe;YAAE,OAAO,IAAI,CAAC;QAC/D,OAAO,OAAO,CACb,iBAAiB,CAAC,IAAI,CAAC,eAAe,EAAE;YACvC,SAAS,EAAE,SAAS;SACpB,CAAC,CACF,CAAC;IACH,CAAC,CAAC,EAAE,CAAC;IAEL,IAAI,CAAC,SAAS,EAAE,CAAC;QAChB,OAAO,KAAK,CAAC;IACd,CAAC;IAED,uCAAuC;IACvC,MAAM,IAAI,GACT,GAAG,IAAI,CAAC,OAAO,GAAG,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,SAAS,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAa,CAAC;IAEnF,MAAM,OAAO,GACZ,iBAAiB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAE5E,OAAO;QACN,GAAG,KAAK;QACR;YACC,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,KAAK,EAAE,iBAAiB,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,SAAS,EAAE,CAAC;YACnD,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC5B,CAAC,CAAC,iBAAiB,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,CAAC;gBACpD,CAAC,CAAC,SAAS;YACZ,QAAQ,EAAE,EAAE;YACZ,OAAO,EAAE,OAAO;YAChB,IAAI,EAAE,IAAI;YACV,OAAO,EAAE,KAAK;SACd;KACD,CAAC;AACH,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,gBAAgB,GAAG,CACxB,KAAuC,EACvC,WAAoB,EACe,EAAE;IACrC,mDAAmD;IACnD,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,CACjC,CAAC,IAAI,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC,CACxD,CAAC;IAEF,IAAI,CAAC,WAAW,EAAE,CAAC;QAClB,OAAO,KAAK,CAAC;IACd,CAAC;IAED,2BAA2B;IAC3B,WAAW,CAAC,OAAO,GAAG,IAAI,CAAC;IAC3B,IAAI,WAAW,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrC,gBAAgB,CAAC,WAAW,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IACrD,CAAC;IAED,OAAO,KAAK,CAAC;AACd,CAAC,CAAC"}

package/esm/use-lunatic/hooks/useOverview.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/use-lunatic/hooks/useOverview.spec.js

@@ -0,0 +1,38 @@
+import { renderHook } from '@testing-library/react';
+import { describe, expect, it } from 'vitest';
+import source from '../../stories/overview/sourceWithHierarchy.json';
+import { useLunatic } from '../use-lunatic';
+import { dataFromObject } from '../test.utils';
+describe('use-overview test with useLunatic()', () => {
+    it('should initialize correctly with disableFilters: false (without data)', () => {
+        const params = [
+            source,
+            dataFromObject({}),
+            { withOverview: true },
+        ];
+        const { result } = renderHook(() => useLunatic(...params));
+        expect(result.current.overview.length).toBe(3);
+    });
+    it('should initialize correctly with disableFilters: false (with data)', () => {
+        const params = [
+            source,
+            dataFromObject({
+                READY: true,
+            }),
+            { withOverview: true },
+        ];
+        const { result } = renderHook(() => useLunatic(...params));
+        expect(result.current.overview.length).toBe(9);
+    });
+    it('should initialize correctly with disableFilters: true (without data)', () => {
+        const params = [
+            source,
+            dataFromObject({}),
+            { withOverview: true, disableFilters: true },
+        ];
+        const { result } = renderHook(() => useLunatic(...params));
+        // All elements have to be presents
+        expect(result.current.overview.length).toBe(9);
+    });
+});
+//# sourceMappingURL=useOverview.spec.js.map

package/esm/use-lunatic/hooks/useOverview.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useOverview.spec.js","sourceRoot":"","sources":["../../../src/use-lunatic/hooks/useOverview.spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,MAAM,MAAM,iDAAiD,CAAC;AACrE,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAE/C,QAAQ,CAAC,qCAAqC,EAAE,GAAG,EAAE;IACpD,EAAE,CAAC,uEAAuE,EAAE,GAAG,EAAE;QAChF,MAAM,MAAM,GAAG;YACd,MAAa;YACb,cAAc,CAAC,EAAE,CAAC;YAClB,EAAE,YAAY,EAAE,IAAI,EAAE;SACb,CAAC;QACX,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;QAC3D,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAChD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oEAAoE,EAAE,GAAG,EAAE;QAC7E,MAAM,MAAM,GAAG;YACd,MAAa;YACb,cAAc,CAAC;gBACd,KAAK,EAAE,IAAI;aACX,CAAC;YACF,EAAE,YAAY,EAAE,IAAI,EAAE;SACb,CAAC;QAEX,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;QAC3D,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAChD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sEAAsE,EAAE,GAAG,EAAE;QAC/E,MAAM,MAAM,GAAG;YACd,MAAa;YACb,cAAc,CAAC,EAAE,CAAC;YAClB,EAAE,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE;SACnC,CAAC;QAEX,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;QAC3D,mCAAmC;QACnC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAChD,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC"}

package/esm/use-lunatic/test.utils.d.ts

@@ -0,0 +1,2 @@
+import { LunaticData } from './type';
+export declare const dataFromObject: (o: Record<string, unknown>) => LunaticData;

package/esm/use-lunatic/test.utils.js

@@ -0,0 +1,13 @@
+export const dataFromObject = (o) => {
+    return {
+        EXTERNAL: {},
+        COLLECTED: Object.keys(o).reduce((acc, k) => ({
+            ...acc,
+            [k]: {
+                COLLECTED: o[k],
+            },
+        }), {}),
+        CALCULATED: {},
+    };
+};
+//# sourceMappingURL=test.utils.js.map

package/esm/use-lunatic/test.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test.utils.js","sourceRoot":"","sources":["../../src/use-lunatic/test.utils.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAA0B,EAAe,EAAE;IACzE,OAAO;QACN,QAAQ,EAAE,EAAE;QACZ,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAC/B,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;YACZ,GAAG,GAAG;YACN,CAAC,CAAC,CAAC,EAAE;gBACJ,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC;aACf;SACD,CAAC,EACF,EAAE,CACF;QACD,UAAU,EAAE,EAAE;KACd,CAAC;AACH,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@inseefr/lunatic",
-    "version": "3.4.15",
+    "version": "3.4.16",
     "description": "Library of questionnaire components",
     "repository": {
         "type": "git",
@@ -408,6 +408,7 @@
         "src/use-lunatic/hooks/use-loop-variables.ts",
         "src/use-lunatic/hooks/use-page-has-response.test.ts",
         "src/use-lunatic/hooks/use-page-has-response.ts",
+        "src/use-lunatic/hooks/useOverview.spec.ts",
         "src/use-lunatic/hooks/useOverview.ts",
         "src/use-lunatic/hooks/useWarnDepChange.ts",
         "src/use-lunatic/logger/ConsoleLogger.ts",
@@ -434,6 +435,7 @@
         "src/use-lunatic/reducer/reducer.ts",
         "src/use-lunatic/reducer/reducerInitializer.tsx",
         "src/use-lunatic/replace-component-sequence.ts",
+        "src/use-lunatic/test.utils.ts",
         "src/use-lunatic/type.ts",
         "src/use-lunatic/use-lunatic.test.ts",
         "src/use-lunatic/use-lunatic.ts",
@@ -1327,6 +1329,7 @@
         "esm/index.js.map",
         "esm/main.css",
         "esm/main.css.map",
+        "esm/stories/overview/sourceWithHierarchy.json",
         "esm/tests/setup.d.ts",
         "esm/tests/setup.js",
         "esm/tests/setup.js.map",
@@ -1435,6 +1438,9 @@
         "esm/use-lunatic/hooks/useOverview.d.ts",
         "esm/use-lunatic/hooks/useOverview.js",
         "esm/use-lunatic/hooks/useOverview.js.map",
+        "esm/use-lunatic/hooks/useOverview.spec.d.ts",
+        "esm/use-lunatic/hooks/useOverview.spec.js",
+        "esm/use-lunatic/hooks/useOverview.spec.js.map",
         "esm/use-lunatic/hooks/useWarnDepChange.d.ts",
         "esm/use-lunatic/hooks/useWarnDepChange.js",
         "esm/use-lunatic/hooks/useWarnDepChange.js.map",
@@ -1510,6 +1516,9 @@
         "esm/use-lunatic/replace-component-sequence.d.ts",
         "esm/use-lunatic/replace-component-sequence.js",
         "esm/use-lunatic/replace-component-sequence.js.map",
+        "esm/use-lunatic/test.utils.d.ts",
+        "esm/use-lunatic/test.utils.js",
+        "esm/use-lunatic/test.utils.js.map",
         "esm/use-lunatic/type.d.ts",
         "esm/use-lunatic/type.js",
         "esm/use-lunatic/type.js.map",
@@ -1650,6 +1659,7 @@
         "index.js.map",
         "main.css",
         "main.css.map",
+        "stories/overview/sourceWithHierarchy.json",
         "tests/setup.d.ts",
         "tests/setup.js",
         "tests/setup.js.map",
@@ -1759,6 +1769,9 @@
         "use-lunatic/hooks/useOverview.d.ts",
         "use-lunatic/hooks/useOverview.js",
         "use-lunatic/hooks/useOverview.js.map",
+        "use-lunatic/hooks/useOverview.spec.d.ts",
+        "use-lunatic/hooks/useOverview.spec.js",
+        "use-lunatic/hooks/useOverview.spec.js.map",
         "use-lunatic/hooks/useWarnDepChange.d.ts",
         "use-lunatic/hooks/useWarnDepChange.js",
         "use-lunatic/hooks/useWarnDepChange.js.map",
@@ -1834,6 +1847,9 @@
         "use-lunatic/replace-component-sequence.d.ts",
         "use-lunatic/replace-component-sequence.js",
         "use-lunatic/replace-component-sequence.js.map",
+        "use-lunatic/test.utils.d.ts",
+        "use-lunatic/test.utils.js",
+        "use-lunatic/test.utils.js.map",
         "use-lunatic/type.d.ts",
         "use-lunatic/type.js",
         "use-lunatic/type.js.map",

package/src/stories/overview/overview.stories.jsx

@@ -33,3 +33,12 @@ WithLoop.args = {
 	data: dataLoop.data,
 	lastReachedPage: '11.2#2',
 };
+
+export const DisableFilterOverview = Template.bind({});
+DisableFilterOverview.args = {
+	id: 'overview-disableFilter',
+	source,
+	showOverview: true,
+	disableFilters: true,
+	data,
+};

package/src/use-lunatic/hooks/useOverview.spec.ts

@@ -0,0 +1,42 @@
+import { renderHook } from '@testing-library/react';
+import { describe, expect, it } from 'vitest';
+import source from '../../stories/overview/sourceWithHierarchy.json';
+import { useLunatic } from '../use-lunatic';
+import { dataFromObject } from '../test.utils';
+
+describe('use-overview test with useLunatic()', () => {
+	it('should initialize correctly with disableFilters: false (without data)', () => {
+		const params = [
+			source as any,
+			dataFromObject({}),
+			{ withOverview: true },
+		] as const;
+		const { result } = renderHook(() => useLunatic(...params));
+		expect(result.current.overview.length).toBe(3);
+	});
+
+	it('should initialize correctly with disableFilters: false (with data)', () => {
+		const params = [
+			source as any,
+			dataFromObject({
+				READY: true,
+			}),
+			{ withOverview: true },
+		] as const;
+
+		const { result } = renderHook(() => useLunatic(...params));
+		expect(result.current.overview.length).toBe(9);
+	});
+
+	it('should initialize correctly with disableFilters: true (without data)', () => {
+		const params = [
+			source as any,
+			dataFromObject({}),
+			{ withOverview: true, disableFilters: true },
+		] as const;
+
+		const { result } = renderHook(() => useLunatic(...params));
+		// All elements have to be presents
+		expect(result.current.overview.length).toBe(9);
+	});
+});

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

@@ -1,4 +1,5 @@
 import type {
+	LunaticOptions,
 	LunaticOverviewItem,
 	LunaticReducerState,
 	PageTag,
@@ -25,13 +26,23 @@ export const useOverview = (
 		overview,
 		executeExpression,
 		pager,
-	}: Pick<LunaticReducerState, 'executeExpression' | 'overview' | 'pager'>,
+		options,
+	}: Pick<
+		LunaticReducerState,
+		'executeExpression' | 'overview' | 'pager' | 'options'
+	>,
 	deps: DependencyList
 ) => {
 	return useMemo(
-		() => interpretOverview(overview, executeExpression, pager),
+		() =>
+			interpretOverview(
+				overview,
+				executeExpression,
+				pager,
+				options.disableFilters
+			),
 		// eslint-disable-next-line react-hooks/exhaustive-deps
-		[...deps, overview]
+		[...deps, overview, options.disableFilters]
 	);
 };
 
@@ -41,11 +52,16 @@ export const useOverview = (
 const interpretOverview = (
 	overviewItems: LunaticOverviewItem[],
 	executeExpression: LunaticReducerState['executeExpression'],
-	pager?: LunaticReducerState['pager']
+	pager?: LunaticReducerState['pager'],
+	disableFilters?: LunaticOptions['disableFilters']
 ) => {
 	// Flat structure of the overview
 	let items = overviewItems.reduce(
-		(acc, item) => interpretOverviewItem(acc, item, executeExpression, pager),
+		(acc, item) =>
+			interpretOverviewItem(acc, item, executeExpression, {
+				pager,
+				disableFilters,
+			}),
 		[] as InterpretedLunaticOverviewItem[]
 	);
 	// Sort using the page logic
@@ -77,7 +93,11 @@ const interpretOverviewItem = (
 	items: InterpretedLunaticOverviewItem[],
 	item: LunaticOverviewItem,
 	executeExpression: LunaticReducerState['executeExpression'],
-	pager?: LunaticReducerState['pager'],
+	state: {
+		pager?: LunaticReducerState['pager'];
+		disableFilters?: LunaticOptions['disableFilters'];
+	},
+
 	iteration?: number
 ): InterpretedLunaticOverviewItem[] => {
 	// We reached a loop item, we need to add it multiple time
@@ -85,19 +105,21 @@ const interpretOverviewItem = (
 		const iterations = executeExpression<number>(item.iterations) ?? 0;
 		return Array.from({ length: iterations }).reduce(
 			(acc: InterpretedLunaticOverviewItem[], _, k) => {
-				return interpretOverviewItem(acc, item, executeExpression, pager, k);
+				return interpretOverviewItem(acc, item, executeExpression, state, k);
 			},
 			items
 		);
 	}
 
-	const isVisible = item.conditionFilter
-		? Boolean(
-				executeExpression(item.conditionFilter, {
-					iteration: iteration,
-				})
-			)
-		: true;
+	// if disableFilters is set to true, item are visible and reached by default
+	const isVisible = (() => {
+		if (state.disableFilters || !item.conditionFilter) return true;
+		return Boolean(
+			executeExpression(item.conditionFilter, {
+				iteration: iteration,
+			})
+		);
+	})();
 
 	if (!isVisible) {
 		return items;
@@ -106,6 +128,10 @@ const interpretOverviewItem = (
 	// Append the item to the list of items
 	const page =
 		`${item.pageTag}${iteration !== undefined ? `#${iteration + 1}` : ''}` as PageTag;
+
+	const reached =
+		pageTagComparator(state.pager ? getPageTag(state.pager) : '-1', page) >= 0;
+
 	return [
 		...items,
 		{
@@ -116,10 +142,7 @@ const interpretOverviewItem = (
 				? executeExpression(item.description, { iteration })
 				: undefined,
 			children: [],
-			reached:
-				pageTagComparator(pager ? getPageTag(pager) : '-1', page) >= 0
-					? true
-					: false,
+			reached: reached,
 			page: page,
 			current: false,
 		},

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

@@ -0,0 +1,17 @@
+import { LunaticData } from './type';
+
+export const dataFromObject = (o: Record<string, unknown>): LunaticData => {
+	return {
+		EXTERNAL: {},
+		COLLECTED: Object.keys(o).reduce(
+			(acc, k) => ({
+				...acc,
+				[k]: {
+					COLLECTED: o[k],
+				},
+			}),
+			{}
+		),
+		CALCULATED: {},
+	};
+};

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

@@ -9,25 +9,10 @@ import sourceCheckboxGroup from '../stories/checkbox-group/source.json';
 import dataOverview from '../stories/overview/dataLoop.json';
 import sourceCleaningLoop from '../stories/behaviour/cleaning/source-loop.json';
 import sourceCleaningResizing from '../stories/behaviour/resizing/source-resizing-cleaning.json';
-import type { LunaticData, PageTag } from './type';
+import type { PageTag } from './type';
 import { useLunatic } from './use-lunatic';
 import { useCallback } from 'react';
-
-const dataFromObject = (o: Record<string, unknown>): LunaticData => {
-	return {
-		EXTERNAL: {},
-		COLLECTED: Object.keys(o).reduce(
-			(acc, k) => ({
-				...acc,
-				[k]: {
-					COLLECTED: o[k],
-				},
-			}),
-			{}
-		),
-		CALCULATED: {},
-	};
-};
+import { dataFromObject } from './test.utils';
 
 describe('use-lunatic()', () => {
 	const defaultParams = [