case-editor-tools 1.5.0 → 1.6.0

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' | 'MERGE') => Expression;
+    checkEventType: (equalsType: 'ENTER' | 'SUBMIT' | 'TIMER' | 'MERGE' | 'LEAVE') => Expression;
     checkSurveyResponseKey: (surveyKey: string) => Expression;
     responseHasKeysAny: (itemKey: string, responseSlotKey: string, ...optionKeys: string[]) => Expression;
     responseHasOnlyKeysOtherThan: (itemKey: string, responseSlotKey: string, ...optionKeys: string[]) => Expression;
@@ -21,7 +21,7 @@ export declare const NativeStudyEngineExpressions: {
         hasParticipantFlagKeyAndValue: (key: string, value: string) => Expression;
         hasParticipantFlagKey: (key: string) => Expression;
         getParticipantFlagValue: (key: string) => Expression;
-        getParticipantFlagAsNum: (key: string) => Expression;
+        getParticipantFlagValueAsNum: (key: string) => Expression;
         lastSubmissionDateOlderThan: (reference: number | Expression, surveyKey?: string) => Expression;
         hasMessageTypeAssigned: (messageType: string) => Expression;
         getMessageNextTime: (messageType: string) => Expression;
@@ -49,7 +49,7 @@ export declare const NativeStudyEngineExpressions: {
     not: (arg: Expression) => Expression;
     timestampWithOffset: (delta: Duration, reference?: number | Expression) => Expression;
     parseValueAsNum: (valueRef: Expression | string | number) => Expression;
-    externalEventEval: (serviceName: string, expectFloat?: boolean) => Expression;
+    externalEventEval: (serviceName: string, route?: string, expectFloat?: boolean) => Expression;
 };
 export declare const StudyEngineActions: {
     if: (condition: Expression, actionIfTrue: Expression, actionIfFalse?: Expression) => Expression;
@@ -83,7 +83,7 @@ export declare const StudyEngineActions: {
             removeByKey: (key: string) => Expression;
             removeAll: () => Expression;
         };
-        externalEventHandler: (serviceName: string) => Expression;
+        externalEventHandler: (serviceName: string, route?: string) => Expression;
         stopParticipation: () => Expression;
         finishParticipation: () => Expression;
     };
@@ -149,12 +149,12 @@ export declare const StudyEngine: {
             removeByKey: (key: string) => Expression;
             removeAll: () => Expression;
         };
-        externalEventHandler: (serviceName: string) => Expression;
+        externalEventHandler: (serviceName: string, route?: string) => Expression;
         stopParticipation: () => Expression;
         finishParticipation: () => Expression;
     };
     notifyResearcher: (messageType: string, ...payload: Expression[] | string[]) => Expression;
-    checkEventType: (equalsType: 'ENTER' | 'SUBMIT' | 'TIMER' | 'MERGE') => Expression;
+    checkEventType: (equalsType: 'ENTER' | 'SUBMIT' | 'TIMER' | 'MERGE' | 'LEAVE') => Expression;
     checkSurveyResponseKey: (surveyKey: string) => Expression;
     responseHasKeysAny: (itemKey: string, responseSlotKey: string, ...optionKeys: string[]) => Expression;
     responseHasOnlyKeysOtherThan: (itemKey: string, responseSlotKey: string, ...optionKeys: string[]) => Expression;
@@ -174,7 +174,7 @@ export declare const StudyEngine: {
         hasParticipantFlagKeyAndValue: (key: string, value: string) => Expression;
         hasParticipantFlagKey: (key: string) => Expression;
         getParticipantFlagValue: (key: string) => Expression;
-        getParticipantFlagAsNum: (key: string) => Expression;
+        getParticipantFlagValueAsNum: (key: string) => Expression;
         lastSubmissionDateOlderThan: (reference: number | Expression, surveyKey?: string) => Expression;
         hasMessageTypeAssigned: (messageType: string) => Expression;
         getMessageNextTime: (messageType: string) => Expression;
@@ -202,5 +202,5 @@ export declare const StudyEngine: {
     not: (arg: Expression) => Expression;
     timestampWithOffset: (delta: Duration, reference?: number | Expression) => Expression;
     parseValueAsNum: (valueRef: Expression | string | number) => Expression;
-    externalEventEval: (serviceName: string, expectFloat?: boolean) => Expression;
+    externalEventEval: (serviceName: string, route?: string, expectFloat?: boolean) => Expression;
 };

package/expression-utils/studyEngineExpressions.js

@@ -13,7 +13,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', 'MERGE'
+ * @param equalsType string with the possible values: 'ENTER', 'SUBMIT', 'TIMER', 'MERGE', 'LEAVE'
  * @returns if event type matches the argument, return true otherwise false
  */
 const checkEventType = (equalsType) => expressionUtils_expressionGen.generateExpression('checkEventType', undefined, equalsType);
@@ -143,7 +143,7 @@ const hasParticipantFlagKeyForIncoming = (key) => expressionUtils_expressionGen.
 const getParticipantFlagValue = (key) => expressionUtils_expressionGen.generateExpression('getParticipantFlagValue', undefined, key);
 const getParticipantFlagValueForIncoming = (key) => expressionUtils_expressionGen.generateExpression('incomingState:getParticipantFlagValue', undefined, key);
 // Convinience method to parse participant flag's value as a number
-const getParticipantFlagAsNum = (key) => parseValueAsNum(getParticipantFlagValue(key));
+const getParticipantFlagValueAsNum = (key) => parseValueAsNum(getParticipantFlagValue(key));
 /**
  * Checks if the participant has a message type assigned (at least one)
  * @param messageType
@@ -189,10 +189,11 @@ const parseValueAsNum = (valueRef) => {
 /**
  *
  * @param serviceName name of the external service endpoint that should be used (URL and API key are config of the service)
+ * @param route optional route to be appended to the service URL
  * @param expectFloat optional flag if the response value is expected to be a float (number) - by default, string is expected
  * @returns
  */
-const externalEventEval = (serviceName, expectFloat) => expressionUtils_expressionGen.generateExpression('externalEventEval', expectFloat ? 'float' : undefined, serviceName);
+const externalEventEval = (serviceName, route, expectFloat) => expressionUtils_expressionGen.generateExpression('externalEventEval', expectFloat ? 'float' : undefined, serviceName, route);
 /**
  * Control flow method to use an if-else like structure
  * @param condition expression, return value interpreted as boolean
@@ -330,10 +331,11 @@ const setReportSummary = (reportKey, content, asTranslationKey) => {
 /**
  * Method to call external event handler
  * @param serviceName name of the external service endpoint that should be used (URL and API key are config of the service)
+ * @param route optional route to be appended to the service URL
  * @returns
  */
-const EXTERNAL_EVENT_HANDLER = (serviceName) => {
-    return expressionUtils_expressionGen.generateExpression('EXTERNAL_EVENT_HANDLER', undefined, serviceName);
+const EXTERNAL_EVENT_HANDLER = (serviceName, route) => {
+    return expressionUtils_expressionGen.generateExpression('EXTERNAL_EVENT_HANDLER', undefined, serviceName, route);
 };
 // ##################
 // Prefill rule methods:
@@ -418,7 +420,7 @@ const NativeStudyEngineExpressions = {
         hasParticipantFlagKeyAndValue,
         hasParticipantFlagKey,
         getParticipantFlagValue,
-        getParticipantFlagAsNum,
+        getParticipantFlagValueAsNum,
         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,7 +1,7 @@
 {
   "name": "case-editor-tools",
   "description": "Javascript tools to simplify survey and study coding for CASE.",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "main": "index.js",
   "license": "Apache-2.0",
   "repository": "github:case-framework/case-editor-tools",

package/surveys/utils/optionDefGenerators.d.ts

@@ -20,6 +20,10 @@ export declare const SingleChoiceOptionTypes: {
         displayCondition?: Expression;
         alignText?: 'start' | 'center' | 'end';
     }) => OptionDef;
+    dateInput: (props: DateInputProps & {
+        key: string;
+        displayCondition?: Expression;
+    }) => OptionDef;
     timeInput: (props: TimeInputProps & {
         key: string;
         displayCondition?: Expression;

package/surveys/utils/optionDefGenerators.js

@@ -191,7 +191,7 @@ const clozeLineBreak = () => {
 const SingleChoiceOptionTypes = {
     option,
     textInput,
-    //dateInput,
+    dateInput,
     timeInput,
     numberInput,
     cloze,

package/types/studyRules.d.ts

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

package/types/studyRules.js

@@ -30,6 +30,9 @@ class StudyRules {
         if (this.mergeRules) {
             rules.push(expressionUtils_studyEngineExpressions.StudyEngine.ifThen(expressionUtils_studyEngineExpressions.StudyEngine.checkEventType('MERGE'), ...this.mergeRules));
         }
+        if (this.leaveRules) {
+            rules.push(expressionUtils_studyEngineExpressions.StudyEngine.ifThen(expressionUtils_studyEngineExpressions.StudyEngine.checkEventType('LEAVE'), ...this.leaveRules));
+        }
         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":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}