case-editor-tools 1.0.0-beta.31 → 1.0.0-beta.32

package/expression-utils/studyEngineExpressions.d.ts

@@ -1,7 +1,7 @@
 import { Expression } from "survey-engine/data_types";
 import { Duration } from "../types/duration";
 export declare const NativeStudyEngineExpressions: {
-    checkEventType: (equalsType: 'ENTER' | 'SUBMIT' | 'TIMER') => Expression;
+    checkEventType: (equalsType: 'ENTER' | 'SUBMIT' | 'TIMER' | 'MERGE') => Expression;
     checkSurveyResponseKey: (surveyKey: string) => Expression;
     responseHasKeysAny: (itemKey: string, responseSlotKey: string, ...optionKeys: string[]) => Expression;
     responseHasOnlyKeysOtherThan: (itemKey: string, responseSlotKey: string, ...optionKeys: string[]) => Expression;
@@ -22,6 +22,18 @@ export declare const NativeStudyEngineExpressions: {
         lastSubmissionDateOlderThan: (reference: number | Expression, surveyKey?: string | undefined) => Expression;
         hasMessageTypeAssigned: (messageType: string) => Expression;
         getMessageNextTime: (messageType: string) => Expression;
+        incomingParticipantState: {
+            getStudyEntryTime: () => Expression;
+            hasSurveyKeyAssigned: (surveyKey: string) => Expression;
+            getSurveyKeyAssignedFrom: (surveyKey: string) => Expression;
+            getSurveyKeyAssignedUntil: (surveyKey: string) => Expression;
+            hasStudyStatus: (status: 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;
@@ -47,9 +59,13 @@ export declare const StudyEngineActions: {
             remove: (surveyKey: string, selector: 'first' | 'last' | 'all') => Expression;
         };
         reports: {
-            add: (itemKey: string) => Expression;
-            removeAll: () => Expression;
-            remove: (surveyKey: string, selector: 'first' | 'last' | 'all') => Expression;
+            init: (reportKey: string) => Expression;
+            cancel: (reportKey: string) => Expression;
+            updateData: (reportKey: string, attributeKey: string, value: number | string | Expression, dtype?: "string" | "date" | "float" | "int" | "rawMessage" | undefined) => Expression;
+            removeData: (reportKey: string, attributeKey: string) => Expression;
+            setReportIcon: (reportKey: string, icon: string) => Expression;
+            setReportMessage: (reportKey: string, content: string, asTranslationKey?: boolean | undefined) => Expression;
+            setReportSummary: (reportKey: string, content: string, asTranslationKey?: boolean | undefined) => Expression;
         };
         messages: {
             add: (messageType: string, scheduledFor: number | Expression) => Expression;
@@ -98,9 +114,13 @@ export declare const StudyEngine: {
             remove: (surveyKey: string, selector: 'first' | 'last' | 'all') => Expression;
         };
         reports: {
-            add: (itemKey: string) => Expression;
-            removeAll: () => Expression;
-            remove: (surveyKey: string, selector: 'first' | 'last' | 'all') => Expression;
+            init: (reportKey: string) => Expression;
+            cancel: (reportKey: string) => Expression;
+            updateData: (reportKey: string, attributeKey: string, value: number | string | Expression, dtype?: "string" | "date" | "float" | "int" | "rawMessage" | undefined) => Expression;
+            removeData: (reportKey: string, attributeKey: string) => Expression;
+            setReportIcon: (reportKey: string, icon: string) => Expression;
+            setReportMessage: (reportKey: string, content: string, asTranslationKey?: boolean | undefined) => Expression;
+            setReportSummary: (reportKey: string, content: string, asTranslationKey?: boolean | undefined) => Expression;
         };
         messages: {
             add: (messageType: string, scheduledFor: number | Expression) => Expression;
@@ -110,7 +130,7 @@ export declare const StudyEngine: {
         stopParticipation: () => Expression;
         finishParticipation: () => Expression;
     };
-    checkEventType: (equalsType: 'ENTER' | 'SUBMIT' | 'TIMER') => Expression;
+    checkEventType: (equalsType: 'ENTER' | 'SUBMIT' | 'TIMER' | 'MERGE') => Expression;
     checkSurveyResponseKey: (surveyKey: string) => Expression;
     responseHasKeysAny: (itemKey: string, responseSlotKey: string, ...optionKeys: string[]) => Expression;
     responseHasOnlyKeysOtherThan: (itemKey: string, responseSlotKey: string, ...optionKeys: string[]) => Expression;
@@ -131,6 +151,18 @@ export declare const StudyEngine: {
         lastSubmissionDateOlderThan: (reference: number | Expression, surveyKey?: string | undefined) => Expression;
         hasMessageTypeAssigned: (messageType: string) => Expression;
         getMessageNextTime: (messageType: string) => Expression;
+        incomingParticipantState: {
+            getStudyEntryTime: () => Expression;
+            hasSurveyKeyAssigned: (surveyKey: string) => Expression;
+            getSurveyKeyAssignedFrom: (surveyKey: string) => Expression;
+            getSurveyKeyAssignedUntil: (surveyKey: string) => Expression;
+            hasStudyStatus: (status: 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

@@ -11,7 +11,7 @@ const and = (...args) => expressionUtils_expressionGen.generateExpression('and',
 const not = (arg) => expressionUtils_expressionGen.generateExpression('not', undefined, arg);
 /**
  * Check if the current event has the given type
- * @param equalsType string with the possible values: 'ENTER', 'SUBMIT', 'TIMER
+ * @param equalsType string with the possible values: 'ENTER', 'SUBMIT', 'TIMER', 'MERGE'
  * @returns if event type matches the argument, return true otherwise false
  */
 const checkEventType = (equalsType) => expressionUtils_expressionGen.generateExpression('checkEventType', undefined, equalsType);
@@ -80,30 +80,35 @@ const checkConditionForOldResponses = (condition, checkType, surveyKey, querySin
  * @returns timestamp
  */
 const getStudyEntryTime = () => expressionUtils_expressionGen.generateExpression('getStudyEntryTime');
+const getStudyEntryTimeForIncoming = () => expressionUtils_expressionGen.generateExpression('incomingState:getStudyEntryTime');
 /**
  * Determines if a specific survey key is currently assigned to the participant.
  * @param surveyKey - string - key of the survey to check for.
  * @returns true if the participant has a survey with this surveyKey assigned, otherwise false.
  */
 const hasSurveyKeyAssigned = (surveyKey) => expressionUtils_expressionGen.generateExpression('hasSurveyKeyAssigned', undefined, surveyKey);
+const hasSurveyKeyAssignedForIncoming = (surveyKey) => expressionUtils_expressionGen.generateExpression('incomingState:hasSurveyKeyAssigned', undefined, surveyKey);
 /**
  * Method to access the timestamp for a surveyKey is assigned from
  * @param surveyKey - string - key of the survey to check for.
  * @returns timestamp
  */
 const getSurveyKeyAssignedFrom = (surveyKey) => expressionUtils_expressionGen.generateExpression('getSurveyKeyAssignedFrom', undefined, surveyKey);
+const getSurveyKeyAssignedFromForIncoming = (surveyKey) => expressionUtils_expressionGen.generateExpression('incomingState:getSurveyKeyAssignedFrom', undefined, surveyKey);
 /**
  * Method to access the timestamp for a surveyKey is assigned until
  * @param surveyKey - string - key of the survey to check for.
  * @returns timestamp
  */
 const getSurveyKeyAssignedUntil = (surveyKey) => expressionUtils_expressionGen.generateExpression('getSurveyKeyAssignedUntil', undefined, surveyKey);
+const getSurveyKeyAssignedUntilForIncoming = (surveyKey) => expressionUtils_expressionGen.generateExpression('incomingState:getSurveyKeyAssignedUntil', undefined, surveyKey);
 /**
  * Check if a participant has a specific study status
  * @param status - string
  * @returns true/false
  */
 const hasStudyStatus = (status) => expressionUtils_expressionGen.generateExpression('getSurveyKeyAssignedUntil', undefined, status);
+const hasStudyStatusForIncoming = (status) => expressionUtils_expressionGen.generateExpression('incomingState:getSurveyKeyAssignedUntil', undefined, status);
 /**
  * Check if a participant flag with specific value is present
  * @param key look up this flag
@@ -111,24 +116,28 @@ 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 hasParticipantFlagKeyAndValue = (key, value) => expressionUtils_expressionGen.generateExpression('hasParticipantFlag', undefined, key, value);
+const hasParticipantFlagKeyAndValueForIncoming = (key, value) => expressionUtils_expressionGen.generateExpression('incomingState: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);
+const hasParticipantFlagKeyForIncoming = (key) => expressionUtils_expressionGen.generateExpression('incomingState: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);
+const hasMessageTypeAssignedForIncoming = (messageType) => expressionUtils_expressionGen.generateExpression('incomingState: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);
+const getMessageNextTimeForIncoming = (messageType) => expressionUtils_expressionGen.generateExpression('incomingState:getMessageNextTime', undefined, messageType);
 /**
  * Check if the last submission is older than the reference timestamp
  * @param reference look up this flag
@@ -136,6 +145,7 @@ const getMessageNextTime = (messageType) => expressionUtils_expressionGen.genera
  * @returns boolean
  */
 const lastSubmissionDateOlderThan = (reference, surveyKey) => expressionUtils_expressionGen.generateExpression('lastSubmissionDateOlderThan', undefined, reference, surveyKey);
+const lastSubmissionDateOlderThanForIncoming = (reference, surveyKey) => expressionUtils_expressionGen.generateExpression('incomingState:lastSubmissionDateOlderThan', undefined, reference, surveyKey);
 const eq = (val1, val2) => expressionUtils_expressionGen.generateExpression('eq', undefined, val1, val2);
 const lt = (val1, val2) => expressionUtils_expressionGen.generateExpression('lt', undefined, val1, val2);
 const lte = (val1, val2) => expressionUtils_expressionGen.generateExpression('lte', undefined, val1, val2);
@@ -203,12 +213,6 @@ const REMOVE_ALL_MESSAGES = () => expressionUtils_expressionGen.generateExpressi
  * @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
- * @returns
- */
-const ADD_REPORT = (itemKey) => expressionUtils_expressionGen.generateExpression('ADD_REPORT', undefined, itemKey);
 const REMOVE_SURVEY_BY_KEY = (surveyKey, selector) => {
     if (selector === 'all') {
         return expressionUtils_expressionGen.generateExpression('REMOVE_SURVEYS_BY_KEY', undefined, surveyKey);
@@ -217,14 +221,49 @@ const REMOVE_SURVEY_BY_KEY = (surveyKey, selector) => {
         return expressionUtils_expressionGen.generateExpression('REMOVE_SURVEY_BY_KEY', undefined, surveyKey, selector);
     }
 };
-const REMOVE_ALL_REPORTS = () => expressionUtils_expressionGen.generateExpression('REMOVE_ALL_REPORTS');
-const REMOVE_REPORT_BY_KEY = (surveyKey, selector) => {
-    if (selector === 'all') {
-        return expressionUtils_expressionGen.generateExpression('REMOVE_REPORTS_BY_KEY', undefined, surveyKey);
-    }
-    else {
-        return expressionUtils_expressionGen.generateExpression('REMOVE_REPORT_BY_KEY', undefined, surveyKey, selector);
-    }
+/**
+ * Initialises or resets a report for the current event
+ * @param reportKey key to be used for the report
+ */
+const INIT_REPORT = (reportKey) => {
+    return expressionUtils_expressionGen.generateExpression('INIT_REPORT', undefined, reportKey);
+};
+/**
+ * Remove the report from the list of reports to be added at the end of the event
+ * @param reportKey key of the report that should be removed
+ * @returns
+ */
+const CANCEL_REPORT = (reportKey) => {
+    return expressionUtils_expressionGen.generateExpression('CANCEL_REPORT', undefined, reportKey);
+};
+/**
+ * Update one value attribute in a report. If report was not initialized, one will be added to the list.
+ * @param reportKey
+ * @param attributeKey update / create this attribute in the report
+ * @param value this should be the value for the given attribute
+ * @param dtype optional dtype to set info for the app how to render this data.
+ * @returns
+ */
+const UPDATE_REPORT_DATA = (reportKey, attributeKey, value, dtype) => {
+    return expressionUtils_expressionGen.generateExpression('UPDATE_REPORT_DATA', undefined, reportKey, attributeKey, value, dtype);
+};
+/**
+ * Method to remove one attribute (key and value) from the report
+ * @param reportKey
+ * @param attributeKey
+ * @returns
+ */
+const REMOVE_REPORT_DATA = (reportKey, attributeKey) => {
+    return expressionUtils_expressionGen.generateExpression('REMOVE_REPORT_DATA', undefined, reportKey, attributeKey);
+};
+const setReportIcon = (reportKey, icon) => {
+    return UPDATE_REPORT_DATA(reportKey, 'icon', icon);
+};
+const setReportMessage = (reportKey, content, asTranslationKey) => {
+    return UPDATE_REPORT_DATA(reportKey, 'message', content, asTranslationKey ? undefined : 'rawMessage');
+};
+const setReportSummary = (reportKey, content, asTranslationKey) => {
+    return UPDATE_REPORT_DATA(reportKey, 'summary', content, asTranslationKey ? undefined : 'rawMessage');
 };
 // ##################
 // Prefill rule methods:
@@ -304,6 +343,19 @@ const NativeStudyEngineExpressions = {
         lastSubmissionDateOlderThan,
         hasMessageTypeAssigned,
         getMessageNextTime,
+        incomingParticipantState: {
+            // for merge event
+            getStudyEntryTime: getStudyEntryTimeForIncoming,
+            hasSurveyKeyAssigned: hasSurveyKeyAssignedForIncoming,
+            getSurveyKeyAssignedFrom: getSurveyKeyAssignedFromForIncoming,
+            getSurveyKeyAssignedUntil: getSurveyKeyAssignedUntilForIncoming,
+            hasStudyStatus: hasStudyStatusForIncoming,
+            hasParticipantFlagKeyAndValue: hasParticipantFlagKeyAndValueForIncoming,
+            hasParticipantFlagKey: hasParticipantFlagKeyForIncoming,
+            lastSubmissionDateOlderThan: lastSubmissionDateOlderThanForIncoming,
+            hasMessageTypeAssigned: hasMessageTypeAssignedForIncoming,
+            getMessageNextTime: getMessageNextTimeForIncoming,
+        }
     },
     // logical and comparision
     eq,
@@ -331,9 +383,14 @@ const StudyEngineActions = {
             remove: REMOVE_SURVEY_BY_KEY,
         },
         reports: {
-            add: ADD_REPORT,
-            removeAll: REMOVE_ALL_REPORTS,
-            remove: REMOVE_REPORT_BY_KEY,
+            init: INIT_REPORT,
+            cancel: CANCEL_REPORT,
+            updateData: UPDATE_REPORT_DATA,
+            removeData: REMOVE_REPORT_DATA,
+            // Extra methods:
+            setReportIcon,
+            setReportMessage,
+            setReportSummary,
         },
         messages: {
             add: ADD_MESSAGE,

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.31",
+  "version": "1.0.0-beta.32",
   "main": "index.js",
   "license": "Apache-2.0",
   "repository": "github:case-framework/case-editor-tools",

package/types/studyRules.d.ts

@@ -3,6 +3,7 @@ export declare class StudyRules {
     private enterRules?;
     private submitRules?;
     private timerRules?;
-    constructor(enterRules?: Expression[], submitRules?: Expression[], timerRules?: Expression[]);
+    private mergeRules?;
+    constructor(enterRules?: Expression[], submitRules?: Expression[], timerRules?: Expression[], mergeRules?: Expression[]);
     get(): Expression[];
 }

package/types/studyRules.js

@@ -8,10 +8,11 @@ require('./duration.js');
 require('../expression-utils/expressionGen.js');
 
 class StudyRules {
-    constructor(enterRules, submitRules, timerRules) {
+    constructor(enterRules, submitRules, timerRules, mergeRules) {
         this.enterRules = enterRules;
         this.submitRules = submitRules;
         this.timerRules = timerRules;
+        this.mergeRules = mergeRules;
     }
     get() {
         const rules = [];
@@ -24,6 +25,9 @@ class StudyRules {
         if (this.timerRules) {
             rules.push(expressionUtils_studyEngineExpressions.StudyEngine.ifThen(expressionUtils_studyEngineExpressions.StudyEngine.checkEventType('TIMER'), ...this.timerRules));
         }
+        if (this.mergeRules) {
+            rules.push(expressionUtils_studyEngineExpressions.StudyEngine.ifThen(expressionUtils_studyEngineExpressions.StudyEngine.checkEventType('MERGE'), ...this.mergeRules));
+        }
         return rules;
     }
 }

package/types/studyRules.js.map

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