@inseefr/lunatic 3.4.10-rc.1 → 3.4.10

package/esm/use-lunatic/type.d.ts

@@ -22,18 +22,32 @@ export type LunaticOverviewItem = {
     iterations?: LunaticExpression;
 };
 export type LunaticSuggester = SuggesterDefinition;
+/** Survey data. */
 export type LunaticData = Partial<Record<Exclude<VariableType, 'COLLECTED'>, Record<string, unknown>> & {
     COLLECTED: Record<string, LunaticCollectedValue>;
 }>;
 export type LunaticValues = {
     [variableName: string]: unknown;
 };
+/**
+ * Errors returned by `useLunatic` hook when an input check is made with their
+ * id, criticity, type and the message to display to the user.
+ */
 export type LunaticError = Pick<ControlDefinition, 'id' | 'criticality' | 'typeOfControl'> & {
     errorMessage: ReactNode;
 };
 export type VariableType = 'COLLECTED' | 'EXTERNAL' | 'CALCULATED';
 export type LunaticExpression = VTLExpression | VTLScalarExpression;
+/**
+ * Page numerotation.
+ *
+ * String representing a location in the survey. It has one of the following
+ * format:
+ * - [page].[sous-page]#[iteration], when we are in a loop or a roundabount
+ * - [page]
+ */
 export type PageTag = `${number}.${number}#${number}` | `${number}`;
+/** Variables provided to Lunatic through the source and used internally in a store. */
 export type LunaticVariable = Variable;
 export type LunaticCollectedValue = Partial<{
     COLLECTED: unknown;
@@ -52,15 +66,51 @@ export type LunaticStateVariable = {
         CalculatedLinked?: LunaticVariable[];
     };
 }[LunaticVariable['variableType']];
+/**
+ * Contains informations about navigation (last page reached, number of pages, subpages, etc.).
+ *
+ * This is the object used internally to determine where we are in the navigation.
+ *
+ * When we are in a loop, the pager will have additional properties.
+ */
 export type LunaticPager = {
+    /** Last page reached. */
     lastReachedPage?: PageTag;
+    /** Last page of the survey. */
     maxPage: number;
-    nbSubPages?: number;
+    /** Current page. */
     page: number;
+    /**
+     * Current subpage.
+     *
+     * Only in a loop.
+     */
     subPage?: number;
+    /**
+     * Number of pages in a loop.
+     *
+     * Only in a loop.
+     */
+    nbSubPages?: number;
+    /**
+     * Iteration index (starts at 0).
+     *
+     * Only in a loop.
+     */
     iteration?: number;
+    /**
+     * Number of iterations (i.e. number of people).
+     *
+     * Only in a loop.
+     */
     nbIterations?: number;
+    /**
+     * Only in a loop.
+     */
     shallowIteration?: number;
+    /**
+     * Only in a loop.
+     */
     linksIterations?: number[];
 };
 export type LunaticReducerState = {
@@ -79,17 +129,22 @@ export type LunaticReducerState = {
             components: LunaticSource['components'];
             isLoop: true;
             iterations: VTLScalarExpression;
+            /** Variables affecting this loop. */
             loopDependencies: string[];
+            /** List of child pages (ex: ['20.1', '20.2'] */
             subPages: string[];
         };
     };
+    /** Run an expression using the value from the state. */
     executeExpression: <T = unknown>(expression: VTLExpression, args?: {
         iteration?: number | number[];
+        /** @deprecated  */
         bindingDependencies?: string[];
         deps?: string[];
     }) => T;
     isInLoop: boolean;
     updatedAt: number;
+    /** Update the value collected for the variable. */
     updateBindings: (variableName: string, value: unknown, options: {
         iteration?: number[];
     }) => unknown;
@@ -97,75 +152,170 @@ export type LunaticReducerState = {
         disableFilters?: boolean;
     };
 };
+/** Specific behaviour options defined in the {@link useLunatic} hook. */
 export type LunaticOptions = {
+    /** Ignore filters. (default: `false`) */
     disableFilters?: boolean;
+    /** Enable VTL and Markdown support. */
     features?: ('MD' | 'VTL')[];
     preferences?: ['COLLECTED'];
+    /** Key in which the data is saved. (default: `"COLLECTED"`) */
     savingType?: 'COLLECTED';
+    /** Function called when a variable is changed by a user input (must be memoized as it is used in dependency of a `useCallback` by the library). */
     onChange?: LunaticChangesHandler;
     onVariableChange?: (event: LunaticVariablesStoreEvents['change']) => void;
+    /**
+     * Not yet implemented.
+     *
+     * Enable management mode which allow to handle multiple states of the same variable (used by recovery positions).
+     *
+     * The administrator can switch between `COLLECTED`, `EDITED`, `INPUTTED` modes. (default: `false`)
+     */
     management?: boolean;
+    /** Enable keyboard shortcuts for checkboxes, radio buttons and missing buttons (default: `false`). */
     shortcut?: boolean;
+    /** Starting page at launch. (default: `"1"`) */
     initialPage?: PageTag;
+    /** Furthest page the user ever reached. */
     lastReachedPage?: PageTag;
+    /** Enable the preemptive loading of suggester data on Lunatic initialization. (default: `false`) */
     autoSuggesterLoading?: boolean;
+    /** Function called to fetch nomenclatures used by the suggesters. */
     getReferentiel?: (name: string) => Promise<Array<IndexEntry>>;
+    /** Enable data controls (form validation). (default: `false`) */
     activeControls?: boolean;
+    /** Enable overview system. (default: `false`) */
     withOverview?: boolean;
+    /** Enable missing system. (default: `false`) */
     missing?: boolean;
+    /** Function triggered when a missing button is clicked. */
     missingStrategy?: () => void;
+    /** Keyboard shortcut that triggers missing buttons. */
     missingShortcut?: {
         dontKnow: string;
         refused: string;
     };
+    /** "Don't know" button label. */
     dontKnowButton?: string;
+    /** "Refused" button label. */
     refusedButton?: string;
+    /** Enable change tracking to keep a track of what variable changed (allow using getChangedData()). (default: `false`) */
     trackChanges?: boolean;
     logger?: LunaticLogger;
     componentsOptions?: {
         detailAlwaysDisplayed?: boolean;
     };
 };
+/**
+ * Return type of {@link useLunatic}.
+ *
+ * Allow to operate the survey.
+ */
 export type LunaticState = {
+    /** Current pager. */
     pager: LunaticPager;
     overview: InterpretedLunaticOverviewItem[];
+    /** Current page numerotation. */
     pageTag: PageTag;
+    /** Date of the last `handleChange` function call. */
     updatedAt: number;
+    /** Necessary component that must wraps `LunaticComponents` to make the library works. */
     Provider: FunctionComponent<PropsWithChildren>;
+    /** Whether or not we're in a loop. */
     isInLoop: boolean;
+    /** Current loop's variables. */
     loopVariables: string[];
+    /** Whether or not we're on the survey first page. */
     isFirstPage: boolean;
+    /** Whether or not we're on the survey last page (we reached `maxPage`). */
     isLastPage: boolean;
+    /** Errors in the survey. */
     errors?: {
         [page: string]: {
             [id: string]: LunaticError[];
         };
     };
+    /** Errors in the current page / iteration. */
     currentErrors?: {
         [id: string]: LunaticError[];
     };
+    /** Errors in modal. */
     modalErrors?: Record<string, LunaticError[]>;
+    /** Navigate to a specific page. */
     goToPage: (page: {
         page: PageTag | number;
         iteration?: number;
         nbIterations?: number;
         subPage?: number;
     }) => void;
+    /** Navigate to the next page. */
     goNextPage: () => void;
+    /** Navigate to the previous page. */
     goPreviousPage: () => void;
+    /** Allow to fetch controls. */
     compileControls: () => {
         currentErrors: Record<string, LunaticError[]> | undefined;
         isCritical: boolean;
     };
+    /**
+     * Components to display in the current page.
+     *
+     * Return an array with the various components' properties. The orchestrator
+     * has to handle how they are displayed, using the `componentType` property to
+     * select the appropriate component.
+     *
+     * @example
+     * // using `LunaticComponents`
+     * import { useLunatic, LunaticComponents } from '@inseefr/lunatic';
+     *
+     * function App({ source, data }) {
+     *   const { getComponents, Provider } = useLunatic(source, data, {});
+     *   const components = getComponents();
+     *
+     *   return (
+     *     <Provider>
+     *       <LunaticComponents components={components} />
+     *     </Provider>
+     *   );
+     * }
+     *
+     * @example
+     * // using custom components
+     * import { useLunatic, LunaticComponents } from '@inseefr/lunatic';
+     *
+     * const customCompoonents = {
+     *   Input: MyCustomInput,
+     *   InputNumber: MyCustomInputNumber,
+     * };
+     *
+     * function App({ source, data }) {
+     *   const { getComponents, Provider } = useLunatic(source, data, {});
+     *   const components = getComponents();
+     *
+     *   return (
+     *     <Provider>
+     *       <LunaticComponents components={components} slots={customComponents} />
+     *     </Provider>
+     *   );
+     * }
+     *
+     * @see {@link LunaticComponents}
+     */
     getComponents: () => LunaticComponentProps[];
+    /** Get data collected by the survey. */
     getData: (withRefreshedCalculated: boolean, variableNames?: string[]) => LunaticData;
-    getChangedData: (reset: boolean) => LunaticData;
+    /** Get data that have changed since last reset. Returns the same thing as `getData()`. */
+    getChangedData: (reset?: boolean) => LunaticData;
+    /** Empty the store of changed variables. */
     resetChangedData: () => void;
+    /** Return `true` as soon as the current page has at least one answer. */
     hasPageResponse: () => boolean;
+    /** Used for testing purpose only. */
     testing: {
         handleChanges: LunaticChangesHandler;
     };
 };
+/** Function taking as arguments the various changes the user has made. */
 export type LunaticChangesHandler = (args: {
     name: string;
     value: any;

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

@@ -1,37 +1,14 @@
-import type { LunaticChangesHandler, LunaticData, LunaticOptions, PageTag } from './type';
+import type { LunaticData, LunaticOptions, LunaticState } from './type';
 import type { LunaticSource } from './type';
-export declare function useLunatic(source: LunaticSource, data?: LunaticData, argOptions?: LunaticOptions): {
-    pageTag: PageTag;
-    isFirstPage: boolean;
-    isLastPage: boolean;
-    updatedAt: number;
-    pager: import("./type").LunaticPager;
-    isInLoop: boolean;
-    overview: import("./hooks/useOverview").InterpretedLunaticOverviewItem[];
-    loopVariables: string[];
-    getComponents: () => import("..").LunaticComponentProps[];
-    goPreviousPage: () => void;
-    goNextPage: () => void;
-    goToPage: (page: {
-        page: PageTag | number;
-        iteration?: number;
-        nbIterations?: number;
-        subPage?: number;
-    }) => void;
-    compileControls: () => {
-        currentErrors: Record<string, import("./type").LunaticError[]> | undefined;
-        isCritical: boolean;
-    };
-    getData: (withRefreshedCalculated: boolean, variableNames?: string[]) => LunaticData;
-    getChangedData: (reset?: boolean) => Partial<Record<"EXTERNAL" | "CALCULATED", Record<string, unknown>> & {
-        COLLECTED: Record<string, import("./type").LunaticCollectedValue>;
-    }>;
-    resetChangedData: () => void;
-    hasPageResponse: () => boolean;
-    Provider: import("react").FunctionComponent<{
-        children?: import("react").ReactNode | undefined;
-    }>;
-    testing: {
-        handleChanges: LunaticChangesHandler;
-    };
-};
+/** The first library entrypoint is the `useLunatic` hook. */
+export declare function useLunatic(
+/**
+ * JSON representation of our survey unit in the Lunatic Model.
+ *
+ * {@link https://github.com/InseeFr/Lunatic-Model}
+ */
+source: LunaticSource, 
+/** Initial survey data (i.e. if it has been partially filled). */
+data?: LunaticData, 
+/** Specific behaviour options. */
+argOptions?: LunaticOptions): LunaticState;

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

@@ -49,7 +49,18 @@ const defaultOptions = {
     logger: ConsoleLogger,
     componentsOptions: { detailAlwaysDisplayed: false },
 };
-export function useLunatic(source, data = DEFAULT_DATA, argOptions = empty) {
+/** The first library entrypoint is the `useLunatic` hook. */
+export function useLunatic(
+/**
+ * JSON representation of our survey unit in the Lunatic Model.
+ *
+ * {@link https://github.com/InseeFr/Lunatic-Model}
+ */
+source, 
+/** Initial survey data (i.e. if it has been partially filled). */
+data = DEFAULT_DATA, 
+/** Specific behaviour options. */
+argOptions = empty) {
     const options = mergeDefault(argOptions, defaultOptions);
     const { disableFilters, management, missing, missingStrategy, shortcut, missingShortcut, dontKnowButton, refusedButton, onChange, trackChanges, preferences, logger, componentsOptions, } = options;
     // Help debug with warnings for options expected to be memoized
@@ -60,7 +71,7 @@ export function useLunatic(source, data = DEFAULT_DATA, argOptions = empty) {
         data,
         onVariableChange: useRefSync(options.onVariableChange),
     }, reducerInitializer);
-    // Required context provider: cleaner than prop drilling through every component
+    /** Required context provider: cleaner than prop drilling through every component */
     const Provider = useMemo(() => createLunaticProvider({
         management,
         missing,

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

@@ -1 +1 @@
-{"version":3,"file":"use-lunatic.js","sourceRoot":"","sources":["../../src/use-lunatic/use-lunatic.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AACzD,OAAO,EACN,cAAc,EACd,gBAAgB,EAChB,oBAAoB,EACpB,mBAAmB,GACnB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAQxD,OAAO,CAAC,MAAM,SAAS,CAAC;AACxB,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAE1D,OAAO,EAAE,eAAe,IAAI,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AACnF,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,oBAAoB,EAAE,MAAM,4CAA4C,CAAC;AAClF,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAC7E,OAAO,EAAE,cAAc,EAAE,MAAM,2CAA2C,CAAC;AAC3E,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAE5D,MAAM,KAAK,GAAG,EAAE,CAAC,CAAC,4EAA4E;AAC9F,MAAM,YAAY,GAAG,KAAoB,CAAC;AAC1C,MAAM,gBAAgB,GAAG,CAAC,KAAK,EAAE,IAAI,CAAkB,CAAC;AACxD,MAAM,mBAAmB,GAAG,CAAC,SAAS,CAAkB,CAAC;AACzD,MAAM,gBAAgB,GAAG,EAAE,QAAQ,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;AAEvD,MAAM,iBAAiB,GAAG,CAAC,CAAC,EAAE,CAAC;AAC/B,MAAM,eAAe,GAAG,CAAC,CAAC,EAAE,CAAC;AAE7B,MAAM,cAAc,GAAG;IACtB,cAAc,EAAE,KAAK;IACrB,QAAQ,EAAE,gBAAgB;IAC1B,WAAW,EAAE,mBAAmB;IAChC,UAAU,EAAE,SAAS;IACrB,QAAQ,EAAE,GAAG,EAAE,GAAE,CAAC;IAClB,gBAAgB,EAAE,GAAG,EAAE,GAAE,CAAC;IAC1B,UAAU,EAAE,KAAK;IACjB,QAAQ,EAAE,KAAK;IACf,WAAW,EAAE,GAAc;IAC3B,eAAe,EAAE,SAAS;IAC1B,oBAAoB,EAAE,KAAK;IAC3B,cAAc,EAAE,KAAK;IACrB,0EAA0E;IAC1E,YAAY,EAAE,KAAK;IACnB,OAAO,EAAE,KAAK;IACd,eAAe,EAAE,GAAG,EAAE,GAAE,CAAC;IACzB,eAAe,EAAE,gBAAgB;IACjC,cAAc,EAAE,iBAAiB;IACjC,aAAa,EAAE,eAAe;IAC9B,YAAY,EAAE,KAAK;IACnB,MAAM,EAAE,aAAa;IACrB,iBAAiB,EAAE,EAAE,qBAAqB,EAAE,KAAK,EAAE;CAC1B,CAAC;AAE3B,MAAM,UAAU,UAAU,CACzB,MAAqB,EACrB,OAAoB,YAAY,EAChC,aAA6B,KAAK;IAElC,MAAM,OAAO,GAAG,YAAY,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;IACzD,MAAM,EACL,cAAc,EACd,UAAU,EACV,OAAO,EACP,eAAe,EACf,QAAQ,EACR,eAAe,EACf,cAAc,EACd,aAAa,EACb,QAAQ,EACR,YAAY,EACZ,WAAW,EACX,MAAM,EACN,iBAAiB,GACjB,GAAG,OAAO,CAAC;IAEZ,+DAA+D;IAC/D,gBAAgB,CACf,MAAM,EACN,kDAAkD,EAClD,MAAM,CACN,CAAC;IAEF,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,UAAU,CACnC,OAAO,EACP;QACC,GAAG,OAAO;QACV,MAAM;QACN,IAAI;QACJ,gBAAgB,EAAE,UAAU,CAAC,OAAO,CAAC,gBAAgB,CAAC;KACtD,EACD,kBAAkB,CAClB,CAAC;IAEF,gFAAgF;IAChF,MAAM,QAAQ,GAAG,OAAO,CACvB,GAAG,EAAE,CACJ,qBAAqB,CAAC;QACrB,UAAU;QACV,OAAO;QACP,eAAe;QACf,QAAQ;QACR,eAAe;QACf,cAAc;QACd,aAAa;QACb,iBAAiB;KACjB,CAAC;IACH,wJAAwJ;IACxJ;QACC,UAAU;QACV,OAAO;QACP,eAAe;QACf,QAAQ;QACR,eAAe,CAAC,QAAQ;QACxB,eAAe,CAAC,OAAO;QACvB,cAAc;QACd,aAAa;QACb,iBAAiB,CAAC,qBAAqB;KACvC,CACD,CAAC;IAEF,MAAM,eAAe,GAAoC,GAAG,EAAE;QAC7D,OAAO,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC,CAAC;IAEF,MAAM,cAAc,GAAmC,WAAW,CACjE;QACC,QAAQ,CAAC,oBAAoB,EAAE,CAAC,CAAC;IAClC,CAAC,EACD,CAAC,QAAQ,CAAC,CACV,CAAC;IAEF,MAAM,UAAU,GAA+B,WAAW,CACzD,UAAU,OAAO,GAAG,EAAE;QACrB,QAAQ,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC;IACrC,CAAC,EACD,CAAC,QAAQ,CAAC,CACV,CAAC;IAEF,MAAM,QAAQ,GAA6B,WAAW,CACrD,UAAU,OAAO;QAChB,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;IACnC,CAAC,EACD,CAAC,QAAQ,CAAC,CACV,CAAC;IACF,MAAM,aAAa,GAAG,WAAW,CAChC,CAAC,SAAS,EAAE,EAAE;QACb,QAAQ,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC,CAAC;QACzC,QAAQ,CAAC,SAAS,CAAC,CAAC;IACrB,CAAC,EACD,CAAC,QAAQ,EAAE,QAAQ,CAAC,CACpB,CAAC;IAEF,MAAM,OAAO,GAA4B,CACxC,uBAAuB,EACvB,aAAa,EACZ,EAAE;QACH,OAAO,oBAAoB,CAC1B,KAAK,CAAC,SAAS,EACf,MAAM,CAAC,SAAS,EAChB,uBAAuB,EACvB,aAAa,CACb,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,EAAE,gBAAgB,EAAE,cAAc,EAAE,GAAG,eAAe,CAC3D,YAAY,EACZ,KAAK,CAAC,SAAS,EACf,CAAC,aAAwB,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,aAAa,CAAC,CAC3D,CAAC;IAEF,MAAM,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACxC,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,GAAG,eAAe,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAEjE,MAAM,UAAU,GAAG,cAAc,CAAC,sBAAsB,CAAC,KAAK,CAAC,EAAE;QAChE,cAAc;QACd,aAAa;QACb,WAAW;QACX,QAAQ;QACR,QAAQ;QACR,UAAU;QACV,cAAc;QACd,UAAU;QACV,GAAG,KAAK;KACR,CAAC,CAAC;IAEH,MAAM,aAAa,GAAkC,GAAG,EAAE;QACzD,OAAO,UAAU,CAAC;IACnB,CAAC,CAAC;IAEF,OAAO;QACN,OAAO;QACP,WAAW;QACX,UAAU;QACV,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,QAAQ,EAAE,WAAW,CAAC,KAAK,EAAE,CAAC,OAAO,CAAC,CAAC;QACvC,aAAa,EAAE,gBAAgB,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC;QACzD,UAAU;QACV,aAAa;QACb,cAAc;QACd,UAAU;QACV,QAAQ;QACR,eAAe;QACf,OAAO;QACP,cAAc;QACd,gBAAgB;QAChB,eAAe,EAAE,kBAAkB,CAAC,UAAU,EAAE,KAAK,CAAC,iBAAiB,CAAC;QACxE,aAAa;QACb,QAAQ;QACR,OAAO,EAAE;YACR,aAAa;SACb;KACsB,CAAC;AAC1B,CAAC"}
+{"version":3,"file":"use-lunatic.js","sourceRoot":"","sources":["../../src/use-lunatic/use-lunatic.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AACzD,OAAO,EACN,cAAc,EACd,gBAAgB,EAChB,oBAAoB,EACpB,mBAAmB,GACnB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAQxD,OAAO,CAAC,MAAM,SAAS,CAAC;AACxB,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAE1D,OAAO,EAAE,eAAe,IAAI,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AACnF,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,oBAAoB,EAAE,MAAM,4CAA4C,CAAC;AAClF,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAC7E,OAAO,EAAE,cAAc,EAAE,MAAM,2CAA2C,CAAC;AAC3E,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAE5D,MAAM,KAAK,GAAG,EAAE,CAAC,CAAC,4EAA4E;AAC9F,MAAM,YAAY,GAAG,KAAoB,CAAC;AAC1C,MAAM,gBAAgB,GAAG,CAAC,KAAK,EAAE,IAAI,CAAkB,CAAC;AACxD,MAAM,mBAAmB,GAAG,CAAC,SAAS,CAAkB,CAAC;AACzD,MAAM,gBAAgB,GAAG,EAAE,QAAQ,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;AAEvD,MAAM,iBAAiB,GAAG,CAAC,CAAC,EAAE,CAAC;AAC/B,MAAM,eAAe,GAAG,CAAC,CAAC,EAAE,CAAC;AAE7B,MAAM,cAAc,GAAG;IACtB,cAAc,EAAE,KAAK;IACrB,QAAQ,EAAE,gBAAgB;IAC1B,WAAW,EAAE,mBAAmB;IAChC,UAAU,EAAE,SAAS;IACrB,QAAQ,EAAE,GAAG,EAAE,GAAE,CAAC;IAClB,gBAAgB,EAAE,GAAG,EAAE,GAAE,CAAC;IAC1B,UAAU,EAAE,KAAK;IACjB,QAAQ,EAAE,KAAK;IACf,WAAW,EAAE,GAAc;IAC3B,eAAe,EAAE,SAAS;IAC1B,oBAAoB,EAAE,KAAK;IAC3B,cAAc,EAAE,KAAK;IACrB,0EAA0E;IAC1E,YAAY,EAAE,KAAK;IACnB,OAAO,EAAE,KAAK;IACd,eAAe,EAAE,GAAG,EAAE,GAAE,CAAC;IACzB,eAAe,EAAE,gBAAgB;IACjC,cAAc,EAAE,iBAAiB;IACjC,aAAa,EAAE,eAAe;IAC9B,YAAY,EAAE,KAAK;IACnB,MAAM,EAAE,aAAa;IACrB,iBAAiB,EAAE,EAAE,qBAAqB,EAAE,KAAK,EAAE;CAC1B,CAAC;AAE3B,6DAA6D;AAC7D,MAAM,UAAU,UAAU;AACzB;;;;GAIG;AACH,MAAqB;AACrB,kEAAkE;AAClE,OAAoB,YAAY;AAChC,kCAAkC;AAClC,aAA6B,KAAK;IAElC,MAAM,OAAO,GAAG,YAAY,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;IACzD,MAAM,EACL,cAAc,EACd,UAAU,EACV,OAAO,EACP,eAAe,EACf,QAAQ,EACR,eAAe,EACf,cAAc,EACd,aAAa,EACb,QAAQ,EACR,YAAY,EACZ,WAAW,EACX,MAAM,EACN,iBAAiB,GACjB,GAAG,OAAO,CAAC;IAEZ,+DAA+D;IAC/D,gBAAgB,CACf,MAAM,EACN,kDAAkD,EAClD,MAAM,CACN,CAAC;IAEF,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,UAAU,CACnC,OAAO,EACP;QACC,GAAG,OAAO;QACV,MAAM;QACN,IAAI;QACJ,gBAAgB,EAAE,UAAU,CAAC,OAAO,CAAC,gBAAgB,CAAC;KACtD,EACD,kBAAkB,CAClB,CAAC;IAEF,oFAAoF;IACpF,MAAM,QAAQ,GAAG,OAAO,CACvB,GAAG,EAAE,CACJ,qBAAqB,CAAC;QACrB,UAAU;QACV,OAAO;QACP,eAAe;QACf,QAAQ;QACR,eAAe;QACf,cAAc;QACd,aAAa;QACb,iBAAiB;KACjB,CAAC;IACH,wJAAwJ;IACxJ;QACC,UAAU;QACV,OAAO;QACP,eAAe;QACf,QAAQ;QACR,eAAe,CAAC,QAAQ;QACxB,eAAe,CAAC,OAAO;QACvB,cAAc;QACd,aAAa;QACb,iBAAiB,CAAC,qBAAqB;KACvC,CACD,CAAC;IAEF,MAAM,eAAe,GAAoC,GAAG,EAAE;QAC7D,OAAO,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC,CAAC;IAEF,MAAM,cAAc,GAAmC,WAAW,CACjE;QACC,QAAQ,CAAC,oBAAoB,EAAE,CAAC,CAAC;IAClC,CAAC,EACD,CAAC,QAAQ,CAAC,CACV,CAAC;IAEF,MAAM,UAAU,GAA+B,WAAW,CACzD,UAAU,OAAO,GAAG,EAAE;QACrB,QAAQ,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC;IACrC,CAAC,EACD,CAAC,QAAQ,CAAC,CACV,CAAC;IAEF,MAAM,QAAQ,GAA6B,WAAW,CACrD,UAAU,OAAO;QAChB,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;IACnC,CAAC,EACD,CAAC,QAAQ,CAAC,CACV,CAAC;IAEF,MAAM,aAAa,GAAG,WAAW,CAChC,CAAC,SAAS,EAAE,EAAE;QACb,QAAQ,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC,CAAC;QACzC,QAAQ,CAAC,SAAS,CAAC,CAAC;IACrB,CAAC,EACD,CAAC,QAAQ,EAAE,QAAQ,CAAC,CACpB,CAAC;IAEF,MAAM,OAAO,GAA4B,CACxC,uBAAuB,EACvB,aAAa,EACZ,EAAE;QACH,OAAO,oBAAoB,CAC1B,KAAK,CAAC,SAAS,EACf,MAAM,CAAC,SAAS,EAChB,uBAAuB,EACvB,aAAa,CACb,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,EAAE,gBAAgB,EAAE,cAAc,EAAE,GAAG,eAAe,CAC3D,YAAY,EACZ,KAAK,CAAC,SAAS,EACf,CAAC,aAAwB,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,aAAa,CAAC,CAC3D,CAAC;IAEF,MAAM,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACxC,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,GAAG,eAAe,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAEjE,MAAM,UAAU,GAAG,cAAc,CAAC,sBAAsB,CAAC,KAAK,CAAC,EAAE;QAChE,cAAc;QACd,aAAa;QACb,WAAW;QACX,QAAQ;QACR,QAAQ;QACR,UAAU;QACV,cAAc;QACd,UAAU;QACV,GAAG,KAAK;KACR,CAAC,CAAC;IAEH,MAAM,aAAa,GAAkC,GAAG,EAAE;QACzD,OAAO,UAAU,CAAC;IACnB,CAAC,CAAC;IAEF,OAAO;QACN,OAAO;QACP,WAAW;QACX,UAAU;QACV,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,QAAQ,EAAE,WAAW,CAAC,KAAK,EAAE,CAAC,OAAO,CAAC,CAAC;QACvC,aAAa,EAAE,gBAAgB,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC;QACzD,UAAU;QACV,aAAa;QACb,cAAc;QACd,UAAU;QACV,QAAQ;QACR,eAAe;QACf,OAAO;QACP,cAAc;QACd,gBAAgB;QAChB,eAAe,EAAE,kBAAkB,CAAC,UAAU,EAAE,KAAK,CAAC,iBAAiB,CAAC;QACxE,aAAa;QACb,QAAQ;QACR,OAAO,EAAE;YACR,aAAa;SACb;KACsB,CAAC;AAC1B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@inseefr/lunatic",
-    "version": "3.4.10-rc.1",
+    "version": "3.4.10",
     "description": "Library of questionnaire components",
     "repository": {
         "type": "git",

package/src/components/LunaticComponents.tsx

@@ -19,21 +19,21 @@ import {
 import type { LunaticComponentProps } from './type';
 
 type Props<V = unknown> = {
-	// List of components to display (coming from getComponents)
+	/** List of components to display (coming from getComponents). */
 	components: LunaticComponentProps[];
-	// Should we memoized children
+	/** Should we memoized children. */
 	memo?: boolean;
-	// Key that trigger autofocus when it changes (pageTag)
+	/** Key that trigger autofocus when it changes (pageTag). */
 	autoFocusKey?: string;
-	// Returns the list of extra props to add to components
+	/** Returns the list of extra props to add to components. */
 	componentProps?: (component: LunaticComponentProps) => V;
-	// Forbidden components
+	/** Forbidden components. */
 	blocklist?: string[];
-	// Add additional wrapper around each component
+	/** Add additional wrapper around each component. */
 	wrapper?: (
 		props: PropsWithChildren<LunaticComponentProps & V & { index: number }>
 	) => ReactNode;
-	// Customized deep components
+	/** Customized deep components. */
 	slots?: Partial<LunaticSlotComponents>;
 };
 
@@ -45,7 +45,9 @@ const LunaticComponentWrapper = slottableComponent(
 );
 
 /**
- * Entry point for orchestrators, this component display the list of fields
+ * Entry point for orchestrators, this component display the list of fields.
+ *
+ * Components offered by Lunatic can be seen at {@link https://github.com/InseeFr/Lunatic/tree/3.0/src/components}
  */
 export function LunaticComponents<V = unknown>({
 	components,

package/src/components/shared/HOC/slottableComponent.tsx

@@ -45,7 +45,7 @@ import type { MarkdownLink } from '../MDLabel/MarkdownLink';
 import type { Accordion } from '../../Accordion/Accordion';
 
 /**
- * Contains the type of every customizable component
+ * Contain the type of every customizable components.
  */
 export type LunaticSlotComponents = {
 	// Components
@@ -130,9 +130,9 @@ export const SlotsProvider = ({
 };
 
 /**
- * Create a replaceable version of a component
+ * Create a replaceable version of a component.
  *
- * The component can be replaced using the "slots" props on <LunaticComponents>
+ * The component can be replaced through the `slots` props on `LunaticComponents`.
  */
 export function slottableComponent<T>(
 	name: keyof LunaticSlotComponents,

package/src/use-lunatic/commons/compile-controls.ts

@@ -35,7 +35,8 @@ const isLoopComponent = (
 };
 
 /**
- * Check if components of the current page have errors, and return a map of error (indexed by component ID)
+ * Check if components of the current page have errors, and return a map of
+ * errors (indexed by component ID).
  */
 function checkComponents(
 	state: StateForControls,
@@ -93,7 +94,7 @@ function checkControls(
 }
 
 /**
- * Figure out the number of iterations of a component
+ * Figure out the number of iterations of a component.
  */
 function computeIterations(
 	component: InterpretedComponent | ComponentDefinition,
@@ -210,7 +211,7 @@ function hasCriticalError(errors?: Record<string, LunaticError[]>): boolean {
 }
 
 /**
- * Check controls for currently visible components and output errors
+ * Check controls for currently visible components and output errors.
  */
 export function compileControls(state: StateForControls) {
 	const components = replaceComponentSequence(getComponentsFromState(state));

package/src/use-lunatic/commons/variables/lunatic-variables-store.ts

@@ -19,23 +19,23 @@ import {
 	VTLMissingDependency,
 } from './errors';
 
-// Interpret counter, used for testing purpose
+/** Interpret counter. Used for testing purpose. */
 let interpretCount = 0;
-// Special variable that will take the current iteration value
+/** Special variable that will take the current iteration value. */
 const iterationVariableName = 'GLOBAL_ITERATION_INDEX';
 
 type IterationLevel = number[];
 export type EventArgs = {
 	change: {
-		// Name of the changed variable
+		/** Name of the changed variable. */
 		name: string;
-		// New value for the variable
+		/** New value for the variable. */
 		value: unknown;
-		// Iteration changed (for array)
+		/** Iteration changed (for array). */
 		iteration?: IterationLevel | undefined;
-		// What triggered this change
+		/** What triggered this change. */
 		cause?: 'resizing' | 'cleaning';
-		// Extra sent when setting the variable
+		/** Extra sent when setting the variable. */
 		[extra: string]: unknown;
 	};
 };
@@ -220,7 +220,7 @@ export class LunaticVariablesStore {
 		this.eventTarget.removeEventListener(eventName, cb as EventListener);
 	}
 
-	// Retrieve the number of interpret() run (used in testing only)
+	/** Retrieve the number of interpret() run (used in testing only). */
 	get interpretCount() {
 		return interpretCount;
 	}
@@ -249,25 +249,25 @@ export class LunaticVariablesStore {
 }
 
 class LunaticVariable {
-	// Last time the value was updated (changed)
+	/** Last time the value was updated (changed). */
 	public updatedAt = new Map<undefined | string, number>();
-	// Last time "calculation" was run (for calculated variable)
+	/** Last time "calculation" was run (for calculated variable). */
 	private calculatedAt = new Map<undefined | string, number>();
-	// Internal value for the variable
+	/** Internal value for the variable. */
 	private value: unknown;
-	// List of dependencies, ex: ['FIRSTNAME', 'LASTNAME']
+	/** List of dependencies, ex: ['FIRSTNAME', 'LASTNAME']. */
 	private dependencies?: string[];
-	// Expression for calculated variable
+	/** Expression for calculated variable. */
 	public readonly expression?: string;
-	// Dictionary holding all the available variables
+	/** Dictionary holding all the available variables. */
 	private readonly dictionary?: Map<string, LunaticVariable>;
-	// Specific iteration depth to get value from dependencies (used for yAxis for instance)
+	/** Specific iteration depth to get value from dependencies (used for yAxis for instance). */
 	private readonly iterationDepth?: number;
-	// For calculated variable, shape is copied from another variable
+	/** For calculated variable, shape is copied from another variable. */
 	private readonly shapeFrom?: string[];
-	// Keep a record of variable name (optional, used for debug)
+	/** Keep a record of variable name (optional, used for debug). */
 	public readonly name?: string;
-	// Count the number of calculation
+	/** Count the number of calculation. */
 	public calculatedCount = 0;
 
 	constructor(

package/src/use-lunatic/hooks/use-loop-variables.ts

@@ -2,7 +2,7 @@ import type { LunaticComponentDefinition, LunaticReducerState } from '../type';
 import { useMemo } from 'react';
 
 /**
- * Extract the list of variables used for the current loop
+ * Extract the list of variables used for the current loop.
  */
 export function useLoopVariables(
 	pager: LunaticReducerState['pager'],

package/src/use-lunatic/hooks/use-page-has-response.ts

@@ -4,7 +4,7 @@ import type { LunaticComponentDefinition, LunaticReducerState } from '../type';
 import type { LunaticComponentProps } from '../../components/type';
 
 /**
- * Check if a page has one response (value is filled for at least one field)
+ * Check if a page has one response (value is filled for at least one field).
  */
 export function usePageHasResponse(
 	components: LunaticComponentProps[],
@@ -67,10 +67,10 @@ export function usePageHasResponse(
 }
 
 /**
- * Check if a value is empty
- * - null ou undefined ou ''
- * - for arrays, every item must be empty
- * - for objects, every value must be empty
+ * Check if a value is empty.
+ * - `null`, `undefined` or `''`.
+ * - for arrays, every item must be empty.
+ * - for objects, every value must be empty.
  */
 function isEmpty(value: unknown): boolean {
 	// Array is empty if all items are empty
@@ -86,7 +86,7 @@ function isEmpty(value: unknown): boolean {
 }
 
 /**
- * For complex component we need to inspect child components, interpret the response value
+ * For complex component we need to inspect child components, interpret the response value.
  */
 function isSubComponentsEmpty(
 	components: (LunaticComponentProps | LunaticComponentDefinition)[],

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

@@ -18,7 +18,7 @@ export type InterpretedLunaticOverviewItem = {
 };
 
 /**
- * Hook to build a filled overview everytime the deps change
+ * Build a filled overview everytime the deps change.
  */
 export const useOverview = (
 	{
@@ -36,7 +36,7 @@ export const useOverview = (
 };
 
 /**
- * Use lunatic data to interpret the static overview (calculated on init) with the real data
+ * Use Lunatic data to interpret the static overview (calculated on init) with the real data.
  */
 const interpretOverview = (
 	overviewItems: LunaticOverviewItem[],
@@ -71,7 +71,7 @@ const interpretOverview = (
 };
 
 /**
- * Interpret expression inside an item (label & condition)
+ * Interpret expression inside an item (label & condition).
  */
 const interpretOverviewItem = (
 	items: InterpretedLunaticOverviewItem[],
@@ -127,7 +127,7 @@ const interpretOverviewItem = (
 };
 
 /**
- * Set the current property in the correct overview item
+ * Set the current property in the correct overview item.
  */
 const applyCurrentPage = (
 	items: InterpretedLunaticOverviewItem[],

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

@@ -3,8 +3,9 @@ import type { LunaticLogger } from '../logger/type';
 import { useRefSync } from '../../hooks/useRefSync';
 
 /**
- * Log a warning when the variable change
- * ensure that we received a memoized value and help debug
+ * Log a warning when the variable change.
+ *
+ * Ensure that we received a memoized value and help debug.
  */
 export function useWarnDepChange(
 	variable: unknown,

package/src/use-lunatic/lunatic-context.tsx

@@ -17,8 +17,11 @@ const LunaticContext = createContext({
 	refusedButton: D.RF,
 	componentsOptions: { detailAlwaysDisplayed: false },
 });
-/** Provide `missing` `missingStrategy`, `shortcut` and `missingShortcut`, `dontKnowButton`, `refusedButton` to Missing component
- *  to manage non-response buttons and shortcut */
+/**
+ * Provide `missing`, `missingStrategy`, `shortcut` and `missingShortcut`,
+ * `dontKnowButton`, `refusedButton` to `Missing` component to manage
+ * non-response buttons and shortcut.
+ */
 export const useLunaticMissing = () => {
 	const {
 		missing,