@inseefr/lunatic 3.0.0-rc.6 → 3.0.0-rc.9

package/lib/src/use-lunatic/type-source.d.ts

@@ -34,8 +34,8 @@ export type ControlType = {
     typeOfControl: 'FORMAT' | 'CONSISTENCY';
     control: LabelType;
     errorMessage: LabelType;
-    bindingDependencies: string[];
-    type: 'roundabout' | 'ROW' | 'simple';
+    bindingDependencies?: string[];
+    type?: 'roundabout' | 'ROW' | 'simple';
     iterations?: number;
 };
 export type ResponseType = {
@@ -52,6 +52,7 @@ export type Hierarchy = {
 };
 export type ComponentTypeBase = {
     label: LabelType;
+    description?: LabelType;
     declarations?: DeclarationType[];
     conditionFilter?: ConditionFilterType;
     controls?: ControlType[];
@@ -61,9 +62,7 @@ export type ComponentTypeBase = {
     mandatory?: boolean;
     page: string;
 };
-export type ComponentType = (ComponentTypeBase & ComponentSequenceType) | (ComponentTypeBase & ComponentSubSequenceType) | (ComponentTypeBase & ComponentRosterForLoopType) | (ComponentTypeBase & ComponentLoopType) | (ComponentTypeBase & ComponentTableType) | (ComponentTypeBase & ComponentNumberType) | (ComponentTypeBase & ComponentDatePickerType) | (ComponentTypeBase & ComponentCheckboxGroupType) | (ComponentTypeBase & ComponentCheckboxBooleanType) | (ComponentTypeBase & ComponentRadioType) | (ComponentTypeBase & ComponentFilterDescriptionType) | (ComponentTypeBase & ComponentDropdownType) | (ComponentTypeBase & ComponentPairWiseLinksType) | (ComponentTypeBase & ComponentRoundaboutType) | (ComponentTypeBase & ComponentSuggesterType) | (ComponentTypeBase & ComponentInputOrTextareaType) | (ComponentTypeBase & {
-    componentType: 'CheckboxOne';
-}) | (ComponentTypeBase & ComponentQuestionType);
+export type ComponentType = (ComponentTypeBase & ComponentSequenceType) | (ComponentTypeBase & ComponentSubSequenceType) | (ComponentTypeBase & ComponentRosterForLoopType) | (ComponentTypeBase & ComponentLoopType) | (ComponentTypeBase & ComponentTableType) | (ComponentTypeBase & ComponentNumberType) | (ComponentTypeBase & ComponentDatePickerType) | (ComponentTypeBase & ComponentCheckboxGroupType) | (ComponentTypeBase & ComponentCheckboxBooleanType) | (ComponentTypeBase & ComponentRadioType) | (ComponentTypeBase & ComponentFilterDescriptionType) | (ComponentTypeBase & ComponentDropdownType) | (Omit<ComponentTypeBase, 'label'> & ComponentPairWiseLinksType) | (ComponentTypeBase & ComponentRoundaboutType) | (ComponentTypeBase & ComponentSuggesterType) | (ComponentTypeBase & ComponentInputOrTextareaType) | (ComponentTypeBase & ComponentCheckboxOneType) | (ComponentTypeBase & ComponentQuestionType);
 export type ComponentTypeEnum = ComponentType['componentType'];
 export type ComponentInputOrTextareaType = {
     componentType: 'Input' | 'Textarea';
@@ -73,10 +72,10 @@ export type ComponentInputOrTextareaType = {
 };
 export type ComponentSequenceType = {
     componentType: 'Sequence';
+    gotoPage?: string;
 };
 export type ComponentSubSequenceType = {
     componentType: 'Subsequence';
-    gotoPage: string;
 };
 export type ComponentRoundaboutType = {
     componentType: 'Roundabout';
@@ -92,47 +91,48 @@ export type ComponentRosterForLoopType = {
         min: LabelType;
         max: LabelType;
     };
-    header: {
+    header?: {
         value: string;
         label: LabelType | string;
-        options: {
-            value: string;
-            label: LabelType;
-        }[];
+        options: Options;
         colspan?: number;
         rowspan?: number;
     }[];
-    body: ({
-        label: LabelType;
-        colspan?: number;
-        rowspan?: number;
-    } | (ComponentType & {
-        colspan?: number;
-        rowspan?: number;
-    }))[][];
     positioning: 'HORIZONTAL';
 };
-export type ComponentLoopType = {
-    componentType: 'Loop';
-    loopDependencies: string[];
+type PaginatedLoop = {
+    paginatedLoop: true;
+    maxPage: string;
+    iterations: LabelType;
+};
+type BlockLoop = {
+    paginatedLoop: false;
     lines: {
         min: LabelType;
         max: LabelType;
     };
+};
+export type ComponentLoopType = {
+    componentType: 'Loop';
+    loopDependencies: string[];
     components: ComponentType[];
-    iterations: LabelType;
-    maxPage: string;
     depth: number;
-    paginatedLoop: boolean;
-};
+} & (PaginatedLoop | BlockLoop);
 export type ComponentTableType = {
     componentType: 'Table';
     header: ComponentRosterForLoopType['header'];
-    body: ComponentRosterForLoopType['body'];
+    body: ({
+        label: LabelType;
+        colspan?: number;
+        rowspan?: number;
+    } | (ComponentType & {
+        colspan?: number;
+        rowspan?: number;
+    }))[][];
 };
 export type ComponentNumberType = {
     componentType: 'InputNumber';
-    unit: string;
+    unit?: string;
     response: ResponseType;
     min?: number;
     max?: number;
@@ -147,8 +147,10 @@ export type ComponentDatePickerType = {
 };
 export type ComponentCheckboxGroupType = {
     componentType: 'CheckboxGroup';
+    description?: LabelType;
     responses: Array<{
         label: LabelType;
+        description?: LabelType;
         response: ResponseType;
         id: string;
     }>;
@@ -158,21 +160,26 @@ export type ComponentCheckboxBooleanType = {
     response: ResponseType;
     missingResponse?: ResponseType;
 };
+type Options = {
+    value: string;
+    label: LabelType;
+    description?: LabelType;
+}[];
+export type ComponentCheckboxOneType = {
+    componentType: 'CheckboxOne';
+    response: ResponseType;
+    missingResponse?: ResponseType;
+    options: Options;
+};
 export type ComponentRadioType = {
     componentType: 'Radio';
-    options: {
-        value: string;
-        label: LabelType;
-    }[];
+    options: Options;
     response: ResponseType;
     missingResponse?: ResponseType;
 };
 export type ComponentDropdownType = {
     componentType: 'Dropdown';
-    options: {
-        value: string;
-        label: LabelType;
-    }[];
+    options: Options;
     response: ResponseType;
     missingResponse?: ResponseType;
 };
@@ -185,7 +192,7 @@ export type ComponentPairWiseLinksType = {
     xAxisIterations: LabelType;
     yAxisIterations: LabelType;
     symLinks: {
-        [variableName: string]: Record<string, string>;
+        [variableName: string]: Record<string, string | null>;
     };
     components: ComponentType[];
 };
@@ -197,21 +204,26 @@ export type ComponentQuestionType = {
 export type ComponentSuggesterType = {
     componentType: 'Suggester';
     storeName: string;
+    response: ResponseType;
+    optionResponses: {
+        name: string;
+        attribute: string;
+    };
 };
 export type SuggesterType = {
     name: string;
     fields: {
         name: string;
         min?: number;
-        rules?: string[];
+        rules?: 'soft' | string[];
         language?: 'French' | 'English';
         stemmer?: boolean;
-        synonyms: {
+        synonyms?: {
             source: string;
             target: string[];
         }[];
     }[];
-    max: number;
+    max?: number;
     stopWords?: string;
     order?: {
         field: string;
@@ -243,7 +255,7 @@ export type Variable = {
     variableType: 'CALCULATED';
     name: string;
     expression: LabelType;
-    bindingDependencies: string[];
+    bindingDependencies?: string[];
     inFilter: string;
     shapeFrom?: string;
 };
@@ -265,7 +277,7 @@ export type LunaticSource = {
             [variableName: string]: string;
         };
     };
-    missingBlock: {
+    missingBlock?: {
         [variableName: string]: string[];
     };
     resizing: {
@@ -289,3 +301,4 @@ export type LunaticSource = {
         };
     };
 };
+export {};

package/lib/src/use-lunatic/type.d.ts

@@ -9,9 +9,9 @@ export type LunaticControl = ControlType;
 export type VTLBindings = {
     [variableName: string]: unknown;
 };
-export type LunaticData = Record<Exclude<VariableType, 'COLLECTED'>, Record<string, unknown>> & {
+export type LunaticData = Partial<Record<Exclude<VariableType, 'COLLECTED'>, Record<string, unknown>> & {
     COLLECTED: Record<string, LunaticCollectedValue>;
-};
+}>;
 export type LunaticValues = {
     [variableName: string]: unknown;
 };
@@ -27,13 +27,13 @@ export type LunaticExpression = {
 };
 export type TODO = unknown;
 export type LunaticVariable = Variable;
-export type LunaticCollectedValue = {
+export type LunaticCollectedValue = Partial<{
     COLLECTED: unknown;
     EDITED: unknown;
     FORCED: unknown;
     INPUTED: unknown;
     PREVIOUS: unknown;
-};
+}>;
 export type LunaticOverviewItem = {
     id: string;
     page: string;

package/lib/src/use-lunatic/use-lunatic.d.ts

@@ -1,8 +1,16 @@
 /// <reference types="react" />
-import type { LunaticData, LunaticState } from './type';
+import type { LunaticState } from './type';
 import type { LunaticSource } from './type-source';
 import type { LunaticComponentType } from '../components/type';
-declare function useLunatic(source: LunaticSource, data: LunaticData | undefined, { features, preferences, savingType, onChange, management, shortcut, initialPage, lastReachedPage, autoSuggesterLoading, activeControls, getReferentiel, withOverview, missing, missingStrategy, missingShortcut, dontKnowButton, refusedButton, workersBasePath, trackChanges, }: {
+declare function useLunatic(source: LunaticSource, data: Partial<Record<"EXTERNAL" | "CALCULATED", Record<string, unknown>> & {
+    COLLECTED: Record<string, Partial<{
+        COLLECTED: unknown;
+        EDITED: unknown;
+        FORCED: unknown;
+        INPUTED: unknown;
+        PREVIOUS: unknown;
+    }>>;
+}> | undefined, { features, preferences, savingType, onChange, management, shortcut, initialPage, lastReachedPage, autoSuggesterLoading, activeControls, getReferentiel, withOverview, missing, missingStrategy, missingShortcut, dontKnowButton, refusedButton, workersBasePath, trackChanges, }: {
     features?: LunaticState['features'];
     preferences?: LunaticState['preferences'];
     savingType?: LunaticState['savingType'];
@@ -50,9 +58,9 @@ declare function useLunatic(source: LunaticSource, data: LunaticData | undefined
                     name: string;
                 };
             };
-            Sequence: Pick<import("../components/type").LunaticBaseProps<string>, "id" | "label" | "style" | "description" | "declarations">;
-            Subsequence: Pick<import("../components/type").LunaticBaseProps<string>, "id" | "label" | "declarations">;
-            Question: Pick<import("../components/type").LunaticBaseProps<unknown>, "id" | "label" | "description" | "declarations"> & {
+            Sequence: Pick<import("../components/type").LunaticBaseProps<string>, "label" | "description" | "declarations" | "id" | "style">;
+            Subsequence: Pick<import("../components/type").LunaticBaseProps<string>, "label" | "declarations" | "id">;
+            Question: Pick<import("../components/type").LunaticBaseProps<unknown>, "label" | "description" | "declarations" | "id"> & {
                 components: import("./commons/fill-components/fill-components").FilledLunaticComponentProps[];
             };
             RosterForLoop: import("../components/type").LunaticBaseProps<unknown> & {
@@ -193,7 +201,6 @@ declare function useLunatic(source: LunaticSource, data: LunaticData | undefined
                 response: {
                     name: string;
                 };
-                writable?: boolean | undefined;
             };
             Textarea: import("../components/type").LunaticBaseProps<string> & {
                 cols?: number | undefined;
@@ -204,7 +211,7 @@ declare function useLunatic(source: LunaticSource, data: LunaticData | undefined
                     name: string;
                 };
             };
-            FilterDescription: Pick<import("../components/type").LunaticBaseProps<string>, "id" | "label">;
+            FilterDescription: Pick<import("../components/type").LunaticBaseProps<string>, "label" | "id">;
             PairwiseLinks: Omit<import("../components/type").LunaticBaseProps<unknown>, "value"> & {
                 components: import("./type").LunaticComponentDefinition[];
                 features?: ["VTL"] | ["VTL", "MD"] | undefined;
@@ -241,6 +248,16 @@ declare function useLunatic(source: LunaticSource, data: LunaticData | undefined
                 response: {
                     name: string;
                 };
+                optionResponses?: {
+                    name: string;
+                    attribute: string;
+                }[] | undefined;
+                executeExpression: <T extends unknown = unknown>(expression: unknown, args?: {
+                    iteration?: number | number[] | undefined;
+                    bindingDependencies?: string[] | undefined;
+                    deps?: string[] | undefined;
+                } | undefined) => T;
+                iteration: number | undefined;
             };
             Summary: import("../components/type").LunaticBaseProps<string | null> & {
                 executeExpression: <T extends unknown = unknown>(expression: unknown, args?: {
@@ -283,9 +300,9 @@ declare function useLunatic(source: LunaticSource, data: LunaticData | undefined
                     name: string;
                 };
             };
-            Sequence: Pick<import("../components/type").LunaticBaseProps<string>, "id" | "label" | "style" | "description" | "declarations">;
-            Subsequence: Pick<import("../components/type").LunaticBaseProps<string>, "id" | "label" | "declarations">;
-            Question: Pick<import("../components/type").LunaticBaseProps<unknown>, "id" | "label" | "description" | "declarations"> & {
+            Sequence: Pick<import("../components/type").LunaticBaseProps<string>, "label" | "description" | "declarations" | "id" | "style">;
+            Subsequence: Pick<import("../components/type").LunaticBaseProps<string>, "label" | "declarations" | "id">;
+            Question: Pick<import("../components/type").LunaticBaseProps<unknown>, "label" | "description" | "declarations" | "id"> & {
                 components: import("./commons/fill-components/fill-components").FilledLunaticComponentProps[];
             };
             RosterForLoop: import("../components/type").LunaticBaseProps<unknown> & {
@@ -426,7 +443,6 @@ declare function useLunatic(source: LunaticSource, data: LunaticData | undefined
                 response: {
                     name: string;
                 };
-                writable?: boolean | undefined;
             };
             Textarea: import("../components/type").LunaticBaseProps<string> & {
                 cols?: number | undefined;
@@ -437,7 +453,7 @@ declare function useLunatic(source: LunaticSource, data: LunaticData | undefined
                     name: string;
                 };
             };
-            FilterDescription: Pick<import("../components/type").LunaticBaseProps<string>, "id" | "label">;
+            FilterDescription: Pick<import("../components/type").LunaticBaseProps<string>, "label" | "id">;
             PairwiseLinks: Omit<import("../components/type").LunaticBaseProps<unknown>, "value"> & {
                 components: import("./type").LunaticComponentDefinition[];
                 features?: ["VTL"] | ["VTL", "MD"] | undefined;
@@ -474,6 +490,16 @@ declare function useLunatic(source: LunaticSource, data: LunaticData | undefined
                 response: {
                     name: string;
                 };
+                optionResponses?: {
+                    name: string;
+                    attribute: string;
+                }[] | undefined;
+                executeExpression: <T extends unknown = unknown>(expression: unknown, args?: {
+                    iteration?: number | number[] | undefined;
+                    bindingDependencies?: string[] | undefined;
+                    deps?: string[] | undefined;
+                } | undefined) => T;
+                iteration: number | undefined;
             };
             Summary: import("../components/type").LunaticBaseProps<string | null> & {
                 executeExpression: <T extends unknown = unknown>(expression: unknown, args?: {
@@ -493,7 +519,7 @@ declare function useLunatic(source: LunaticSource, data: LunaticData | undefined
                 }[];
             };
         })[] | undefined;
-    }) => import("./commons/fill-components/fill-components").FilledLunaticComponentProps<"CheckboxOne" | "Sequence" | "Subsequence" | "RosterForLoop" | "Loop" | "Table" | "InputNumber" | "Datepicker" | "CheckboxGroup" | "CheckboxBoolean" | "Radio" | "FilterDescription" | "Dropdown" | "PairwiseLinks" | "Roundabout" | "Suggester" | "Input" | "Textarea" | "Question">[];
+    }) => import("./commons/fill-components/fill-components").FilledLunaticComponentProps<"Sequence" | "Subsequence" | "RosterForLoop" | "Loop" | "Table" | "InputNumber" | "Datepicker" | "CheckboxGroup" | "CheckboxBoolean" | "Radio" | "FilterDescription" | "Dropdown" | "PairwiseLinks" | "Roundabout" | "Suggester" | "Input" | "Textarea" | "CheckboxOne" | "Question">[];
     goPreviousPage: () => void;
     goNextPage: (payload?: {}) => void;
     goToPage: (page: {
@@ -521,7 +547,15 @@ declare function useLunatic(source: LunaticSource, data: LunaticData | undefined
         linksIterations?: number[] | undefined;
     };
     waiting: boolean;
-    getData: (withRefreshedCalculated: boolean, variableNames?: string[]) => LunaticData;
+    getData: (withRefreshedCalculated: boolean, variableNames?: string[]) => Partial<Record<"EXTERNAL" | "CALCULATED", Record<string, unknown>> & {
+        COLLECTED: Record<string, Partial<{
+            COLLECTED: unknown;
+            EDITED: unknown;
+            FORCED: unknown;
+            INPUTED: unknown;
+            PREVIOUS: unknown;
+        }>>;
+    }>;
     Provider: import("react").FunctionComponent<{
         children?: import("react").ReactNode;
     }>;
@@ -540,7 +574,15 @@ declare function useLunatic(source: LunaticSource, data: LunaticData | undefined
         children: import("./commons/getOverview").OverviewItem[];
     }[];
     loopVariables: string[];
-    getChangedData: (reset?: boolean) => LunaticData;
+    getChangedData: (reset?: boolean) => Partial<Record<"EXTERNAL" | "CALCULATED", Record<string, unknown>> & {
+        COLLECTED: Record<string, Partial<{
+            COLLECTED: unknown;
+            EDITED: unknown;
+            FORCED: unknown;
+            INPUTED: unknown;
+            PREVIOUS: unknown;
+        }>>;
+    }>;
     resetChangedData: () => void;
     hasPageResponse: () => boolean;
 };

package/lib/src/utils/variables.d.ts

@@ -1,5 +1,13 @@
-import type { LunaticData, LunaticVariable } from '../use-lunatic/type';
+import type { LunaticVariable } from '../use-lunatic/type';
 /**
  * Extract the initial value from the source.json and data.json
  */
-export declare function getInitialVariableValue(variable: LunaticVariable, data?: LunaticData): unknown;
+export declare function getInitialVariableValue(variable: LunaticVariable, data?: Partial<Record<"EXTERNAL" | "CALCULATED", Record<string, unknown>> & {
+    COLLECTED: Record<string, Partial<{
+        COLLECTED: unknown;
+        EDITED: unknown;
+        FORCED: unknown;
+        INPUTED: unknown;
+        PREVIOUS: unknown;
+    }>>;
+}>): unknown;

package/lib/stories/loop/source-roster.json

@@ -18,8 +18,8 @@
 			"conditionFilter": { "value": "true", "type": "VTL" },
 			"bindingDependencies": ["PRENOM"],
 			"lines": {
-				"min": { "value": 1, "type": "VTL" },
-				"max": { "value": 10, "type": "VTL" }
+				"min": { "value": "1", "type": "VTL" },
+				"max": { "value": "10", "type": "VTL" }
 			},
 			"page": "1",
 			"components": [

package/lib/stories/suggester/fakeReferentiel.json

@@ -0,0 +1,12 @@
+[
+	{
+		"id": "brosse",
+		"label": "Brosse à cheveux",
+		"price": 20
+	},
+	{
+		"id": "balle",
+		"label": "Balle rebondissante",
+		"price": 10
+	}
+]

package/lib/stories/suggester/source-option-responses.json

@@ -0,0 +1,145 @@
+{
+	"suggesters": [
+		{
+			"name": "products",
+			"fields": [
+				{
+					"name": "label",
+					"rules": ["[\\w]+"],
+					"language": "French",
+					"min": 3,
+					"stemmer": false
+				}
+			],
+			"queryParser": {
+				"type": "tokenized",
+				"params": {
+					"language": "French",
+					"pattern": "[\\w.]+",
+					"min": 3,
+					"stemmer": false
+				}
+			},
+			"version": "1"
+		}
+	],
+	"components": [
+		{
+			"componentType": "Suggester",
+			"response": {
+				"name": "PRODUCT"
+			},
+			"optionResponses": [
+				{
+					"name": "PRODUCT_NAME",
+					"attribute": "label"
+				},
+				{
+					"name": "PRODUCT_PRICE",
+					"attribute": "price"
+				}
+			],
+			"storeName": "products",
+			"conditionFilter": {
+				"type": "VTL",
+				"value": "true"
+			},
+			"id": "lt4ezymk",
+			"page": "1",
+			"label": {
+				"type": "VTL|MD",
+				"value": "\"➡ 1. \" || \"Quel est votre produit préféré ?\""
+			},
+			"mandatory": false,
+			"maxLength": 249
+		},
+		{
+			"componentType": "Input",
+			"response": {
+				"name": "NOM"
+			},
+			"conditionFilter": {
+				"type": "VTL",
+				"value": "true"
+			},
+			"id": "prenom",
+			"page": "2",
+			"label": {
+				"type": "VTL|MD",
+				"value": "\"➡ 2. Vous aimez \" || PRODUCT_NAME || \" à \" || cast(PRODUCT_PRICE, string) || \"€ mais quel est votre prénom ?\""
+			},
+			"mandatory": false,
+			"maxLength": 249
+		}
+	],
+	"pagination": "question",
+	"resizing": {},
+	"label": {
+		"type": "VTL|MD",
+		"value": "Suggester"
+	},
+	"lunaticModelVersion": "2.5.0",
+	"modele": "SUGGESTER",
+	"enoCoreVersion": "2.7.1",
+	"generatingDate": "27-02-2024 13:43:43",
+	"missing": false,
+	"id": "lt4f6mib",
+	"maxPage": "2",
+	"variables": [
+		{
+			"variableType": "COLLECTED",
+			"values": {
+				"COLLECTED": null,
+				"EDITED": null,
+				"INPUTED": null,
+				"FORCED": null,
+				"PREVIOUS": null
+			},
+			"name": "PRODUCT"
+		},
+		{
+			"variableType": "COLLECTED",
+			"values": {
+				"COLLECTED": null,
+				"EDITED": null,
+				"INPUTED": null,
+				"FORCED": null,
+				"PREVIOUS": null
+			},
+			"name": "PRODUCT_PRICE"
+		},
+		{
+			"variableType": "COLLECTED",
+			"values": {
+				"COLLECTED": null,
+				"EDITED": null,
+				"INPUTED": null,
+				"FORCED": null,
+				"PREVIOUS": null
+			},
+			"name": "PRODUCT_NAME"
+		},
+		{
+			"variableType": "COLLECTED",
+			"values": {
+				"COLLECTED": null,
+				"EDITED": null,
+				"INPUTED": null,
+				"FORCED": null,
+				"PREVIOUS": null
+			},
+			"name": "PRODUCT_PRICE"
+		},
+		{
+			"variableType": "COLLECTED",
+			"values": {
+				"COLLECTED": null,
+				"EDITED": null,
+				"INPUTED": null,
+				"FORCED": null,
+				"PREVIOUS": null
+			},
+			"name": "PRENOM"
+		}
+	]
+}