@inseefr/lunatic 3.4.10-rc.1 → 3.4.11-rc.0

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

@@ -1,7 +1,7 @@
 import { useMemo } from 'react';
 import { getPageTag, pageTagComparator } from '../commons/page-tag';
 /**
- * Hook to build a filled overview everytime the deps change
+ * Build a filled overview everytime the deps change.
  */
 export const useOverview = ({ overview, executeExpression, pager, }, deps) => {
     return useMemo(() => interpretOverview(overview, executeExpression, pager), 
@@ -9,7 +9,7 @@ export const useOverview = ({ overview, executeExpression, pager, }, deps) => {
     [...deps, overview]);
 };
 /**
- * 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, executeExpression, pager) => {
     // Flat structure of the overview
@@ -34,7 +34,7 @@ const interpretOverview = (overviewItems, executeExpression, pager) => {
     return rootItems;
 };
 /**
- * Interpret expression inside an item (label & condition)
+ * Interpret expression inside an item (label & condition).
  */
 const interpretOverviewItem = (items, item, executeExpression, pager, iteration) => {
     var _a;
@@ -74,7 +74,7 @@ const interpretOverviewItem = (items, item, executeExpression, pager, iteration)
     ];
 };
 /**
- * Set the current property in the correct overview item
+ * Set the current property in the correct overview item.
  */
 const applyCurrentPage = (items, currentPage) => {
     // Look for the last item where page <= currentPage

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

@@ -1,6 +1,7 @@
 import type { LunaticLogger } from '../logger/type';
 /**
- * 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 declare function useWarnDepChange(variable: unknown, message: string, logger: LunaticLogger): void;

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

@@ -1,8 +1,9 @@
 import { useEffect, useRef } from 'react';
 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, message, logger) {
     const firstRender = useRef(true);

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

@@ -1 +1 @@
-{"version":3,"file":"useWarnDepChange.js","sourceRoot":"","sources":["../../../src/use-lunatic/hooks/useWarnDepChange.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAE1C,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAEpD;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAC/B,QAAiB,EACjB,OAAe,EACf,MAAqB;IAErB,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;IACjC,MAAM,SAAS,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;IACrC,SAAS,CAAC,GAAG,EAAE;QACd,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;YAC1B,SAAS,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,CAAC;QACjD,CAAC;QACD,WAAW,CAAC,OAAO,GAAG,KAAK,CAAC;IAC7B,CAAC,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;AACpC,CAAC"}
+{"version":3,"file":"useWarnDepChange.js","sourceRoot":"","sources":["../../../src/use-lunatic/hooks/useWarnDepChange.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAE1C,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAEpD;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAC/B,QAAiB,EACjB,OAAe,EACf,MAAqB;IAErB,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;IACjC,MAAM,SAAS,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;IACrC,SAAS,CAAC,GAAG,EAAE;QACd,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;YAC1B,SAAS,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,CAAC;QACjD,CAAC;QACD,WAAW,CAAC,OAAO,GAAG,KAAK,CAAC;IAC7B,CAAC,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;AACpC,CAAC"}

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

@@ -1,6 +1,9 @@
 import { type FunctionComponent, type PropsWithChildren } from 'react';
-/** 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 declare const useLunaticMissing: () => {
     missing: boolean;
     missingStrategy: () => void;

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

@@ -11,8 +11,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, missingStrategy, shortcut, missingShortcut, dontKnowButton, refusedButton, } = useContext(LunaticContext);
     return {

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

@@ -1 +1 @@
-{"version":3,"file":"lunatic-context.js","sourceRoot":"","sources":["../../src/use-lunatic/lunatic-context.tsx"],"names":[],"mappings":";AAAA,OAAO,EAGN,aAAa,EACb,UAAU,GACV,MAAM,OAAO,CAAC;AAEf,OAAO,CAAC,MAAM,eAAe,CAAC;AAE9B,MAAM,cAAc,GAAG,aAAa,CAAC;IACpC,eAAe,EAAE,GAAG,EAAE,GAAE,CAAC;IACzB,UAAU,EAAE,KAAK;IACjB,OAAO,EAAE,KAAK;IACd,QAAQ,EAAE,KAAK;IACf,eAAe,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;IAC9C,cAAc,EAAE,CAAC,CAAC,EAAE;IACpB,aAAa,EAAE,CAAC,CAAC,EAAE;IACnB,iBAAiB,EAAE,EAAE,qBAAqB,EAAE,KAAK,EAAE;CACnD,CAAC,CAAC;AACH;kDACkD;AAClD,MAAM,CAAC,MAAM,iBAAiB,GAAG,GAAG,EAAE;IACrC,MAAM,EACL,OAAO,EACP,eAAe,EACf,QAAQ,EACR,eAAe,EACf,cAAc,EACd,aAAa,GACb,GAAG,UAAU,CAAC,cAAc,CAAC,CAAC;IAC/B,OAAO;QACN,OAAO;QACP,eAAe;QACf,QAAQ;QACR,eAAe;QACf,cAAc;QACd,aAAa;KACb,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,2BAA2B,GAAG,GAAG,EAAE;IAC/C,MAAM,EAAE,iBAAiB,EAAE,GAAG,UAAU,CAAC,cAAc,CAAC,CAAC;IACzD,OAAO,iBAAiB,CAAC;AAC1B,CAAC,CAAC;AAEF,4EAA4E;AAC5E,MAAM,CAAC,MAAM,oBAAoB,GAAG,GAAG,EAAE;IACxC,OAAO,UAAU,CAAC,cAAc,CAAC,CAAC,UAAU,CAAC;AAC9C,CAAC,CAAC;AAEF,MAAM,UAAU,qBAAqB,CAAC,EACrC,UAAU,EACV,OAAO,EACP,eAAe,EACf,QAAQ,EACR,eAAe,EACf,cAAc,EACd,aAAa,EACb,iBAAiB,GAUjB;IACA,MAAM,KAAK,GAAG;QACb,UAAU;QACV,OAAO;QACP,eAAe;QACf,QAAQ;QACR,eAAe;QACf,cAAc;QACd,aAAa;QACb,iBAAiB;KACjB,CAAC;IACF,OAAO,SAAS,QAAQ,CAAC,EAAE,QAAQ,EAAqB;QACvD,OAAO,CACN,KAAC,cAAc,CAAC,QAAQ,IAAC,KAAK,EAAE,KAAK,YACnC,QAAQ,GACgB,CAC1B,CAAC;IACH,CAAC,CAAC;AACH,CAAC"}
+{"version":3,"file":"lunatic-context.js","sourceRoot":"","sources":["../../src/use-lunatic/lunatic-context.tsx"],"names":[],"mappings":";AAAA,OAAO,EAGN,aAAa,EACb,UAAU,GACV,MAAM,OAAO,CAAC;AAEf,OAAO,CAAC,MAAM,eAAe,CAAC;AAE9B,MAAM,cAAc,GAAG,aAAa,CAAC;IACpC,eAAe,EAAE,GAAG,EAAE,GAAE,CAAC;IACzB,UAAU,EAAE,KAAK;IACjB,OAAO,EAAE,KAAK;IACd,QAAQ,EAAE,KAAK;IACf,eAAe,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;IAC9C,cAAc,EAAE,CAAC,CAAC,EAAE;IACpB,aAAa,EAAE,CAAC,CAAC,EAAE;IACnB,iBAAiB,EAAE,EAAE,qBAAqB,EAAE,KAAK,EAAE;CACnD,CAAC,CAAC;AACH;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,GAAG,EAAE;IACrC,MAAM,EACL,OAAO,EACP,eAAe,EACf,QAAQ,EACR,eAAe,EACf,cAAc,EACd,aAAa,GACb,GAAG,UAAU,CAAC,cAAc,CAAC,CAAC;IAC/B,OAAO;QACN,OAAO;QACP,eAAe;QACf,QAAQ;QACR,eAAe;QACf,cAAc;QACd,aAAa;KACb,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,2BAA2B,GAAG,GAAG,EAAE;IAC/C,MAAM,EAAE,iBAAiB,EAAE,GAAG,UAAU,CAAC,cAAc,CAAC,CAAC;IACzD,OAAO,iBAAiB,CAAC;AAC1B,CAAC,CAAC;AAEF,4EAA4E;AAC5E,MAAM,CAAC,MAAM,oBAAoB,GAAG,GAAG,EAAE;IACxC,OAAO,UAAU,CAAC,cAAc,CAAC,CAAC,UAAU,CAAC;AAC9C,CAAC,CAAC;AAEF,MAAM,UAAU,qBAAqB,CAAC,EACrC,UAAU,EACV,OAAO,EACP,eAAe,EACf,QAAQ,EACR,eAAe,EACf,cAAc,EACd,aAAa,EACb,iBAAiB,GAUjB;IACA,MAAM,KAAK,GAAG;QACb,UAAU;QACV,OAAO;QACP,eAAe;QACf,QAAQ;QACR,eAAe;QACf,cAAc;QACd,aAAa;QACb,iBAAiB;KACjB,CAAC;IACF,OAAO,SAAS,QAAQ,CAAC,EAAE,QAAQ,EAAqB;QACvD,OAAO,CACN,KAAC,cAAc,CAAC,QAAQ,IAAC,KAAK,EAAE,KAAK,YACnC,QAAQ,GACgB,CAC1B,CAAC;IACH,CAAC,CAAC;AACH,CAAC"}

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

@@ -35,11 +35,11 @@ export declare function getComponentTypeProps(component: DeepTranslateExpression
         componentType?: "Textarea";
     } & {
         conditionFilter?: boolean;
-    }) | (Pick<import("../../components/type").LunaticBaseProps<string>, "label" | "description" | "declarations" | "id" | "style"> & import("../..").LunaticExtraProps & {
+    }) | (Pick<import("../../components/type").LunaticBaseProps<string>, "id" | "label" | "style" | "declarations" | "description"> & import("../..").LunaticExtraProps & {
         componentType?: "Sequence";
     } & {
         conditionFilter?: boolean;
-    }) | (Pick<import("../../components/type").LunaticBaseProps<string>, "label" | "description" | "declarations" | "id"> & import("../..").LunaticExtraProps & {
+    }) | (Pick<import("../../components/type").LunaticBaseProps<string>, "id" | "label" | "declarations" | "description"> & import("../..").LunaticExtraProps & {
         componentType?: "Subsequence";
     } & {
         conditionFilter?: boolean;
@@ -184,7 +184,7 @@ export declare function getComponentTypeProps(component: DeepTranslateExpression
         componentType?: "Dropdown";
     } & {
         conditionFilter?: boolean;
-    }) | (Pick<import("../../components/type").LunaticBaseProps<unknown>, "label" | "description" | "declarations" | "id" | "propsTransformer" | "errors" | "disabled" | "readOnly"> & import("../..").LunaticExtraProps & {
+    }) | (Pick<import("../../components/type").LunaticBaseProps<unknown>, "id" | "label" | "declarations" | "description" | "propsTransformer" | "errors" | "disabled" | "readOnly"> & import("../..").LunaticExtraProps & {
         components: import("../..").LunaticComponentProps[];
         componentType?: "Question";
         iteration?: number;
@@ -279,7 +279,7 @@ export declare function getComponentTypeProps(component: DeepTranslateExpression
         componentType?: "Switch";
     } & {
         conditionFilter?: boolean;
-    }) | (Pick<import("../../components/type").LunaticBaseProps<string>, "label" | "id"> & import("../..").LunaticExtraProps & {
+    }) | (Pick<import("../../components/type").LunaticBaseProps<string>, "id" | "label"> & import("../..").LunaticExtraProps & {
         componentType?: "FilterDescription";
     } & {
         conditionFilter?: boolean;

package/esm/use-lunatic/reducer/commons/index.d.ts

@@ -1,2 +1 @@
-export { default as resizeArrayVariable } from './resize-array-variable';
 export * from './validate-condition-filter';

package/esm/use-lunatic/reducer/commons/index.js

@@ -1,3 +1,2 @@
-export { default as resizeArrayVariable } from './resize-array-variable';
 export * from './validate-condition-filter';
 //# sourceMappingURL=index.js.map

package/esm/use-lunatic/reducer/commons/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/use-lunatic/reducer/commons/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AACzE,cAAc,6BAA6B,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/use-lunatic/reducer/commons/index.ts"],"names":[],"mappings":"AAAA,cAAc,6BAA6B,CAAC"}

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,77 +152,173 @@ 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;
     iteration?: number[];
+    removedIndex?: number;
 }[]) => void;

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/esm/utils/array.d.ts

@@ -10,7 +10,11 @@ export declare function setAtIndex<T>(arr: T, index: number | number[], newValue
  * Get a value inside an array
  */
 export declare function getAtIndex(arr: unknown, indexes: number[]): unknown;
+/**
+ * Cast the variable into an array and adjust the length if necessary
+ */
 export declare function resizeArray<T = unknown>(array: unknown, newLength: number, defaultValue?: T): T[];
+export declare function resizeDownArrayWithIndex<T = unknown>(array: T[], removedIndex: number): T[];
 /**
  * Return the first non-null/undefined value of an array
  */

package/esm/utils/array.js

@@ -38,6 +38,9 @@ export function getAtIndex(arr, indexes) {
     }
     return current;
 }
+/**
+ * Cast the variable into an array and adjust the length if necessary
+ */
 export function resizeArray(array, newLength, defaultValue) {
     // The value is not an array, create an empty array
     if (!Array.isArray(array)) {
@@ -46,10 +49,20 @@ export function resizeArray(array, newLength, defaultValue) {
     if (array.length === newLength) {
         return array;
     }
-    return new Array(newLength).fill(defaultValue !== null && defaultValue !== void 0 ? defaultValue : null).map(function (value, index) {
-        return index < array.length ? array[index] : value;
+    return new Array(newLength).fill(defaultValue !== null && defaultValue !== void 0 ? defaultValue : null).reduce(function (step, current, index) {
+        if (index < array.length) {
+            return [...step, array[index]];
+        }
+        return [...step, current];
     }, []);
 }
+export function resizeDownArrayWithIndex(array, removedIndex) {
+    // the removedIndex is not in array
+    if (0 > removedIndex || array.length <= removedIndex) {
+        return array;
+    }
+    return [...array].filter((_, i) => i !== removedIndex);
+}
 /**
  * Return the first non-null/undefined value of an array
  */

package/esm/utils/array.js.map

@@ -1 +1 @@
-{"version":3,"file":"array.js","sourceRoot":"","sources":["../../src/utils/array.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,UAAU,KAAK,CAAI,CAAS,EAAE,EAAoB;IACvD,OAAO,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AACrD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,UAAU,CACzB,GAAM,EACN,KAAwB,EACxB,QAAiB;IAEjB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3B,OAAO,UAAU,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC3C,CAAC;IAED,MAAM,CAAC,YAAY,EAAE,GAAG,SAAS,CAAC,GAAG,KAAK,CAAC;IAE3C,IAAI,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IACrD,IAAI,QAAQ,CAAC,MAAM,GAAG,YAAY,GAAG,CAAC,EAAE,CAAC;QACxC,QAAQ,GAAG,WAAW,CAAC,QAAQ,EAAE,YAAY,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;IAC1D,CAAC;IACD,QAAQ,CAAC,YAAY,CAAC;QACrB,SAAS,CAAC,MAAM,KAAK,CAAC;YACrB,CAAC,CAAC,QAAQ;YACV,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC5D,OAAO,QAAa,CAAC;AACtB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,UAAU,CAAC,GAAY,EAAE,OAAiB;IACzD,IAAI,OAAO,GAAG,GAAG,CAAC;IAElB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QAC7B,OAAO,SAAS,CAAC;IAClB,CAAC;IAED,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC7B,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,IAAK,OAAqB,CAAC,MAAM,EAAE,CAAC;YACzD,OAAO,SAAS,CAAC,CAAC,wCAAwC;QAC3D,CAAC;QAED,OAAO,GAAI,OAAqB,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;IAED,OAAO,OAAO,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,WAAW,CAC1B,KAAc,EACd,SAAiB,EACjB,YAAgB;IAEhB,mDAAmD;IACnD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3B,OAAO,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,YAAY,aAAZ,YAAY,cAAZ,YAAY,GAAI,IAAI,CAAC,CAAC;IACxD,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAChC,OAAO,KAAK,CAAC;IACd,CAAC;IACD,OAAO,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,YAAY,aAAZ,YAAY,cAAZ,YAAY,GAAI,IAAI,CAAC,CAAC,GAAG,CAAC,UAC1D,KAAK,EACL,KAAK;QAEL,OAAO,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IACpD,CAAC,EAAE,EAAE,CAAC,CAAC;AACR,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,cAAc,CAAc,KAAc;IACzD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3B,OAAO,KAAK,CAAC;IACd,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,IAAI,CAAC,CAAC;AACzD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,SAAS,CAAc,KAAc;IACpD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3B,OAAO,EAAE,CAAC;IACX,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,CAAC,KAAK,CAAC,CAAC;IAChB,CAAC;IACD,MAAM,MAAM,GAAG,EAAW,CAAC;IAC3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACxC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAChC,CAAC;IACD,OAAO,MAAM,CAAC;AACf,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,KAAK,CAAC,GAAY,EAAE,IAAI,GAAG,CAAC;IAC3C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC;IACb,CAAC;IACD,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC;AAChC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,WAAW,CAAI,GAAQ;IACtC,IAAI,OAAO,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;IACrB,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC;IACb,KAAK,MAAM,IAAI,IAAI,GAAG,EAAE,CAAC;QACxB,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;YAC9C,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC;YAClB,OAAO,GAAG,IAAI,CAAC;QAChB,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC;YACrC,OAAO,GAAG,IAAI,CAAC;QAChB,CAAC;IACF,CAAC;IACD,OAAO,OAAO,CAAC;AAChB,CAAC"}
+{"version":3,"file":"array.js","sourceRoot":"","sources":["../../src/utils/array.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,UAAU,KAAK,CAAI,CAAS,EAAE,EAAoB;IACvD,OAAO,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AACrD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,UAAU,CACzB,GAAM,EACN,KAAwB,EACxB,QAAiB;IAEjB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3B,OAAO,UAAU,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC3C,CAAC;IAED,MAAM,CAAC,YAAY,EAAE,GAAG,SAAS,CAAC,GAAG,KAAK,CAAC;IAE3C,IAAI,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IACrD,IAAI,QAAQ,CAAC,MAAM,GAAG,YAAY,GAAG,CAAC,EAAE,CAAC;QACxC,QAAQ,GAAG,WAAW,CAAC,QAAQ,EAAE,YAAY,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;IAC1D,CAAC;IACD,QAAQ,CAAC,YAAY,CAAC;QACrB,SAAS,CAAC,MAAM,KAAK,CAAC;YACrB,CAAC,CAAC,QAAQ;YACV,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC5D,OAAO,QAAa,CAAC;AACtB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,UAAU,CAAC,GAAY,EAAE,OAAiB;IACzD,IAAI,OAAO,GAAG,GAAG,CAAC;IAElB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QAC7B,OAAO,SAAS,CAAC;IAClB,CAAC;IAED,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC7B,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,IAAK,OAAqB,CAAC,MAAM,EAAE,CAAC;YACzD,OAAO,SAAS,CAAC,CAAC,wCAAwC;QAC3D,CAAC;QAED,OAAO,GAAI,OAAqB,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;IAED,OAAO,OAAO,CAAC;AAChB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,WAAW,CAC1B,KAAc,EACd,SAAiB,EACjB,YAAgB;IAEhB,mDAAmD;IACnD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3B,OAAO,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,YAAY,aAAZ,YAAY,cAAZ,YAAY,GAAI,IAAI,CAAC,CAAC;IACxD,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAChC,OAAO,KAAK,CAAC;IACd,CAAC;IACD,OAAO,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,YAAY,aAAZ,YAAY,cAAZ,YAAY,GAAI,IAAI,CAAC,CAAC,MAAM,CAAC,UAC7D,IAAI,EACJ,OAAO,EACP,KAAK;QAEL,IAAI,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;YAC1B,OAAO,CAAC,GAAG,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;QAChC,CAAC;QACD,OAAO,CAAC,GAAG,IAAI,EAAE,OAAO,CAAC,CAAC;IAC3B,CAAC,EAAE,EAAE,CAAC,CAAC;AACR,CAAC;AAED,MAAM,UAAU,wBAAwB,CACvC,KAAU,EACV,YAAoB;IAEpB,mCAAmC;IACnC,IAAI,CAAC,GAAG,YAAY,IAAI,KAAK,CAAC,MAAM,IAAI,YAAY,EAAE,CAAC;QACtD,OAAO,KAAK,CAAC;IACd,CAAC;IACD,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,YAAY,CAAC,CAAC;AACxD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,cAAc,CAAc,KAAc;IACzD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3B,OAAO,KAAK,CAAC;IACd,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,IAAI,CAAC,CAAC;AACzD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,SAAS,CAAc,KAAc;IACpD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3B,OAAO,EAAE,CAAC;IACX,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,CAAC,KAAK,CAAC,CAAC;IAChB,CAAC;IACD,MAAM,MAAM,GAAG,EAAW,CAAC;IAC3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACxC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAChC,CAAC;IACD,OAAO,MAAM,CAAC;AACf,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,KAAK,CAAC,GAAY,EAAE,IAAI,GAAG,CAAC;IAC3C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC;IACb,CAAC;IACD,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC;AAChC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,WAAW,CAAI,GAAQ;IACtC,IAAI,OAAO,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;IACrB,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC;IACb,KAAK,MAAM,IAAI,IAAI,GAAG,EAAE,CAAC;QACxB,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;YAC9C,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC;YAClB,OAAO,GAAG,IAAI,CAAC;QAChB,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC;YACrC,OAAO,GAAG,IAAI,CAAC;QAChB,CAAC;IACF,CAAC;IACD,OAAO,OAAO,CAAC;AAChB,CAAC"}

package/esm/utils/array.spec.js

@@ -1,5 +1,5 @@
 import { describe, it, expect } from 'vitest';
-import { firstValueItem, resizeArray, setAtIndex } from './array';
+import { firstValueItem, resizeArray, resizeDownArrayWithIndex, setAtIndex, } from './array';
 describe('array', () => {
     describe('resizeArray()', () => {
         it('should append new value', () => {
@@ -38,5 +38,16 @@ describe('array', () => {
         expect(firstValueItem([null, 1, 2])).toBe(1);
         expect(firstValueItem([null, undefined, false])).toBe(false);
     });
+    describe('resizeDownArrayWithIndex()', () => {
+        it('should remove an element of array', () => {
+            expect(resizeDownArrayWithIndex([1, 2, 3, 4], 2)).toEqual([1, 2, 4]);
+            expect(resizeDownArrayWithIndex([1, 2, 3, 4], 0)).toEqual([2, 3, 4]);
+            expect(resizeDownArrayWithIndex([1, 2, 3, 4], 3)).toEqual([1, 2, 3]);
+        });
+        it('should not remove element (out of index)', () => {
+            expect(resizeDownArrayWithIndex([1, 2, 3, 4], -1)).toEqual([1, 2, 3, 4]);
+            expect(resizeDownArrayWithIndex([1, 2, 3, 4], 4)).toEqual([1, 2, 3, 4]);
+        });
+    });
 });
 //# sourceMappingURL=array.spec.js.map