case-editor-tools 1.0.0-beta.4 → 1.0.0-beta.40

package/surveys/types/item-properties.d.ts

@@ -0,0 +1,223 @@
+import { ComponentProperties, ConfidentialMode, Expression, ItemComponent, Validation } from "survey-engine/data_types";
+import { Duration } from "../../types/duration";
+export interface StyledTextComponentProp {
+    content: Map<string, string>;
+    className?: string;
+}
+export interface DateDisplayComponentProp {
+    languageCodes: string[];
+    date: Expression;
+    dateFormat: string;
+    className?: string;
+}
+export declare const isDateDisplayComponentProp: (value: DateDisplayComponentProp | any) => value is DateDisplayComponentProp;
+export interface OptionDef {
+    key: string;
+    role: string;
+    content?: Map<string, string>;
+    items?: Array<StyledTextComponentProp> | Array<OptionDef>;
+    description?: Map<string, string>;
+    displayCondition?: Expression;
+    disabled?: Expression;
+    style?: Array<{
+        key: string;
+        value: string;
+    }>;
+    optionProps?: ComponentProperties;
+}
+export interface GenericQuestionProps {
+    parentKey: string;
+    itemKey: string;
+    version?: number;
+    questionText: Map<string, string> | Array<StyledTextComponentProp | DateDisplayComponentProp>;
+    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>;
+    confidentialMode?: ConfidentialMode;
+}
+/**
+ * Numeric Input
+ */
+export interface NumericInputProps {
+    inputLabel: Map<string, string>;
+    labelBehindInput?: boolean;
+    componentProperties?: ComponentProperties;
+    inputMaxWidth?: string;
+    disabled?: Expression;
+}
+export declare type NumericInputQuestionProps = GenericQuestionProps & NumericInputProps;
+/**
+ * Date Input
+ */
+export interface DateInputProps {
+    dateInputMode: 'YMD' | 'YM' | 'Y';
+    inputLabelText?: Map<string, string>;
+    placeholderText?: Map<string, string>;
+    minRelativeDate?: {
+        reference?: number | Expression;
+        delta: Duration;
+    };
+    maxRelativeDate?: {
+        reference?: number | Expression;
+        delta: Duration;
+    };
+}
+export declare type DateInputQuestionProps = DateInputProps & GenericQuestionProps;
+/**
+ * Time Input
+ */
+export interface TimeInputProps {
+    inputLabelText?: Map<string, string>;
+    labelBehindInput?: boolean;
+    defaultValue?: string;
+    minTime?: string;
+    maxTime?: string;
+    step?: number;
+}
+export declare type TimeInputQuestionProps = TimeInputProps & GenericQuestionProps;
+/**
+ * Text Input
+ */
+export interface TextInputProps {
+    placeholderText?: Map<string, string>;
+    inputLabel?: Map<string, string>;
+    inputMaxWidth?: string;
+    className?: string;
+    maxLength?: number;
+    disabled?: Expression;
+}
+export declare type TextInputQuestionProps = TextInputProps & GenericQuestionProps;
+export interface MultiLineTextInput extends GenericQuestionProps {
+    inputLabelText?: Map<string, string>;
+    placeholderText?: Map<string, string>;
+    maxLength?: number;
+}
+/**
+ * Cloze Question
+ */
+export interface ClozeProps {
+    items: Array<OptionDef>;
+}
+export declare type ClozeQuestionProps = ClozeProps & GenericQuestionProps;
+/**
+ * Consent Question
+ */
+export interface ConsentProps {
+    checkBoxLabel: Map<string, string> | Array<StyledTextComponentProp | DateDisplayComponentProp>;
+    dialogTitle: Map<string, string>;
+    dialogContent: Map<string, string>;
+    acceptBtn: Map<string, string>;
+    rejectBtn: Map<string, string>;
+    className?: string;
+}
+export declare type ConsentQuestionProps = ConsentProps & GenericQuestionProps;
+/**
+ * Response Single Choice Likert Array
+ */
+export declare type ResponsiveSingleChoiceArrayVariant = 'horizontal' | 'vertical' | 'table';
+export interface ResponsiveSingleChoiceArrayProps {
+    scaleOptions: Array<{
+        key: string;
+        className?: string;
+        content: Map<string, string> | StyledTextComponentProp[];
+    }>;
+    rows: Array<{
+        key: string;
+        displayCondition?: Expression;
+        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;
+    };
+}
+export declare type ResponsiveSingleChoiceArrayQuestionProps = GenericQuestionProps & ResponsiveSingleChoiceArrayProps;
+/**
+ * Response Bipolar Likert Array
+ */
+export declare type ResponsiveBipolarLikertArrayVariant = 'withLabelRow' | 'vertical' | 'table';
+export interface ResponsiveBipolarLikertArrayProps {
+    scaleOptions: Array<{
+        key: string;
+    }>;
+    rows: Array<{
+        key: string;
+        startLabel: Map<string, string> | StyledTextComponentProp[];
+        endLabel: Map<string, string> | StyledTextComponentProp[];
+        displayCondition?: Expression;
+        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;
+    };
+}
+export declare type ResponsiveBipolarLikertArrayQuestionProps = GenericQuestionProps & ResponsiveBipolarLikertArrayProps;

package/surveys/types/item-properties.js

@@ -0,0 +1,10 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const isDateDisplayComponentProp = (value) => {
+    return typeof (value) === 'object' && value.date !== undefined && value.dateFormat !== undefined && value.languageCodes !== undefined;
+};
+
+exports.isDateDisplayComponentProp = isDateDisplayComponentProp;
+//# sourceMappingURL=item-properties.js.map

package/surveys/types/item-properties.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"item-properties.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;"}

package/{build → surveys}/types/item.d.ts

@@ -1,4 +1,4 @@
-import { Expression, SurveySingleItem } from "survey-engine/lib/data_types";
+import { Expression, SurveySingleItem } from "survey-engine/data_types";
 export declare abstract class Item {
     key: string;
     item: SurveySingleItem;

package/{build/types/surveyDefinition.d.ts → surveys/types/survey-definition.d.ts}

@@ -1,19 +1,23 @@
-import { SurveyItem } from "survey-engine/lib/data_types";
+import { SurveyItem } from "survey-engine/data_types";
 import { SurveyEditor } from "../survey-editor/survey-editor";
+export declare type SurveyAvailableFor = 'public' | 'temporary_participants' | 'active_participants';
 export interface SurveyProps {
     surveyKey: string;
     name: Map<string, string>;
     description: Map<string, string>;
     durationText: Map<string, string>;
+    availableFor?: SurveyAvailableFor;
+    requireLoginBeforeSubmission?: boolean;
 }
 export declare abstract class SurveyDefinition {
     key: string;
     editor: SurveyEditor;
     constructor(props: SurveyProps);
     abstract buildSurvey(): void;
-    getSurvey(): import("survey-engine/lib/data_types").Survey;
+    getSurvey(): import("survey-engine/data_types").Survey;
     getSurveyJSON(pretty?: boolean): string;
-    addItem(item: SurveyItem): void;
+    addItem(item: SurveyItem, pageBreakAfter?: boolean): void;
+    addPageBreak(): void;
     addSurveyItemToPath(item: SurveyItem, parentKey: string): void;
     private checkDuplicateChildKeys;
 }

package/{build/types/surveyDefinition.js → surveys/types/survey-definition.js}

@@ -2,23 +2,26 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var logger_logger = require('../logger/logger.js');
-var surveyEditor_itemEditor = require('../item-editor-8fd24b61.js');
-var surveyEditor_surveyEditor = require('../survey-editor/survey-editor.js');
-var utils_simpleGenerators = require('../utils/simple-generators.js');
+var logger_logger = require('../../logger/logger.js');
+var surveys_surveyEditor_itemEditor = require('../../item-editor-59f51ecc.js');
+var surveys_surveyEditor_surveyEditor = require('../survey-editor/survey-editor.js');
+var surveys_utils_simpleGenerators = require('../utils/simple-generators.js');
 require('../survey-editor/component-editor.js');
 require('../utils/randomKeyGenerator.js');
+require('./item-properties.js');
 
 class SurveyDefinition {
     constructor(props) {
-        this.editor = new surveyEditor_surveyEditor.SurveyEditor();
+        this.editor = new surveys_surveyEditor_surveyEditor.SurveyEditor();
         this.editor.changeItemKey('survey', props.surveyKey);
         this.key = props.surveyKey;
         // define name and description of the survey
-        this.editor.setSurveyName(utils_simpleGenerators.generateLocStrings(props.name));
-        this.editor.setSurveyDescription(utils_simpleGenerators.generateLocStrings(props.description));
-        this.editor.setSurveyDuration(utils_simpleGenerators.generateLocStrings(props.durationText));
-        const rootItemEditor = new surveyEditor_itemEditor.ItemEditor(this.editor.findSurveyItem(props.surveyKey));
+        this.editor.setSurveyName(surveys_utils_simpleGenerators.generateLocStrings(props.name));
+        this.editor.setSurveyDescription(surveys_utils_simpleGenerators.generateLocStrings(props.description));
+        this.editor.setSurveyDuration(surveys_utils_simpleGenerators.generateLocStrings(props.durationText));
+        this.editor.setAvailableFor(props.availableFor);
+        this.editor.setRequireLoginBeforeSubmission(props.requireLoginBeforeSubmission);
+        const rootItemEditor = new surveys_surveyEditor_itemEditor.ItemEditor(this.editor.findSurveyItem(props.surveyKey));
         rootItemEditor.setSelectionMethod({ name: 'sequential' });
         this.editor.updateSurveyItem(rootItemEditor.getItem());
     }
@@ -32,8 +35,14 @@ class SurveyDefinition {
         this.checkDuplicateChildKeys();
         return this.editor.getSurveyJSON(pretty);
     }
-    addItem(item) {
+    addItem(item, pageBreakAfter) {
         this.editor.addExistingSurveyItem(item, this.key);
+        if (pageBreakAfter) {
+            this.addPageBreak();
+        }
+    }
+    addPageBreak() {
+        this.editor.addExistingSurveyItem(surveys_utils_simpleGenerators.generatePageBreak(this.key), this.key);
     }
     addSurveyItemToPath(item, parentKey) {
         this.editor.addExistingSurveyItem(item, parentKey);
@@ -57,4 +66,4 @@ class SurveyDefinition {
 }
 
 exports.SurveyDefinition = SurveyDefinition;
-//# sourceMappingURL=surveyDefinition.js.map
+//# sourceMappingURL=survey-definition.js.map

package/surveys/types/survey-definition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"survey-definition.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/{build → surveys}/utils/componentGenerators.d.ts

@@ -1,19 +1,10 @@
-import { Expression, ItemComponent } from "survey-engine/lib/data_types";
-import { OptionDef, StyledTextComponentProp } from "./question-type-generator";
+import { Expression, ItemComponent } from "survey-engine/data_types";
+import { StyledTextComponentProp } from "../types/item-properties";
 interface CommonProps {
     key?: string;
     content?: Map<string, string> | StyledTextComponentProp[];
     displayCondition?: Expression;
 }
-interface OptionProps extends CommonProps {
-    key: string;
-    disabled?: Expression;
-    className?: string;
-}
-interface OptionTextProps extends CommonProps {
-    key: string;
-    className?: string;
-}
 interface TextProps extends CommonProps {
     content: Map<string, string>;
     variant?: 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'p' | 'li';
@@ -24,8 +15,6 @@ interface MarkdownProps extends CommonProps {
     className?: string;
 }
 export declare const ComponentGenerators: {
-    option: (props: OptionProps) => OptionDef;
-    multipleChoiceOptionSubtitle: (props: OptionTextProps) => OptionDef;
     footnote: (props: {
         content: Map<string, string>;
     }) => ItemComponent;

package/surveys/utils/componentGenerators.js

@@ -0,0 +1,59 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var surveys_utils_randomKeyGenerator = require('./randomKeyGenerator.js');
+var surveys_utils_simpleGenerators = require('./simple-generators.js');
+require('../survey-editor/component-editor.js');
+require('../types/item-properties.js');
+
+const text = (props) => {
+    const styles = [];
+    if (props.className !== undefined) {
+        styles.push({
+            key: 'className', value: props.className
+        });
+    }
+    if (props.variant !== undefined) {
+        styles.push({
+            key: 'variant', value: props.variant
+        });
+    }
+    return {
+        key: surveys_utils_randomKeyGenerator.generateRandomKey(3),
+        role: 'text',
+        style: styles.length > 0 ? styles : undefined,
+        content: surveys_utils_simpleGenerators.generateLocStrings(props.content),
+        displayCondition: props.displayCondition,
+    };
+};
+const markdown = (props) => {
+    const styles = [];
+    if (props.className !== undefined) {
+        styles.push({
+            key: 'className', value: props.className
+        });
+    }
+    return {
+        key: surveys_utils_randomKeyGenerator.generateRandomKey(3),
+        role: 'markdown',
+        style: styles.length > 0 ? styles : undefined,
+        content: surveys_utils_simpleGenerators.generateLocStrings(props.content),
+        displayCondition: props.displayCondition,
+    };
+};
+const footnote = (props) => {
+    return {
+        role: 'footnote', content: surveys_utils_simpleGenerators.generateLocStrings(props.content), style: [
+            { key: 'className', value: 'fs-small fst-italic text-center' }
+        ]
+    };
+};
+const ComponentGenerators = {
+    footnote,
+    text,
+    markdown,
+};
+
+exports.ComponentGenerators = ComponentGenerators;
+//# sourceMappingURL=componentGenerators.js.map

package/{build → surveys}/utils/componentGenerators.js.map

@@ -1 +1 @@
-{"version":3,"file":"componentGenerators.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"componentGenerators.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/surveys/utils/optionDefGenerators.d.ts

@@ -0,0 +1,83 @@
+import { Expression } from "survey-engine/data_types";
+import { ClozeProps, DateInputProps, NumericInputProps, OptionDef, StyledTextComponentProp, TextInputProps, TimeInputProps } from "../types/item-properties";
+interface CommonProps {
+    key?: string;
+    content?: Map<string, string> | StyledTextComponentProp[];
+    displayCondition?: Expression;
+}
+interface OptionProps {
+    disabled?: Expression;
+    className?: string;
+    displayCondition?: Expression;
+}
+interface OptionTextProps extends CommonProps {
+    className?: string;
+}
+export declare const SingleChoiceOptionTypes: {
+    option: (key: string, content: Map<string, string> | StyledTextComponentProp[], extraProps?: OptionProps | undefined) => OptionDef;
+    textInput: (props: TextInputProps & {
+        key: string;
+        displayCondition?: Expression;
+    }) => OptionDef;
+    timeInput: (props: TimeInputProps & {
+        key: string;
+        displayCondition?: Expression;
+    }) => OptionDef;
+    numberInput: (props: NumericInputProps & {
+        key: string;
+        displayCondition?: Expression;
+    }) => OptionDef;
+    cloze: (props: ClozeProps & {
+        key: string;
+        displayCondition?: Expression;
+        className?: string;
+    }) => OptionDef;
+};
+export declare const MultipleChoiceOptionTypes: {
+    option: (key: string, content: Map<string, string> | StyledTextComponentProp[], extraProps?: OptionProps | undefined) => OptionDef;
+    subtitle: (props: OptionTextProps) => OptionDef;
+    textInput: (props: TextInputProps & {
+        key: string;
+        displayCondition?: Expression;
+    }) => OptionDef;
+    timeInput: (props: TimeInputProps & {
+        key: string;
+        displayCondition?: Expression;
+    }) => OptionDef;
+    numberInput: (props: NumericInputProps & {
+        key: string;
+        displayCondition?: Expression;
+    }) => OptionDef;
+    cloze: (props: ClozeProps & {
+        key: string;
+        displayCondition?: Expression;
+        className?: string;
+    }) => OptionDef;
+};
+export declare const ClozeItemTypes: {
+    text: (props: OptionTextProps) => OptionDef;
+    markdown: (props: OptionTextProps) => OptionDef;
+    textInput: (props: TextInputProps & {
+        key: string;
+        displayCondition?: Expression;
+    }) => OptionDef;
+    dateInput: (props: DateInputProps & {
+        key: string;
+        displayCondition?: Expression;
+    }) => OptionDef;
+    timeInput: (props: TimeInputProps & {
+        key: string;
+        displayCondition?: Expression;
+    }) => OptionDef;
+    clozeLineBreak: () => OptionDef;
+    numberInput: (props: NumericInputProps & {
+        key: string;
+        displayCondition?: Expression;
+    }) => OptionDef;
+    dropDown: (props: {
+        key: string;
+        displayCondition?: Expression;
+        options: Array<OptionDef>;
+    }) => OptionDef;
+};
+export {};