case-editor-tools 1.0.0-beta.21 → 1.0.0-beta.25

package/expression-utils/studyEngineExpressions.d.ts

@@ -17,6 +17,8 @@ export declare const NativeStudyEngineExpressions: {
         hasStudyStatus: (status: string) => Expression;
         hasParticipantFlag: (key: string, value: string) => Expression;
         lastSubmissionDateOlderThan: (reference: number | Expression, surveyKey?: string | undefined) => Expression;
+        hasMessageTypeAssigned: (messageType: string) => Expression;
+        getMessageNextTime: (messageType: string) => Expression;
     };
     eq: (val1: Expression | string | number, val2: Expression | string | number) => Expression;
     lt: (val1: Expression | string | number, val2: Expression | string | number) => Expression;
@@ -46,6 +48,11 @@ export declare const StudyEngineActions: {
             removeAll: () => Expression;
             remove: (surveyKey: string, selector: 'first' | 'last' | 'all') => Expression;
         };
+        messages: {
+            add: (messageType: string, scheduledFor: number | Expression) => Expression;
+            removeAll: () => Expression;
+            remove: (messageType: string) => Expression;
+        };
         stopParticipation: () => Expression;
         finishParticipation: () => Expression;
     };
@@ -65,6 +72,16 @@ export declare const StudyEngine: {
         validFromOlderThan: (surveyKey: string, delta: Duration, reference?: number | Expression | undefined) => Expression;
         validUntilSoonerThan: (surveyKey: string, delta: Duration, reference?: number | Expression | undefined) => Expression;
     };
+    prefillRules: {
+        GET_LAST_SURVEY_ITEM: (surveyKey: string, itemKey: string, submittedLaterThan?: Duration | undefined) => Expression;
+    };
+    contextRules: {
+        previousResponses: {
+            LAST_RESPONSES_BY_KEY: (surveyKey: string, limit: number) => Expression;
+            ALL_RESPONSES_SINCE: (sinceTimestamp: number) => Expression;
+            RESPONSES_SINCE_BY_KEY: (sinceTimestamp: number, surveyKey: string) => Expression;
+        };
+    };
     if: (condition: Expression, actionIfTrue: Expression, actionIfFalse?: Expression | undefined) => Expression;
     do: (...args: Expression[]) => Expression;
     ifThen: (condition: Expression, ...args: Expression[]) => Expression;
@@ -82,6 +99,11 @@ export declare const StudyEngine: {
             removeAll: () => Expression;
             remove: (surveyKey: string, selector: 'first' | 'last' | 'all') => Expression;
         };
+        messages: {
+            add: (messageType: string, scheduledFor: number | Expression) => Expression;
+            removeAll: () => Expression;
+            remove: (messageType: string) => Expression;
+        };
         stopParticipation: () => Expression;
         finishParticipation: () => Expression;
     };
@@ -101,6 +123,8 @@ export declare const StudyEngine: {
         hasStudyStatus: (status: string) => Expression;
         hasParticipantFlag: (key: string, value: string) => Expression;
         lastSubmissionDateOlderThan: (reference: number | Expression, surveyKey?: string | undefined) => Expression;
+        hasMessageTypeAssigned: (messageType: string) => Expression;
+        getMessageNextTime: (messageType: string) => Expression;
     };
     eq: (val1: Expression | string | number, val2: Expression | string | number) => Expression;
     lt: (val1: Expression | string | number, val2: Expression | string | number) => Expression;

package/expression-utils/studyEngineExpressions.js

@@ -92,6 +92,18 @@ const hasStudyStatus = (status) => expressionUtils_expressionGen.generateExpress
  * @returns return true if key - value pair (with case sensitive matching for both key and value) is present. If any of the two is different, or participant flags is empty, it returns false.
  */
 const hasParticipantFlag = (key, value) => expressionUtils_expressionGen.generateExpression('hasParticipantFlag', undefined, key, value);
+/**
+ * Checks if the participant has a message type assigned (at least one)
+ * @param messageType
+ * @returns return true if a message with the given message type is assigned
+ */
+const hasMessageTypeAssigned = (messageType) => expressionUtils_expressionGen.generateExpression('hasMessageTypeAssigned', undefined, messageType);
+/**
+ * Retrieve the timestamp (scheduledFor) for a particular message type. Return 0 if not assigned.
+ * @param messageType
+ * @returns timestamp value or zero
+ */
+const getMessageNextTime = (messageType) => expressionUtils_expressionGen.generateExpression('getMessageNextTime', undefined, messageType);
 /**
  * Check if the last submission is older than the reference timestamp
  * @param reference look up this flag
@@ -148,6 +160,24 @@ const UPDATE_FLAG = (key, newValue) => expressionUtils_expressionGen.generateExp
 const REMOVE_FLAG = (key) => expressionUtils_expressionGen.generateExpression('REMOVE_FLAG', undefined, key);
 const ADD_NEW_SURVEY = (surveyKey, category, activeFrom, activeUntil) => expressionUtils_expressionGen.generateExpression('ADD_NEW_SURVEY', undefined, surveyKey, activeFrom !== undefined ? activeFrom : 0, activeUntil !== undefined ? activeUntil : 0, category);
 const REMOVE_ALL_SURVEYS = () => expressionUtils_expressionGen.generateExpression('REMOVE_ALL_SURVEYS');
+/**
+ * Add participant message
+ * @param messageType message type
+ * @param scheduledFor timestamp or expression returning a timestamp
+ * @returns
+ */
+const ADD_MESSAGE = (messageType, scheduledFor) => expressionUtils_expressionGen.generateExpression('ADD_MESSAGE', undefined, messageType, scheduledFor);
+/**
+ * Remove all messages scheduled for the participant
+ * @returns
+ */
+const REMOVE_ALL_MESSAGES = () => expressionUtils_expressionGen.generateExpression('REMOVE_ALL_MESSAGES', undefined);
+/**
+ * Remove all messages with this message type
+ * @param messageType message type
+ * @returns
+ */
+const REMOVE_MESSAGES_BY_TYPE = (messageType) => expressionUtils_expressionGen.generateExpression('REMOVE_MESSAGES_BY_TYPE', undefined, messageType);
 /**
  * When submitting the response, item response with the given key would be added to the report array
  * @param itemKey find and add this item to the report array
@@ -172,6 +202,22 @@ const REMOVE_REPORT_BY_KEY = (surveyKey, selector) => {
     }
 };
 // ##################
+// Prefill rule methods:
+const GET_LAST_SURVEY_ITEM = (surveyKey, itemKey, submittedLaterThan) => {
+    return expressionUtils_expressionGen.generateExpression('GET_LAST_SURVEY_ITEM', undefined, surveyKey, itemKey, submittedLaterThan ? types_duration.durationObjectToSeconds(submittedLaterThan) : undefined);
+};
+// ##################
+// Context previous responses methods:
+const LAST_RESPONSES_BY_KEY = (surveyKey, limit) => {
+    return expressionUtils_expressionGen.generateExpression('LAST_RESPONSES_BY_KEY', undefined, surveyKey, limit);
+};
+const ALL_RESPONSES_SINCE = (sinceTimestamp) => {
+    return expressionUtils_expressionGen.generateExpression('ALL_RESPONSES_SINCE', undefined, sinceTimestamp);
+};
+const RESPONSES_SINCE_BY_KEY = (sinceTimestamp, surveyKey) => {
+    return expressionUtils_expressionGen.generateExpression('RESPONSES_SINCE_BY_KEY', undefined, sinceTimestamp, surveyKey);
+};
+// ##################
 // Extra methods:
 const singleChoiceOptionsSelected = (itemKey, ...optionKeys) => expressionUtils_expressionGen.generateExpression('responseHasKeysAny', undefined, itemKey, [constants_keyDefinitions.responseGroupKey, constants_keyDefinitions.singleChoiceKey].join('.'), ...optionKeys);
 const multipleChoiceOptionsSelected = (itemKey, ...optionKeys) => expressionUtils_expressionGen.generateExpression('responseHasKeysAny', undefined, itemKey, [constants_keyDefinitions.responseGroupKey, constants_keyDefinitions.multipleChoiceKey].join('.'), ...optionKeys);
@@ -228,6 +274,8 @@ const NativeStudyEngineExpressions = {
         hasStudyStatus,
         hasParticipantFlag,
         lastSubmissionDateOlderThan,
+        hasMessageTypeAssigned,
+        getMessageNextTime,
     },
     // logical and comparision
     eq,
@@ -259,6 +307,11 @@ const StudyEngineActions = {
             removeAll: REMOVE_ALL_REPORTS,
             remove: REMOVE_REPORT_BY_KEY,
         },
+        messages: {
+            add: ADD_MESSAGE,
+            removeAll: REMOVE_ALL_MESSAGES,
+            remove: REMOVE_MESSAGES_BY_TYPE,
+        },
         // Extra methods:
         stopParticipation,
         finishParticipation,
@@ -275,6 +328,14 @@ const StudyEngine = Object.assign(Object.assign(Object.assign({}, NativeStudyEng
         isActive: hasSurveyKeyActive,
         validFromOlderThan: hasSurveyKeyValidFromOlderThan,
         validUntilSoonerThan: hasSurveyKeyValidUntilSoonerThan,
+    }, prefillRules: {
+        GET_LAST_SURVEY_ITEM,
+    }, contextRules: {
+        previousResponses: {
+            LAST_RESPONSES_BY_KEY,
+            ALL_RESPONSES_SINCE,
+            RESPONSES_SINCE_BY_KEY,
+        }
     } });
 
 exports.NativeStudyEngineExpressions = NativeStudyEngineExpressions;

package/expression-utils/studyEngineExpressions.js.map

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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "case-editor-tools",
   "description": "Javascript tools to simplify survey and study coding for CASE.",
-  "version": "1.0.0-beta.21",
+  "version": "1.0.0-beta.25",
   "main": "index.js",
   "license": "Apache-2.0",
   "repository": "github:case-framework/case-editor-tools",

package/surveys/survey-items.d.ts

@@ -22,9 +22,10 @@ interface NumericSliderProps extends GenericQuestionProps {
 }
 interface CustomResponseItem extends ResponseComponent {
     mapToRole?: 'singleChoiceGroup' | 'multipleChoiceGroup' | 'input';
+    items?: ItemComponent[];
 }
 interface CustomQuestionProps extends GenericQuestionProps {
-    responseItemDef: CustomResponseItem;
+    responseItemDefs: CustomResponseItem[];
 }
 interface DisplayProps {
     parentKey: string;

package/surveys/survey-items.js

@@ -199,10 +199,44 @@ const generateClozeQuestion = (props) => {
     return commonQuestionGenerator(props, rg_inner);
 };
 const generateCustomQuestion = (props) => {
-    const rolePrefix = props.responseItemDef.mapToRole !== undefined ? `${props.responseItemDef.mapToRole}` : '';
-    const role = `${rolePrefix}:${props.responseItemDef.role}`;
-    const rg_inner = Object.assign(Object.assign({}, props.responseItemDef), { role: role });
-    return commonQuestionGenerator(props, rg_inner);
+    const items = [];
+    props.responseItemDefs.forEach(item => {
+        const rolePrefix = item.mapToRole !== undefined ? `${item.mapToRole}` : '';
+        const role = `${rolePrefix}:${item.role}`;
+        delete item['mapToRole'];
+        const rg_inner = Object.assign(Object.assign({}, item), { role: role });
+        items.push(rg_inner);
+    });
+    const simpleEditor = new surveys_utils_simpleQuestionEditor.SimpleQuestionEditor(props.parentKey, props.itemKey, props.version ? props.version : 1);
+    // QUESTION TEXT
+    simpleEditor.setTitle(props.questionText, props.questionSubText, props.titleClassName);
+    if (props.condition) {
+        simpleEditor.setCondition(props.condition);
+    }
+    if (props.helpGroupContent) {
+        simpleEditor.editor.setHelpGroupComponent(surveys_utils_simpleGenerators.generateHelpGroupComponent(props.helpGroupContent));
+    }
+    if (props.topDisplayCompoments) {
+        props.topDisplayCompoments.forEach(comp => simpleEditor.addDisplayComponent(comp));
+    }
+    simpleEditor.editor.addExistingResponseComponent({
+        key: constants_keyDefinitions.responseGroupKey,
+        role: 'responseGroup',
+        items,
+    });
+    if (props.bottomDisplayCompoments) {
+        props.bottomDisplayCompoments.forEach(comp => simpleEditor.addDisplayComponent(comp));
+    }
+    if (props.isRequired) {
+        simpleEditor.addHasResponseValidation();
+    }
+    if (props.customValidations) {
+        props.customValidations.forEach(v => simpleEditor.editor.addValidation(v));
+    }
+    if (props.footnoteText) {
+        simpleEditor.addDisplayComponent(surveys_utils_componentGenerators.ComponentGenerators.footnote({ content: props.footnoteText }));
+    }
+    return simpleEditor.getItem();
 };
 const generateDisplay = (props) => {
     const simpleEditor = new surveys_utils_simpleQuestionEditor.SimpleQuestionEditor(props.parentKey, props.itemKey, 1);

package/surveys/survey-items.js.map

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