case-editor-tools 1.0.0-beta.23 → 1.0.0-beta.27

package/expression-utils/studyEngineExpressions.d.ts

@@ -15,8 +15,11 @@ export declare const NativeStudyEngineExpressions: {
         getSurveyKeyAssignedFrom: (surveyKey: string) => Expression;
         getSurveyKeyAssignedUntil: (surveyKey: string) => Expression;
         hasStudyStatus: (status: string) => Expression;
-        hasParticipantFlag: (key: string, value: string) => Expression;
+        hasParticipantFlagKeyAndValue: (key: string, value: string) => Expression;
+        hasParticipantFlagKey: (key: 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;
@@ -34,7 +37,7 @@ export declare const StudyEngineActions: {
     ifThen: (condition: Expression, ...args: Expression[]) => Expression;
     participantActions: {
         updateStudyStatus: (status: string) => Expression;
-        updateFlag: (key: string, newValue: string) => Expression;
+        updateFlag: (key: string, newValue: string | number | Expression) => Expression;
         removeFlag: (key: string) => Expression;
         assignedSurveys: {
             add: (surveyKey: string, category: 'immediate' | 'prio' | 'normal' | 'optional', activeFrom?: number | Expression | undefined, activeUntil?: number | Expression | undefined) => Expression;
@@ -46,6 +49,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,12 +73,22 @@ 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;
     participantActions: {
         updateStudyStatus: (status: string) => Expression;
-        updateFlag: (key: string, newValue: string) => Expression;
+        updateFlag: (key: string, newValue: string | number | Expression) => Expression;
         removeFlag: (key: string) => Expression;
         assignedSurveys: {
             add: (surveyKey: string, category: 'immediate' | 'prio' | 'normal' | 'optional', activeFrom?: number | Expression | undefined, activeUntil?: number | Expression | undefined) => Expression;
@@ -82,6 +100,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;
     };
@@ -99,8 +122,11 @@ export declare const StudyEngine: {
         getSurveyKeyAssignedFrom: (surveyKey: string) => Expression;
         getSurveyKeyAssignedUntil: (surveyKey: string) => Expression;
         hasStudyStatus: (status: string) => Expression;
-        hasParticipantFlag: (key: string, value: string) => Expression;
+        hasParticipantFlagKeyAndValue: (key: string, value: string) => Expression;
+        hasParticipantFlagKey: (key: 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

@@ -86,12 +86,30 @@ const getSurveyKeyAssignedUntil = (surveyKey) => expressionUtils_expressionGen.g
  */
 const hasStudyStatus = (status) => expressionUtils_expressionGen.generateExpression('getSurveyKeyAssignedUntil', undefined, status);
 /**
- * Check if a participant flag is present
+ * Check if a participant flag with specific value is present
  * @param key look up this flag
  * @param value and for this value
  * @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);
+const hasParticipantFlagKeyAndValue = (key, value) => expressionUtils_expressionGen.generateExpression('hasParticipantFlag', undefined, key, value);
+/**
+ * Check if a participant flag is present
+ * @param key look up this flag
+ * @returns return true if key is present. If any of the two is different, or participant flags is empty, it returns false.
+ */
+const hasParticipantFlagKey = (key) => expressionUtils_expressionGen.generateExpression('hasParticipantFlagKey', undefined, key);
+/**
+ * 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
@@ -141,13 +159,31 @@ const UPDATE_STUDY_STATUS = (status) => expressionUtils_expressionGen.generateEx
 /**
  * Add or update a participant flag
  * @param key
- * @param newValue
+ * @param newValue: string, number or expression where result should be written in the flag's value
  * @returns
  */
 const UPDATE_FLAG = (key, newValue) => expressionUtils_expressionGen.generateExpression('UPDATE_FLAG', undefined, key, newValue);
 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 +208,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);
@@ -226,8 +278,11 @@ const NativeStudyEngineExpressions = {
         getSurveyKeyAssignedFrom,
         getSurveyKeyAssignedUntil,
         hasStudyStatus,
-        hasParticipantFlag,
+        hasParticipantFlagKeyAndValue,
+        hasParticipantFlagKey,
         lastSubmissionDateOlderThan,
+        hasMessageTypeAssigned,
+        getMessageNextTime,
     },
     // logical and comparision
     eq,
@@ -259,6 +314,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 +335,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,13 +1,13 @@
 {
   "name": "case-editor-tools",
   "description": "Javascript tools to simplify survey and study coding for CASE.",
-  "version": "1.0.0-beta.23",
+  "version": "1.0.0-beta.27",
   "main": "index.js",
   "license": "Apache-2.0",
   "repository": "github:case-framework/case-editor-tools",
   "devDependencies": {
     "@rollup/plugin-commonjs": "^21.0.1",
-    "@rollup/plugin-node-resolve": "^13.1.1",
+    "@rollup/plugin-node-resolve": "^13.1.3",
     "rollup": "^2.61.1",
     "rollup-plugin-copy": "^3.4.0",
     "rollup-plugin-delete": "^2.0.0",
@@ -20,6 +20,6 @@
     "build": "rollup -c"
   },
   "dependencies": {
-    "survey-engine": "^1.0.2"
+    "survey-engine": "^1.0.3"
   }
 }

package/surveys/survey-engine-expressions.d.ts

@@ -22,6 +22,7 @@ export declare const NativeSurveyEngineExpressions: {
     isDefined: (arg: Expression) => Expression;
     hasResponse: (itemKey: string, responseKey: string) => Expression;
     getResponseItem: (itemKey: string, responseKey: string) => Expression;
+    parseValueAsNum: (valueRef: Expression) => Expression;
     getResponseValueAsNum: (itemKey: string, responseKey: string) => Expression;
     getResponseValueAsStr: (itemKey: string, responseKey: string) => Expression;
     checkResponseValueWithRegex: (itemKey: string, responseKey: string, regexPattern: string) => Expression;
@@ -72,7 +73,11 @@ export declare const SurveyEngine: {
     datePicker: {
         get: (itemKey: string) => Expression;
     };
-    hasParticipantFlag: (key: string, value: string) => Expression;
+    participantFlags: {
+        hasKey: (key: string, value: string) => Expression;
+        hasKeyAndValue: (key: string, value: string) => Expression;
+        getAsNum: (key: string) => Expression;
+    };
     getters: {
         getContext: () => Expression;
         getResponses: () => Expression;
@@ -94,6 +99,7 @@ export declare const SurveyEngine: {
     isDefined: (arg: Expression) => Expression;
     hasResponse: (itemKey: string, responseKey: string) => Expression;
     getResponseItem: (itemKey: string, responseKey: string) => Expression;
+    parseValueAsNum: (valueRef: Expression) => Expression;
     getResponseValueAsNum: (itemKey: string, responseKey: string) => Expression;
     getResponseValueAsStr: (itemKey: string, responseKey: string) => Expression;
     checkResponseValueWithRegex: (itemKey: string, responseKey: string, regexPattern: string) => Expression;

package/surveys/survey-engine-expressions.js

@@ -61,6 +61,14 @@ const gte = (val1, val2) => expressionUtils_expressionGen.generateExpression('gt
  * @returns
  */
 const timestampWithOffset = (delta, reference) => expressionUtils_expressionGen.generateExpression('timestampWithOffset', undefined, types_duration.durationObjectToSeconds(delta), reference ? reference : undefined);
+/**
+ * Parse the result of an expression as a number
+ * @param valueRef expression that returns a string with the value that should be parsed
+ * @returns expression that returns the value or undefined
+ */
+const parseValueAsNum = (valueRef) => {
+    return expressionUtils_expressionGen.generateExpression('parseValueAsNum', 'float', valueRef);
+};
 /**
  * Extract value from a response if exits parsed as a number
  * @param itemKey full key of the survey item (e.g. SURVEY.GROUP.QUESTIONKEY)
@@ -286,13 +294,29 @@ const getSurveyItemValidation = (itemKey, validationKey) => {
 const dateResponseDiffFromNow = (itemKey, responseKey, unit, ignoreSign) => {
     return expressionUtils_expressionGen.generateExpression('dateResponseDiffFromNow', undefined, itemKey, responseKey, unit, ignoreSign ? 1 : undefined);
 };
+/**
+ * Check participant flags object if contains the specified key value pair
+ * @param key retrieve participant flag's value for this key
+ * @returns
+ */
+const parseParticipantFlagAsNum = (key) => {
+    return parseValueAsNum(getAttribute(getAttribute(getContext(), 'participantFlags'), key));
+};
+/**
+ * Check participant flags object if contains the specified key value pair
+ * @param key retrieve participant flag's value for this key
+ * @returns
+ */
+const hasParticipantFlagKey = (key, value) => {
+    return isDefined(getAttribute(getAttribute(getContext(), 'participantFlags'), key));
+};
 /**
  * Check participant flags object if contains the specified key value pair
  * @param key retrieve participant flag's value for this key
  * @param value string value to be checked for a match
  * @returns
  */
-const hasParticipantFlag = (key, value) => {
+const hasParticipantFlagKeyAndValue = (key, value) => {
     return eq(getAttribute(getAttribute(getContext(), 'participantFlags'), key), value);
 };
 /**
@@ -355,6 +379,7 @@ const NativeSurveyEngineExpressions = {
     isDefined,
     hasResponse,
     getResponseItem,
+    parseValueAsNum,
     getResponseValueAsNum,
     getResponseValueAsStr,
     checkResponseValueWithRegex,
@@ -400,7 +425,11 @@ const SurveyEngine = Object.assign(Object.assign({}, NativeSurveyEngineExpressio
         regexCheck: multilineTextInputRegexCheck,
     }, datePicker: {
         get: getDatePickerResponseValue,
-    }, hasParticipantFlag });
+    }, participantFlags: {
+        hasKey: hasParticipantFlagKey,
+        hasKeyAndValue: hasParticipantFlagKeyAndValue,
+        getAsNum: parseParticipantFlagAsNum,
+    } });
 
 exports.NativeSurveyEngineExpressions = NativeSurveyEngineExpressions;
 exports.SurveyEngine = SurveyEngine;

package/surveys/survey-engine-expressions.js.map

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

package/surveys/types/survey-definition.d.ts

@@ -16,7 +16,8 @@ export declare abstract class SurveyDefinition {
     abstract buildSurvey(): void;
     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/surveys/types/survey-definition.js

@@ -34,8 +34,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);

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

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