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

package/expression-utils/studyEngineExpressions.d.ts

@@ -7,6 +7,8 @@ export declare const NativeStudyEngineExpressions: {
     responseHasOnlyKeysOtherThan: (itemKey: string, responseSlotKey: string, ...optionKeys: string[]) => Expression;
     getResponseValueAsNum: (itemKey: string, responseKey: string) => Expression;
     getResponseValueAsStr: (itemKey: string, responseKey: string) => Expression;
+    hasResponseKey: (itemKey: string, responseKey: string) => Expression;
+    hasResponseKeyWithValue: (itemKey: string, responseKey: string, value: string) => Expression;
     countResponseItems: (itemKey: string, responseKey: string) => Expression;
     checkConditionForOldResponses: (condition: Expression, checkType?: number | "all" | "any" | undefined, surveyKey?: string | undefined, querySince?: number | Expression | undefined, queryUntil?: number | Expression | undefined) => Expression;
     participantState: {
@@ -15,7 +17,8 @@ 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;
@@ -36,7 +39,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;
@@ -87,7 +90,7 @@ export declare const StudyEngine: {
     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;
@@ -113,6 +116,8 @@ export declare const StudyEngine: {
     responseHasOnlyKeysOtherThan: (itemKey: string, responseSlotKey: string, ...optionKeys: string[]) => Expression;
     getResponseValueAsNum: (itemKey: string, responseKey: string) => Expression;
     getResponseValueAsStr: (itemKey: string, responseKey: string) => Expression;
+    hasResponseKey: (itemKey: string, responseKey: string) => Expression;
+    hasResponseKeyWithValue: (itemKey: string, responseKey: string, value: string) => Expression;
     countResponseItems: (itemKey: string, responseKey: string) => Expression;
     checkConditionForOldResponses: (condition: Expression, checkType?: number | "all" | "any" | undefined, surveyKey?: string | undefined, querySince?: number | Expression | undefined, queryUntil?: number | Expression | undefined) => Expression;
     participantState: {
@@ -121,7 +126,8 @@ 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;

package/expression-utils/studyEngineExpressions.js

@@ -37,6 +37,25 @@ const responseHasKeysAny = (itemKey, responseSlotKey, ...optionKeys) => expressi
  * @returns true if a response key is present, but is not in the list defined by optionKeys. If item or the response group is not found, returns false.
  */
 const responseHasOnlyKeysOtherThan = (itemKey, responseSlotKey, ...optionKeys) => expressionUtils_expressionGen.generateExpression('responseHasOnlyKeysOtherThan', undefined, itemKey, responseSlotKey, ...optionKeys);
+/**
+ *
+ * @param itemKey full key to the survey item, in the form, e.g., <surveyKey>.<groupKey>.<itemKey>
+ * @param responseKey  full key to the response that should exists
+ * @returns if item contains responseKey return true
+ */
+const hasResponseKey = (itemKey, responseKey) => {
+    return expressionUtils_expressionGen.generateExpression('hasResponseKey', undefined, itemKey, responseKey);
+};
+/**
+ *
+ * @param itemKey full key to the survey item, in the form, e.g., <surveyKey>.<groupKey>.<itemKey>
+ * @param responseKey full key to the response that should exists
+ * @param value the response object with the above key should have this value
+ * @returns if the response object exists and has the value return true
+ */
+const hasResponseKeyWithValue = (itemKey, responseKey, value) => {
+    return expressionUtils_expressionGen.generateExpression('hasResponseKeyWithValue', undefined, itemKey, responseKey, value);
+};
 const getResponseValueAsNum = (itemKey, responseKey) => {
     return expressionUtils_expressionGen.generateExpression('getResponseValueAsNum', 'float', itemKey, responseKey);
 };
@@ -86,12 +105,18 @@ 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
@@ -153,7 +178,7 @@ 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);
@@ -262,6 +287,8 @@ const NativeStudyEngineExpressions = {
     responseHasOnlyKeysOtherThan,
     getResponseValueAsNum,
     getResponseValueAsStr,
+    hasResponseKey,
+    hasResponseKeyWithValue,
     countResponseItems,
     // Old responses
     checkConditionForOldResponses,
@@ -272,7 +299,8 @@ const NativeStudyEngineExpressions = {
         getSurveyKeyAssignedFrom,
         getSurveyKeyAssignedUntil,
         hasStudyStatus,
-        hasParticipantFlag,
+        hasParticipantFlagKeyAndValue,
+        hasParticipantFlagKey,
         lastSubmissionDateOlderThan,
         hasMessageTypeAssigned,
         getMessageNextTime,

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.25",
+  "version": "1.0.0-beta.29",
   "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) => 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) => {
+    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":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}