@inseefr/lunatic 3.0.0-rc.9 → 3.0.1-rc.0

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

@@ -1,304 +0,0 @@
-/**
- * Types used for source data (lunatic models and data.json)
- */
-export type LabelType = {
-    value: string;
-    type: 'VTL' | 'VTL|MD';
-};
-export type ValuesType<T = unknown> = {
-    PREVIOUS: T | null;
-    COLLECTED: T | null;
-    FORCED: T | null;
-    EDITED: T | null;
-    INPUTED: T | null;
-};
-export type ValuesTypeArray<T = unknown> = {
-    PREVIOUS: T[] | [null];
-    COLLECTED: T[] | [null];
-    FORCED: T[] | [null];
-    EDITED: T[] | [null];
-    INPUTED: T[] | [null];
-};
-export type DeclarationType = {
-    id: string;
-    declarationType: 'INSTRUCTION' | 'COMMENT' | 'HELP' | 'CODECARD' | 'WARNING' | 'STATEMENT';
-    position: 'AFTER_QUESTION_TEXT' | 'AFTER_RESPONSE' | 'BEFORE_QUESTION_TEXT' | 'DETACHABLE';
-    label: LabelType;
-};
-export type ConditionFilterType = LabelType & {
-    bindingDependencies?: string[];
-};
-export type ControlType = {
-    id: string;
-    criticality: 'INFO' | 'WARN' | 'ERROR';
-    typeOfControl: 'FORMAT' | 'CONSISTENCY';
-    control: LabelType;
-    errorMessage: LabelType;
-    bindingDependencies?: string[];
-    type?: 'roundabout' | 'ROW' | 'simple';
-    iterations?: number;
-};
-export type ResponseType = {
-    name: string;
-};
-export type SequenceDescription = {
-    label: LabelType;
-    id: string;
-    page: string;
-};
-export type Hierarchy = {
-    sequence: SequenceDescription;
-    subSequence?: SequenceDescription;
-};
-export type ComponentTypeBase = {
-    label: LabelType;
-    description?: LabelType;
-    declarations?: DeclarationType[];
-    conditionFilter?: ConditionFilterType;
-    controls?: ControlType[];
-    id: string;
-    bindingDependencies?: string[];
-    hierarchy?: Hierarchy;
-    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) | (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';
-    maxLength: number;
-    missingResponse?: ResponseType;
-    response: ResponseType;
-};
-export type ComponentSequenceType = {
-    componentType: 'Sequence';
-    gotoPage?: string;
-};
-export type ComponentSubSequenceType = {
-    componentType: 'Subsequence';
-};
-export type ComponentRoundaboutType = {
-    componentType: 'Roundabout';
-    components: ComponentType[];
-    iterations: LabelType;
-    locked: boolean;
-    expressions: Record<string, LabelType>;
-};
-export type ComponentRosterForLoopType = {
-    componentType: 'RosterForLoop';
-    components: ComponentType[];
-    lines: {
-        min: LabelType;
-        max: LabelType;
-    };
-    header?: {
-        value: string;
-        label: LabelType | string;
-        options: Options;
-        colspan?: number;
-        rowspan?: number;
-    }[];
-    positioning: 'HORIZONTAL';
-};
-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[];
-    depth: number;
-} & (PaginatedLoop | BlockLoop);
-export type ComponentTableType = {
-    componentType: 'Table';
-    header: ComponentRosterForLoopType['header'];
-    body: ({
-        label: LabelType;
-        colspan?: number;
-        rowspan?: number;
-    } | (ComponentType & {
-        colspan?: number;
-        rowspan?: number;
-    }))[][];
-};
-export type ComponentNumberType = {
-    componentType: 'InputNumber';
-    unit?: string;
-    response: ResponseType;
-    min?: number;
-    max?: number;
-    decimals?: number;
-};
-export type ComponentDatePickerType = {
-    componentType: 'Datepicker';
-    dateFormat: 'YYYY-MM-DD' | 'YYYY' | 'YYYY-MM';
-    response: ResponseType;
-    min?: string;
-    max?: string;
-};
-export type ComponentCheckboxGroupType = {
-    componentType: 'CheckboxGroup';
-    description?: LabelType;
-    responses: Array<{
-        label: LabelType;
-        description?: LabelType;
-        response: ResponseType;
-        id: string;
-    }>;
-};
-export type ComponentCheckboxBooleanType = {
-    componentType: 'CheckboxBoolean';
-    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: Options;
-    response: ResponseType;
-    missingResponse?: ResponseType;
-};
-export type ComponentDropdownType = {
-    componentType: 'Dropdown';
-    options: Options;
-    response: ResponseType;
-    missingResponse?: ResponseType;
-};
-export type ComponentFilterDescriptionType = {
-    componentType: 'FilterDescription';
-    filterDescription: boolean;
-};
-export type ComponentPairWiseLinksType = {
-    componentType: 'PairwiseLinks';
-    xAxisIterations: LabelType;
-    yAxisIterations: LabelType;
-    symLinks: {
-        [variableName: string]: Record<string, string | null>;
-    };
-    components: ComponentType[];
-};
-export type ComponentQuestionType = {
-    componentType: 'Question';
-    components: ComponentType[];
-    description: LabelType;
-};
-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?: 'soft' | string[];
-        language?: 'French' | 'English';
-        stemmer?: boolean;
-        synonyms?: {
-            source: string;
-            target: string[];
-        }[];
-    }[];
-    max?: number;
-    stopWords?: string;
-    order?: {
-        field: string;
-        type: string;
-    };
-    queryParser: {
-        type: 'tokenized';
-        params: {
-            language: 'French' | 'English';
-            pattern: string;
-            min?: number;
-        };
-    } | {
-        type: 'soft';
-    };
-    url?: string;
-    version: number;
-    meloto?: boolean;
-};
-export type Variable = {
-    variableType: 'EXTERNAL';
-    name: string;
-    value: unknown;
-} | {
-    variableType: 'COLLECTED';
-    name: string;
-    values: ValuesType | ValuesTypeArray;
-} | {
-    variableType: 'CALCULATED';
-    name: string;
-    expression: LabelType;
-    bindingDependencies?: string[];
-    inFilter: string;
-    shapeFrom?: string;
-};
-export type LunaticSource = {
-    id: string;
-    modele?: string;
-    enoCoreVersion?: string;
-    lunaticModelVersion?: string;
-    generatingDate?: string;
-    missing?: boolean;
-    pagination?: 'question' | 'sequence' | 'subsequence';
-    maxPage: string;
-    label: LabelType;
-    components: ComponentType[];
-    variables: Variable[];
-    suggesters?: SuggesterType[];
-    cleaning: {
-        [variableName: string]: {
-            [variableName: string]: string;
-        };
-    };
-    missingBlock?: {
-        [variableName: string]: string[];
-    };
-    resizing: {
-        [variableName: string]: {
-            size: string;
-            variables: string[];
-        } | {
-            sizeForLinksVariables: [string, string] | {
-                xAxisSize: string;
-                yAxisSize: string;
-            };
-            linksVariables: string[];
-        } | {
-            size: string;
-            variables: string[];
-            sizeForLinksVariables: [string, string] | {
-                xAxisSize: string;
-                yAxisSize: string;
-            };
-            linksVariables: string[];
-        };
-    };
-};
-export {};

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

@@ -1,148 +0,0 @@
-import type { ReactNode } from 'react';
-import type { ComponentType, ControlType, LunaticSource, Variable } from './type-source';
-import { SuggesterStatus } from './use-suggesters';
-import type { LunaticVariablesStore } from './commons/variables/lunatic-variables-store';
-export type LunaticComponentDefinition<T extends ComponentType['componentType'] = ComponentType['componentType']> = ComponentType & {
-    componentType: T;
-};
-export type LunaticControl = ControlType;
-export type VTLBindings = {
-    [variableName: string]: unknown;
-};
-export type LunaticData = Partial<Record<Exclude<VariableType, 'COLLECTED'>, Record<string, unknown>> & {
-    COLLECTED: Record<string, LunaticCollectedValue>;
-}>;
-export type LunaticValues = {
-    [variableName: string]: unknown;
-};
-export type LunaticError = Pick<ControlType, 'id' | 'criticality' | 'typeOfControl'> & {
-    errorMessage: ReactNode;
-};
-export type VariableType = 'COLLECTED' | 'EXTERNAL' | 'CALCULATED';
-export type ExpressionType = 'VTL' | 'VTL|MD';
-export type LunaticExpression = {
-    value: string;
-    type: ExpressionType;
-    bindingDependencies?: string[];
-};
-export type TODO = unknown;
-export type LunaticVariable = Variable;
-export type LunaticCollectedValue = Partial<{
-    COLLECTED: unknown;
-    EDITED: unknown;
-    FORCED: unknown;
-    INPUTED: unknown;
-    PREVIOUS: unknown;
-}>;
-export type LunaticOverviewItem = {
-    id: string;
-    page: string;
-    type: string;
-    evaluatedLabel: string;
-    visible: boolean;
-    reached: boolean;
-    parent?: unknown;
-    label: LunaticExpression;
-    conditionFilter?: {
-        bindingDependencies?: string[];
-    };
-    children: LunaticOverviewItem[];
-};
-export type LunaticStateVariable = {
-    [key in LunaticVariable['variableType']]: {
-        type: key;
-        value: unknown;
-        variable: LunaticVariable & {
-            variableType: key;
-        };
-        CalculatedLinked?: LunaticVariable[];
-    };
-}[LunaticVariable['variableType']];
-export type LunaticState = {
-    updatedAt: number;
-    variables: LunaticVariablesStore;
-    pages: {
-        [key: number | string]: {
-            components: ComponentType[];
-            isLoop: false;
-            iterations?: undefined;
-            loopDependencies?: undefined;
-            subPages?: undefined;
-        } | {
-            components: ComponentType[];
-            isLoop: true;
-            iterations: ExpressionType;
-            loopDependencies: string[];
-            subPages: string[];
-        };
-    };
-    isInLoop: boolean;
-    isFirstPage: boolean;
-    isLastPage: boolean;
-    features: ['VTL'] | ['VTL', 'MD'];
-    preferences: ['COLLECTED'];
-    savingType: 'COLLECTED';
-    cleaning: LunaticSource['cleaning'];
-    missingBlock: {
-        [variable: string]: string[];
-    };
-    resizing: {
-        [variable: string]: {
-            size: string;
-            variables: string[];
-            sizeForLinksVariables?: unknown;
-            linksVariables?: string[];
-        };
-    };
-    overview: LunaticOverviewItem[];
-    pager: {
-        lastReachedPage?: string;
-        maxPage: string;
-        nbSubPages?: number;
-        page: string;
-        subPage?: number;
-        iteration?: number;
-        nbIterations?: number;
-        shallowIteration?: number;
-        linksIterations?: number[];
-    };
-    waiting: boolean;
-    errors?: {
-        [page: string]: {
-            [id: string]: LunaticError[];
-        };
-    };
-    currentErrors?: {
-        [id: string]: LunaticError[];
-    };
-    modalErrors?: Record<string, LunaticError[]>;
-    handleChange: (response: {
-        name: string;
-    }, value: any, args?: {
-        iteration?: number[];
-    }) => void;
-    executeExpression: <T extends unknown = unknown>(expression: unknown, args?: {
-        iteration?: number | number[];
-        bindingDependencies?: string[];
-        deps?: string[];
-    }) => T;
-    updateBindings: (variableName: string, value: unknown, options: {
-        iteration?: number[];
-    }) => unknown;
-    activeControls: boolean;
-    shortcut?: boolean;
-    management?: boolean;
-    goToPage: (page: {
-        page: string;
-        iteration?: number;
-        nbIterations?: number;
-        subPage?: number;
-    }) => void;
-    goNextPage: () => void;
-    goPreviousPage: () => void;
-    getSuggesterStatus: (name: string) => {
-        status: SuggesterStatus;
-        timestamp: number;
-    };
-    workersBasePath?: string;
-};