case-editor-tools 1.0.0-beta.9 → 1.0.2

package/surveys/survey-items.d.ts

@@ -1,36 +1,13 @@
-import { ItemGroupComponent, Expression, ComponentProperties, ItemComponent, SurveyItem, ExpressionArg, Validation } from "survey-engine/lib/data_types";
-import { Duration } from "../types/duration";
-import { OptionDef, StyledTextComponentProp } from "./types/item-properties";
-interface GenericQuestionProps {
-    parentKey: string;
-    itemKey: string;
-    version?: number;
-    questionText: Map<string, string> | Array<StyledTextComponentProp>;
-    questionSubText?: Map<string, string>;
-    titleClassName?: string;
-    helpGroupContent?: Array<{
-        content: Map<string, string>;
-        style?: Array<{
-            key: string;
-            value: string;
-        }>;
-    }>;
-    condition?: Expression;
-    topDisplayCompoments?: Array<ItemComponent>;
-    bottomDisplayCompoments?: Array<ItemComponent>;
-    isRequired?: boolean;
-    footnoteText?: Map<string, string>;
-    customValidations?: Array<Validation>;
-}
-interface NumericInputQuestionProps extends GenericQuestionProps {
-    content: Map<string, string>;
-    contentBehindInput?: boolean;
-    componentProperties?: ComponentProperties;
-    inputMaxWidth?: string;
-}
+import { ItemGroupComponent, Expression, ItemComponent, SurveyItem, ExpressionArg, ResponseComponent } from "survey-engine/data_types";
+import { ClozeQuestionProps, ConsentQuestionProps, DateInputQuestionProps, GenericQuestionProps, MultiLineTextInput, NumericInputQuestionProps, OptionDef, ResponsiveBipolarLikertArrayQuestionProps, ResponsiveSingleChoiceArrayQuestionProps, TextInputQuestionProps, TimeInputQuestionProps } from "./types/item-properties";
+import { LikertGroupRow } from "./responseTypeGenerators/likertGroupComponents";
 interface OptionQuestionProps extends GenericQuestionProps {
     responseOptions: Array<OptionDef>;
 }
+interface DropDownQuestionProps extends GenericQuestionProps {
+    responseOptions: Array<OptionDef>;
+    placeholder?: Map<string, string>;
+}
 interface LikertGroupQuestionProps extends GenericQuestionProps {
     rows: Array<LikertGroupRow>;
     scaleOptions: Array<{
@@ -40,98 +17,6 @@ interface LikertGroupQuestionProps extends GenericQuestionProps {
     }>;
     stackOnSmallScreen?: boolean;
 }
-declare type ResponsiveSingleChoiceArrayVariant = 'horizontal' | 'vertical' | 'table';
-declare type ResponsiveBipolarLikertArrayVariant = 'withLabelRow' | 'vertical' | 'table';
-interface ResponsiveSingleChoiceArrayProps {
-    scaleOptions: Array<{
-        key: string;
-        className?: string;
-        content: Map<string, string> | StyledTextComponentProp[];
-    }>;
-    rows: Array<{
-        key: string;
-        content: Map<string, string> | StyledTextComponentProp[];
-        horizontalModeProps?: {
-            labelPlacement?: 'none' | 'top' | 'bottom';
-            className?: string;
-        };
-        verticalModeProps?: {
-            className?: string;
-        };
-        tableModeProps?: {
-            className?: string;
-        };
-    }>;
-    defaultMode: ResponsiveSingleChoiceArrayVariant;
-    responsiveModes?: {
-        sm?: ResponsiveSingleChoiceArrayVariant;
-        md?: ResponsiveSingleChoiceArrayVariant;
-        lg?: ResponsiveSingleChoiceArrayVariant;
-        xl?: ResponsiveSingleChoiceArrayVariant;
-        xxl?: ResponsiveSingleChoiceArrayVariant;
-    };
-    rgClassName?: string;
-    tableModeProps?: {
-        className?: string;
-        layout?: "fixed";
-        firstColWidth?: string;
-        optionHeaderClassName?: string;
-        hideRowBorder?: boolean;
-    };
-    horizontalModeProps?: {
-        hideRowBorder?: boolean;
-    };
-    verticalModeProps?: {
-        hideRowBorder?: boolean;
-        useReverseOptionOrder?: boolean;
-    };
-}
-interface ResponsiveBipolarLikertArrayProps {
-    scaleOptions: Array<{
-        key: string;
-    }>;
-    rows: Array<{
-        key: string;
-        startLabel: Map<string, string> | StyledTextComponentProp[];
-        endLabel: Map<string, string> | StyledTextComponentProp[];
-        withLabelRowModeProps?: {
-            className?: string;
-        };
-        verticalModeProps?: {
-            className?: string;
-        };
-        tableModeProps?: {
-            className?: string;
-        };
-    }>;
-    defaultMode: ResponsiveBipolarLikertArrayVariant;
-    responsiveModes?: {
-        sm?: ResponsiveBipolarLikertArrayVariant;
-        md?: ResponsiveBipolarLikertArrayVariant;
-        lg?: ResponsiveBipolarLikertArrayVariant;
-        xl?: ResponsiveBipolarLikertArrayVariant;
-        xxl?: ResponsiveBipolarLikertArrayVariant;
-    };
-    rgClassName?: string;
-    tableModeProps?: {
-        className?: string;
-        layout?: "fixed";
-        labelColWidth?: string;
-        hideRowBorder?: boolean;
-    };
-    withLabelRowModeProps?: {
-        hideRowBorder?: boolean;
-        maxLabelWidth?: string;
-        useBottomLabel?: boolean;
-    };
-    verticalModeProps?: {
-        hideRowBorder?: boolean;
-    };
-}
-interface ResponsiveSingleChoiceArrayQuestionProps extends GenericQuestionProps, ResponsiveSingleChoiceArrayProps {
-}
-interface ResponsiveBipolarLikertArrayQuestionProps extends GenericQuestionProps, ResponsiveBipolarLikertArrayProps {
-}
 interface NumericSliderProps extends GenericQuestionProps {
     sliderLabel: Map<string, string>;
     noResponseLabel: Map<string, string>;
@@ -139,22 +24,12 @@ interface NumericSliderProps extends GenericQuestionProps {
     max?: number | ExpressionArg;
     stepSize?: number | ExpressionArg;
 }
-interface DatePickerInput extends GenericQuestionProps {
-    dateInputMode: 'YMD' | 'YM' | 'Y';
-    inputLabelText?: Map<string, string>;
-    placeholderText?: Map<string, string>;
-    minRelativeDate?: {
-        reference?: number | Expression;
-        delta: Duration;
-    };
-    maxRelativeDate?: {
-        reference?: number | Expression;
-        delta: Duration;
-    };
+interface CustomResponseItem extends ResponseComponent {
+    mapToRole?: 'singleChoiceGroup' | 'multipleChoiceGroup' | 'input';
+    items?: ItemComponent[];
 }
-interface MultiLineTextInput extends GenericQuestionProps {
-    inputLabelText?: Map<string, string>;
-    placeholderText?: Map<string, string>;
+interface CustomQuestionProps extends GenericQuestionProps {
+    responseItemDefs: CustomResponseItem[];
 }
 interface DisplayProps {
     parentKey: string;
@@ -162,71 +37,6 @@ interface DisplayProps {
     content: Array<ItemComponent>;
     condition?: Expression;
 }
-export declare const SurveyItems: {
-    singleChoice: (props: OptionQuestionProps) => SurveyItem;
-    responsiveSingleChoiceArray: (props: ResponsiveSingleChoiceArrayQuestionProps) => SurveyItem;
-    responsiveBipolarLikertArray: (props: ResponsiveBipolarLikertArrayQuestionProps) => SurveyItem;
-    multipleChoice: (props: OptionQuestionProps) => SurveyItem;
-    simpleLikertGroup: (props: LikertGroupQuestionProps) => SurveyItem;
-    dateInput: (props: DatePickerInput) => SurveyItem;
-    multilineTextInput: (props: MultiLineTextInput) => SurveyItem;
-    dropDown: (props: OptionQuestionProps) => SurveyItem;
-    numericSlider: (props: NumericSliderProps) => SurveyItem;
-    numericInput: (props: NumericInputQuestionProps) => SurveyItem;
-    display: (props: DisplayProps) => SurveyItem;
-    surveyEnd: (parentKey: string, content: Map<string, string>, condition?: Expression | undefined) => SurveyItem;
-};
-export declare const initSingleChoiceGroup: (key: string, optionItems: OptionDef[], order?: Expression | undefined) => ItemGroupComponent;
-export declare const initMultipleChoiceGroup: (key: string, optionItems: OptionDef[], order?: Expression | undefined) => ItemGroupComponent;
-export declare const initDropdownGroup: (key: string, optionItems: OptionDef[], order?: Expression | undefined, groupDisabled?: Expression | undefined, groupContent?: Map<string, string> | undefined, groupDescription?: Map<string, string> | undefined) => ItemGroupComponent;
-export declare const initSliderCategoricalGroup: (key: string, optionItems: OptionDef[], order?: Expression | undefined, groupDisabled?: Expression | undefined) => ItemGroupComponent;
-interface HeaderRow {
-    role: 'headerRow';
-    key: string;
-    displayCondition?: Expression;
-    disabled?: Expression;
-    cells: Array<{
-        role: 'text';
-        key: string;
-        content?: Map<string, string>;
-        description?: Map<string, string>;
-    }>;
-}
-interface RadioRow {
-    role: 'radioRow';
-    key: string;
-    displayCondition?: Expression;
-    disabled?: Expression;
-    cells: Array<{
-        role: 'label' | 'option';
-        key: string;
-        content?: Map<string, string>;
-        description?: Map<string, string>;
-    }>;
-}
-export interface ResponseRowCell {
-    role: 'label' | 'check' | 'input' | 'numberInput' | 'dropDownGroup';
-    key: string;
-    content?: Map<string, string>;
-    description?: Map<string, string>;
-    properties?: ComponentProperties;
-    items?: Array<{
-        role: 'option';
-        key: string;
-        content?: Map<string, string>;
-        disabled?: Expression;
-        displayCondition?: Expression;
-    }>;
-}
-interface ResponseRow {
-    role: 'responseRow';
-    key: string;
-    displayCondition?: Expression;
-    disabled?: Expression;
-    cells: Array<ResponseRowCell>;
-}
-declare type MatrixRow = HeaderRow | RadioRow | ResponseRow;
-export declare const initMatrixQuestion: (key: string, rows: Array<MatrixRow>, order?: Expression | undefined) => ItemGroupComponent;
 interface EQ5DHealthSliderProps {
     role: 'eq5d-health-indicator';
     key: string;
@@ -238,29 +48,25 @@ interface EQ5DHealthSliderProps {
     minHealthText: Map<string, string>;
 }
 export declare const initEQ5DHealthIndicatorQuestion: (props: EQ5DHealthSliderProps) => ItemGroupComponent;
-interface LikertGroupRow {
-    key: string;
-    content: Map<string, string>;
-    descriptions?: ItemComponent[];
-    hideTopBorder?: boolean;
-    hideLabels?: boolean;
-    optionDisabled?: Array<{
-        optionKey: string;
-        exp: Expression;
-    }>;
-    displayCondition?: Expression;
-}
-export declare const initLikertScaleGroup: (key: string, rows: Array<LikertGroupRow>, scaleOptions: {
-    key: string;
-    className?: string | undefined;
-    content: Map<string, string>;
-}[], stackOnSmallScreen?: boolean | undefined, displayCondition?: Expression | undefined) => ItemGroupComponent;
-export declare const initResponsiveSingleChoiceArray: (rgKey: string, props: ResponsiveSingleChoiceArrayProps, displayCondition?: Expression | undefined) => ItemGroupComponent;
-export declare const initResponsiveBipolarLikertArray: (rgKey: string, props: ResponsiveBipolarLikertArrayProps, displayCondition?: Expression | undefined) => ItemGroupComponent;
-export declare const initLikertScaleItem: (key: string, options: {
-    key: string;
-    className?: string | undefined;
-    content?: Map<string, string> | undefined;
-    disabled?: Expression | undefined;
-}[], stackOnSmallScreen?: boolean | undefined, displayCondition?: Expression | undefined) => ItemGroupComponent;
+export declare const SurveyItems: {
+    consent: (props: ConsentQuestionProps) => SurveyItem;
+    singleChoice: (props: OptionQuestionProps) => SurveyItem;
+    responsiveSingleChoiceArray: (props: ResponsiveSingleChoiceArrayQuestionProps) => SurveyItem;
+    responsiveBipolarLikertArray: (props: ResponsiveBipolarLikertArrayQuestionProps) => SurveyItem;
+    multipleChoice: (props: OptionQuestionProps) => SurveyItem;
+    dateInput: (props: DateInputQuestionProps) => SurveyItem;
+    timeInput: (props: TimeInputQuestionProps) => SurveyItem;
+    textInput: (props: TextInputQuestionProps) => SurveyItem;
+    clozeQuestion: (props: ClozeQuestionProps) => SurveyItem;
+    numericInput: (props: NumericInputQuestionProps) => SurveyItem;
+    multilineTextInput: (props: MultiLineTextInput) => SurveyItem;
+    dropDown: (props: DropDownQuestionProps) => SurveyItem;
+    numericSlider: (props: NumericSliderProps) => SurveyItem;
+    display: (props: DisplayProps) => SurveyItem;
+    surveyEnd: (parentKey: string, content: Map<string, string>, condition?: Expression | undefined) => SurveyItem;
+    customQuestion: (props: CustomQuestionProps) => SurveyItem;
+    old: {
+        simpleLikertGroup: (props: LikertGroupQuestionProps) => SurveyItem;
+    };
+};
 export {};