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

package/src/survey-editor/survey-editor.ts

@@ -1,260 +0,0 @@
-import { Survey, LocalizedString, SurveyItem, isSurveyGroupItem, SurveyGroupItem, SurveyContextDef, Expression } from "survey-engine/lib/data_types";
-import { NewItemProps } from "./data-types";
-import { ItemEditor } from "./item-editor";
-
-interface SurveyEditorInt {
-    setSurveyName: (name: Array<LocalizedString>) => void;
-    setSurveyDescription: (description: Array<LocalizedString>) => void;
-    setSurveyDuration: (duration: Array<LocalizedString>) => void;
-    setSurveyContextRules: (contextRules: SurveyContextDef) => void;
-    setPrefillRules: (rules: Expression[]) => void;
-
-
-    changeItemKey: (oldKey: string, newKey: string) => void;
-    addNewSurveyItem: (itemProps: NewItemProps, parentKey?: string, atPosition?: number) => SurveyItem | undefined;
-    updateSurveyItem: (item: SurveyItem) => void;
-    removeItem: (key: string) => void;
-    findSurveyItem: (itemKey: string) => SurveyItem | undefined;
-    moveSurveyItem: (item: SurveyItem, destination: string) => void;
-
-
-    getSurvey: () => Survey;
-    getSurveyJSON: (pretty?: boolean) => string;
-}
-
-export class SurveyEditor implements SurveyEditorInt {
-    private survey: Survey;
-    private surveyKey: string;
-
-    constructor(survey?: Survey) {
-        if (survey) {
-            this.survey = { ...survey };
-            this.surveyKey = this.survey.current.surveyDefinition.key;
-        } else {
-            this.surveyKey = 'survey';
-            this.survey = {
-                props: {},
-                current: {
-                    versionId: '',
-                    surveyDefinition: {
-                        key: this.surveyKey,
-                        version: 1,
-                        items: []
-                    }
-                }
-            }
-        }
-    }
-
-    setSurveyName(name: Array<LocalizedString>) {
-        if (!this.survey.props) {
-            this.survey.props = {};
-        }
-        this.survey.props.name = name;
-    };
-
-    setSurveyDescription(description: Array<LocalizedString>) {
-        if (!this.survey.props) {
-            this.survey.props = {};
-        }
-        this.survey.props.description = description;
-    };
-
-    setSurveyDuration(duration: Array<LocalizedString>) {
-        if (!this.survey.props) {
-            this.survey.props = {};
-        }
-        this.survey.props.typicalDuration = duration;
-    };
-
-    setMaxItemPerPage(itemLimits: { small: number; large: number }) {
-        this.survey.maxItemsPerPage = itemLimits;
-    }
-
-    setSurveyContextRules(contextRules: SurveyContextDef) {
-        this.survey.contextRules = { ...contextRules };
-    };
-
-    setPrefillRules(rules: Expression[]) {
-        this.survey.prefillRules = [...rules];
-    };
-
-    addNewSurveyItem(newItem: NewItemProps, parentKey?: string, atPosition?: number): SurveyItem | undefined {
-        if (!parentKey) {
-            newItem.itemKey = this.surveyKey + '.' + newItem.itemKey;
-
-            if (this.survey.current.surveyDefinition.items.find(it => newItem.itemKey === it.key)) {
-                console.error('item already exists with key: ', newItem.itemKey);
-                return undefined;
-            }
-            const item = (new ItemEditor(undefined, newItem)).getItem();
-
-            if (atPosition !== undefined) {
-                this.survey.current.surveyDefinition.items.splice(atPosition, 0, item);
-            } else {
-                this.survey.current.surveyDefinition.items.push(item);
-            }
-            return item;
-        }
-        const obj = this.findSurveyItem(parentKey);
-        if (!obj) {
-            console.warn('parent survey item cannot be found: ', parentKey);
-            return
-        }
-
-        newItem.itemKey = parentKey + '.' + newItem.itemKey;
-        if ((obj as SurveyGroupItem).items.find(it => newItem.itemKey === it.key)) {
-            console.error('item already exists with key: ', newItem.itemKey);
-            return undefined;
-        }
-        const item = (new ItemEditor(undefined, newItem)).getItem();
-        if (atPosition !== undefined) {
-            (obj as SurveyGroupItem).items.splice(atPosition, 0, item);
-        } else {
-            (obj as SurveyGroupItem).items.push(item);
-        }
-        return item;
-    }
-
-    addExistingSurveyItem(surveyItem: SurveyItem, parentKey: string, atPosition?: number): SurveyItem | undefined {
-        const parent = this.findSurveyItem(parentKey);
-        if (!parent) {
-            console.warn('parent survey item cannot be found: ', parentKey);
-            return
-        }
-        if ((parent as SurveyGroupItem).items.find(it => surveyItem.key === it.key)) {
-            console.error('item already exists with key: ', surveyItem.key);
-            return undefined;
-        }
-        if (atPosition !== undefined) {
-            (parent as SurveyGroupItem).items.splice(atPosition, 0, surveyItem);
-        } else {
-            (parent as SurveyGroupItem).items.push(surveyItem);
-        }
-        return surveyItem;
-    }
-
-    changeItemKey(oldKey: string, newKey: string, ignoreReferences?: boolean) {
-        if (oldKey === this.surveyKey) {
-            this.surveyKey = newKey;
-            this.survey.current.surveyDefinition = this.changeItemKeyForSubtree(this.survey.current.surveyDefinition, newKey) as SurveyGroupItem;
-            return;
-        }
-
-        let obj = this.findSurveyItem(oldKey);
-        if (!obj) {
-            console.warn('survey item cannot be found: ', oldKey);
-            return
-        }
-        obj = Object.assign(obj, this.changeItemKeyForSubtree(obj, newKey));
-
-        if (!ignoreReferences) {
-            // replace key in every expression of the survey
-            // replace key in every follows
-            console.warn('unimplemented UPDATING KEY REFERENCES');
-        }
-    };
-
-    updateSurveyItem(item: SurveyItem) {
-        if (item.key === this.surveyKey) {
-            this.survey.current.surveyDefinition = {
-                ...this.survey.current.surveyDefinition,
-                ...item
-            }
-            return;
-        }
-        const ids = item.key.split('.');
-        const parentIds = ids.slice(0, ids.length - 1);
-        const parentKey = parentIds.join('.');
-
-        const obj = this.findSurveyItem(parentKey);
-        if (!obj) {
-            console.warn('parent survey item cannot be found: ', parentKey);
-            return
-        }
-
-        const index = (obj as SurveyGroupItem).items.findIndex(it => it.key === item.key);
-        if (index < 0) {
-            console.warn('survey item cannot be found: ', item.key);
-            return;
-        }
-        (obj as SurveyGroupItem).items[index] = {
-            ...(obj as SurveyGroupItem).items[index],
-            ...item
-        };
-        return;
-    };
-
-    removeItem(key: string) {
-        // <- error if item is not found
-        console.warn('removeItem unimplemented');
-        return;
-    };
-
-    moveSurveyItem(item: SurveyItem, destination: string) {
-        console.warn('moveSurveyItem unimplemented');
-        // error if destination not exists
-        // change item key
-        // change key for all children recursivly
-    };
-
-    findSurveyItem(itemKey: string): SurveyItem | undefined {
-        const ids = itemKey.split('.');
-        const paths = this.getKeyListForPath(ids);
-
-        let obj: SurveyItem | undefined = undefined;
-        for (const currentKey of paths) {
-            if (!obj) {
-                obj = this.survey.current.surveyDefinition;
-                continue;
-            }
-            if (!isSurveyGroupItem(obj)) {
-                console.warn('survey item is not a group: ', obj.key);
-                return;
-            }
-            const index = obj.items.findIndex(it => it.key === currentKey);
-            if (index < 0) {
-                console.warn('survey item cannot be found: ', currentKey);
-                return;
-            }
-            obj = (obj.items[index] as SurveyGroupItem);
-        }
-        return obj;
-    };
-
-    getSurvey(): Survey {
-        return { ...this.survey };
-    };
-
-    getSurveyJSON(pretty?: boolean): string {
-        return JSON.stringify(this.survey, undefined, pretty ? '  ' : undefined);
-    };
-
-    // Private methods:
-    private getKeyListForPath(ids: string[]): string[] {
-        const paths: string[] = [];
-        let compID = '';
-        for (let i = 0; i < ids.length; i++) {
-            const id = ids[i];
-            if (compID.length < 1) {
-                compID = id;
-            } else {
-                compID += '.' + id;
-            }
-            paths.push(compID);
-        }
-        return paths;
-    }
-
-    private changeItemKeyForSubtree(currentItem: SurveyItem, newKey: string): SurveyItem {
-        currentItem = { ...currentItem };
-        if (isSurveyGroupItem(currentItem)) {
-            currentItem.items = currentItem.items.map(item => {
-                const newSubkey = newKey + '.' + item.key.slice(item.key.lastIndexOf('.') + 1);
-                return this.changeItemKeyForSubtree(item, newSubkey);
-            });
-        }
-        currentItem.key = newKey;
-        return currentItem;
-    }
-}

package/src/types/duration.ts

@@ -1,32 +0,0 @@
-export interface Duration {
-    years?: number;
-    months?: number;
-    days?: number;
-    hours?: number;
-    minutes?: number;
-    seconds?: number;
-};
-
-export const durationObjectToSeconds = (duration: Duration): number => {
-    let value = 0;
-
-    if (duration.years !== undefined) {
-        value += duration.years * 31536000;
-    }
-    if (duration.months !== undefined) {
-        value += duration.months * 2592000;
-    }
-    if (duration.days !== undefined) {
-        value += duration.days * 86400;
-    }
-    if (duration.hours !== undefined) {
-        value += duration.hours * 3600;
-    }
-    if (duration.minutes !== undefined) {
-        value += duration.minutes * 60;
-    }
-    if (duration.seconds !== undefined) {
-        value += duration.seconds;
-    }
-    return value;
-}

package/src/types/expression.ts

@@ -1,22 +0,0 @@
-import { Expression, ExpressionArg } from "survey-engine/lib/data_types";
-
-
-export const isExpression = (value: Expression | any): value is Expression => {
-    return typeof (value) === 'object' && (value as Expression).name !== undefined && (value as Expression).name.length > 0;
-}
-
-export type ExpressionArgDType = 'exp' | 'num' | 'str';
-
-
-export const expressionArgParser = (arg: ExpressionArg): any => {
-    switch (arg.dtype) {
-        case 'num':
-            return arg.num;
-        case 'str':
-            return arg.str;
-        case 'exp':
-            return arg.exp;
-        default:
-            return arg.str;
-    }
-}

package/src/types/group.ts

@@ -1,73 +0,0 @@
-import { Expression, SurveyGroupItem, SurveyItem } from "survey-engine/lib/data_types";
-import { Logger } from "../logger/logger";
-import { ItemEditor } from "../survey-editor/item-editor";
-import { generatePageBreak } from "../utils/simple-generators";
-
-export abstract class Group {
-    groupEditor: ItemEditor;
-    key: string;
-    private parentKey: string;
-
-    constructor(parentKey: string, groupKey: string, selectionMethod?: Expression) {
-        this.parentKey = parentKey;
-        this.key = [this.parentKey, groupKey].join('.');
-        this.groupEditor = new ItemEditor(undefined, {
-            itemKey: this.key,
-            isGroup: true
-        });
-        if (!selectionMethod) {
-            this.groupEditor.setSelectionMethod({ name: 'sequential' });
-        } else {
-            this.groupEditor.setSelectionMethod(selectionMethod);
-        }
-    }
-
-    abstract buildGroup(): void;
-
-    /**
-     * Check if this group is currently part of a path, by checking if the key attribute exists in the path of the group.
-     * @param partialKey Is this key segment included somewhere in the parent key of this item.
-     * @returns
-     */
-    isPartOf(partialKey: string): boolean {
-        return this.parentKey.includes(partialKey)
-    }
-
-    /**
-     * Use this method to retrieve the generated survey item
-     * @returns
-     */
-    get() {
-        this.buildGroup();
-        this.checkDuplicateChildKeys();
-        return this.groupEditor.getItem();
-    }
-
-    addPageBreak() {
-        this.groupEditor.addSurveyItem(generatePageBreak(this.key));
-    }
-
-    addItem(item: SurveyItem, pageBreakAfter?: boolean) {
-        this.groupEditor.addSurveyItem(item);
-        if (pageBreakAfter) {
-            this.addPageBreak();
-        }
-    }
-
-    private checkDuplicateChildKeys() {
-        const group = this.groupEditor.getItem() as SurveyGroupItem;
-        const keys = group.items.map(item => item.key);
-        const hasDuplicates = keys.some((key, index) => {
-            const isDuplicateKey = keys.indexOf(key) !== index;
-            if (isDuplicateKey) {
-                Logger.error('Duplicate key:');
-                Logger.criticalError(`${key} is used twice (at index ${keys.indexOf(key)} and at index ${index})`);
-            }
-            return isDuplicateKey;
-        });
-        if (hasDuplicates) {
-            Logger.error('\nSurvey contains duplicate keys.\nPlease check the lines above for more infos.\nProcess stopped prematurely.')
-            process.exit(1)
-        }
-    }
-}

package/src/types/item.ts

@@ -1,42 +0,0 @@
-import { Expression, SurveySingleItem } from "survey-engine/lib/data_types";
-
-
-export abstract class Item {
-    key: string;
-    item: SurveySingleItem;
-    protected itemKey: string;
-    protected parentKey: string;
-
-    protected condition?: Expression;
-    protected isRequired?: boolean;
-
-    constructor(parentKey: string, itemKey: string) {
-        this.parentKey = parentKey;
-        this.itemKey = itemKey;
-        this.key = [this.parentKey, itemKey].join('.');
-        this.item = {
-            version: 0,
-            key: "not defined"
-        }
-    }
-
-    abstract buildItem(): SurveySingleItem;
-
-    /**
-     * Check if this item is currently part of a path, by checking if the key attribute exists in the path of the group.
-     * @param partialKey Is this key segment included somewhere in the parent key of this item.
-     * @returns
-     */
-    isPartOf(partialKey: string): boolean {
-        return this.parentKey.includes(partialKey)
-    }
-
-    /**
-     * Use this method to retrieve the generated survey item
-     * @returns
-     */
-    get() {
-        this.item = this.buildItem();
-        return this.item;
-    }
-}

package/src/types/study.ts

@@ -1,17 +0,0 @@
-import { Expression } from "survey-engine/lib/data_types";
-import { StudyRules } from "./studyRules";
-import { SurveyDefinition } from "./surveyDefinition";
-
-export interface Study {
-    studyKey: string;
-    outputFolderName?: string;
-    surveys: SurveyDefinition[];
-
-    // normal study rules
-    studyRules?: StudyRules;
-
-    customStudyRules?: Array<{
-        name: string;
-        rules: Expression[];
-    }>;
-}

package/src/types/studyRules.ts

@@ -1,39 +0,0 @@
-import { Expression } from 'survey-engine/lib/data_types';
-import { StudyEngine } from '../expression-utils/studyEngineExpressions';
-
-
-export class StudyRules {
-    private enterRules?: Expression[];
-    private submitRules?: Expression[];
-    private timerRules?: Expression[];
-
-    constructor(
-        enterRules?: Expression[],
-        submitRules?: Expression[],
-        timerRules?: Expression[],
-    ) {
-        this.enterRules = enterRules;
-        this.submitRules = submitRules;
-        this.timerRules = timerRules;
-    }
-
-    get() {
-        const rules = [];
-        if (this.enterRules) {
-            rules.push(
-                StudyEngine.ifThen(StudyEngine.checkEventType('ENTER'), ...this.enterRules)
-            );
-        }
-        if (this.submitRules) {
-            rules.push(
-                StudyEngine.ifThen(StudyEngine.checkEventType('SUBMIT'), ...this.submitRules)
-            );
-        }
-        if (this.timerRules) {
-            rules.push(
-                StudyEngine.ifThen(StudyEngine.checkEventType('TIMER'), ...this.timerRules)
-            );
-        }
-        return rules;
-    }
-}

package/src/types/surveyDefinition.ts

@@ -1,83 +0,0 @@
-import { SurveyGroupItem, SurveyItem } from "survey-engine/lib/data_types";
-import { Logger } from "../logger/logger";
-import { ItemEditor } from "../survey-editor/item-editor";
-import { SurveyEditor } from "../survey-editor/survey-editor";
-import { generateLocStrings } from "../utils/simple-generators";
-
-export interface SurveyProps {
-    surveyKey: string;
-    name: Map<string, string>;
-    description: Map<string, string>;
-    durationText: Map<string, string>;
-    // max item per page
-    // set prefill rules
-    // set context rules
-}
-
-
-export abstract class SurveyDefinition {
-    key: string;
-    editor: SurveyEditor;
-
-    constructor(props: SurveyProps) {
-        this.editor = new SurveyEditor();
-        this.editor.changeItemKey('survey', props.surveyKey);
-        this.key = props.surveyKey;
-
-        // define name and description of the survey
-        this.editor.setSurveyName(generateLocStrings(
-            props.name
-        ));
-
-        this.editor.setSurveyDescription(generateLocStrings(
-            props.description
-        ));
-
-        this.editor.setSurveyDuration(generateLocStrings(
-            props.durationText
-        ));
-
-        const rootItemEditor = new ItemEditor(this.editor.findSurveyItem(props.surveyKey) as SurveyGroupItem);
-        rootItemEditor.setSelectionMethod({ name: 'sequential' });
-        this.editor.updateSurveyItem(rootItemEditor.getItem());
-    }
-
-    abstract buildSurvey(): void;
-
-    getSurvey() {
-        this.buildSurvey();
-        this.checkDuplicateChildKeys();
-        return this.editor.getSurvey();
-    }
-
-    getSurveyJSON(pretty?: boolean) {
-        this.buildSurvey();
-        this.checkDuplicateChildKeys();
-        return this.editor.getSurveyJSON(pretty);
-    }
-
-    addItem(item: SurveyItem) {
-        this.editor.addExistingSurveyItem(item, this.key);
-    }
-
-    addSurveyItemToPath(item: SurveyItem, parentKey: string) {
-        this.editor.addExistingSurveyItem(item, parentKey);
-    }
-
-    private checkDuplicateChildKeys() {
-        const group = this.editor.getSurvey().current.surveyDefinition;
-        const keys = group.items.map(item => item.key);
-        const hasDuplicates = keys.some((key, index) => {
-            const isDuplicateKey = keys.indexOf(key) !== index;
-            if (isDuplicateKey) {
-                Logger.error('Duplicate key:');
-                Logger.criticalError(`${key} is used twice (at index ${keys.indexOf(key)} and at index ${index})`);
-            }
-            return isDuplicateKey;
-        });
-        if (hasDuplicates) {
-            Logger.error('\nSurvey item contains duplicate keys.\nPlease check the lines above for more infos.\nProcess stopped prematurely.')
-            process.exit(1)
-        }
-    }
-}

package/src/utils/componentGenerators.ts

@@ -1,122 +0,0 @@
-import { Expression, ItemComponent } from "survey-engine/lib/data_types"
-import { OptionDef, StyledTextComponentProp } from "./question-type-generator"
-import { generateRandomKey } from "./randomKeyGenerator"
-import { generateLocStrings } from "./simple-generators"
-
-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;
-}
-
-const option = (props: OptionProps): OptionDef => {
-    const styles = [];
-    if (props.className !== undefined) {
-        styles.push({
-            key: 'className', value: props.className
-        })
-    }
-
-    return {
-        key: props.key,
-        role: 'option',
-        content: !Array.isArray(props.content) ? props.content : undefined,
-        items: Array.isArray(props.content) ? props.content : undefined,
-        displayCondition: props.displayCondition,
-        disabled: props.disabled,
-        style: styles,
-    }
-}
-
-const multipleChoiceOptionSubtitle = (props: OptionTextProps): OptionDef => {
-    const styles = [];
-    if (props.className !== undefined) {
-        styles.push({
-            key: 'className', value: props.className
-        })
-    }
-    return {
-        key: props.key,
-        role: 'text',
-        content: !Array.isArray(props.content) ? props.content : undefined,
-        displayCondition: props.displayCondition,
-        style: styles,
-    }
-}
-
-interface TextProps extends CommonProps {
-    content: Map<string, string>;
-    variant?: 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'p' | 'li';
-    className?: string;
-}
-
-const text = (props: TextProps): ItemComponent => {
-    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: generateRandomKey(3),
-        role: 'text',
-        style: styles.length > 0 ? styles : undefined,
-        content: generateLocStrings(props.content),
-        displayCondition: props.displayCondition,
-    }
-}
-
-interface MarkdownProps extends CommonProps {
-    content: Map<string, string>;
-    className?: string;
-}
-
-const markdown = (props: MarkdownProps): ItemComponent => {
-    const styles = [];
-    if (props.className !== undefined) {
-        styles.push({
-            key: 'className', value: props.className
-        })
-    }
-    return {
-        key: generateRandomKey(3),
-        role: 'markdown',
-        style: styles.length > 0 ? styles : undefined,
-        content: generateLocStrings(props.content),
-        displayCondition: props.displayCondition,
-    }
-}
-
-const footnote = (props: {
-    content: Map<string, string>;
-}): ItemComponent => {
-    return {
-        role: 'footnote', content: generateLocStrings(props.content), style: [
-            { key: 'className', value: 'fs-small fst-italic text-center' }
-        ]
-    }
-}
-
-export const ComponentGenerators = {
-    option,
-    multipleChoiceOptionSubtitle,
-    footnote,
-    text,
-    markdown,
-}