case-editor-tools 1.7.2 → 1.8.0

package/expression-utils/studyEngineExpressions.d.ts

@@ -57,6 +57,13 @@ export declare const NativeStudyEngineExpressions: {
             getMessageNextTime: (messageType: string) => Expression;
         };
     };
+    getStudyVariable: {
+        boolean: (key: string | Expression) => Expression;
+        string: (key: string | Expression) => Expression;
+        int: (key: string | Expression) => Expression;
+        float: (key: string | Expression) => Expression;
+        date: (key: string | Expression) => Expression;
+    };
     eq: (val1: Expression | string | number, val2: Expression | string | number) => Expression;
     lt: (val1: Expression | string | number, val2: Expression | string | number) => Expression;
     lte: (val1: Expression | string | number, val2: Expression | string | number) => Expression;
@@ -68,9 +75,11 @@ export declare const NativeStudyEngineExpressions: {
     sum: (...values: (Expression | number)[]) => Expression;
     neg: (value: Expression | number) => Expression;
     timestampWithOffset: (delta: Duration, reference?: number | Expression) => Expression;
+    timestampDiff: (laterTimestamp: number | Expression, earlierTimestamp: number | Expression) => Expression;
     getISOWeekForTs: (ts: number | Expression) => Expression;
     getTsForNextStartOfMonth: (month: Month | Expression, reference?: number | Expression) => Expression;
     getTsForNextISOWeek: (ISOWeek: number | Expression, reference?: number | Expression) => Expression;
+    getTsForStartOfISOWeek: (reference?: number | Expression) => Expression;
     parseValueAsNum: (valueRef: Expression | string | number) => Expression;
     generateRandomNumber: (min: number, max: number) => Expression;
     externalEventEval: (serviceName: string, route?: string, expectFloat?: boolean) => Expression;
@@ -119,6 +128,13 @@ export declare const StudyEngineActions: {
         stopParticipation: () => Expression;
         finishParticipation: () => Expression;
     };
+    updateStudyVariable: {
+        boolean: (key: string | Expression, value: Expression) => Expression;
+        string: (key: string | Expression, value: Expression | string) => Expression;
+        int: (key: string | Expression, value: number | Expression) => Expression;
+        float: (key: string | Expression, value: number | Expression) => Expression;
+        date: (key: string | Expression, value: number | Expression) => Expression;
+    };
     removeStudyCode: (listKey: string | Expression, code: string | Expression) => Expression;
     resetStudyCounter: (scopeKey: string | Expression) => Expression;
     notifyResearcher: (messageType: string, ...payload: Expression[] | string[]) => Expression;
@@ -195,6 +211,13 @@ export declare const StudyEngine: {
         stopParticipation: () => Expression;
         finishParticipation: () => Expression;
     };
+    updateStudyVariable: {
+        boolean: (key: string | Expression, value: Expression) => Expression;
+        string: (key: string | Expression, value: Expression | string) => Expression;
+        int: (key: string | Expression, value: number | Expression) => Expression;
+        float: (key: string | Expression, value: number | Expression) => Expression;
+        date: (key: string | Expression, value: number | Expression) => Expression;
+    };
     removeStudyCode: (listKey: string | Expression, code: string | Expression) => Expression;
     resetStudyCounter: (scopeKey: string | Expression) => Expression;
     notifyResearcher: (messageType: string, ...payload: Expression[] | string[]) => Expression;
@@ -253,6 +276,13 @@ export declare const StudyEngine: {
             getMessageNextTime: (messageType: string) => Expression;
         };
     };
+    getStudyVariable: {
+        boolean: (key: string | Expression) => Expression;
+        string: (key: string | Expression) => Expression;
+        int: (key: string | Expression) => Expression;
+        float: (key: string | Expression) => Expression;
+        date: (key: string | Expression) => Expression;
+    };
     eq: (val1: Expression | string | number, val2: Expression | string | number) => Expression;
     lt: (val1: Expression | string | number, val2: Expression | string | number) => Expression;
     lte: (val1: Expression | string | number, val2: Expression | string | number) => Expression;
@@ -264,9 +294,11 @@ export declare const StudyEngine: {
     sum: (...values: (Expression | number)[]) => Expression;
     neg: (value: Expression | number) => Expression;
     timestampWithOffset: (delta: Duration, reference?: number | Expression) => Expression;
+    timestampDiff: (laterTimestamp: number | Expression, earlierTimestamp: number | Expression) => Expression;
     getISOWeekForTs: (ts: number | Expression) => Expression;
     getTsForNextStartOfMonth: (month: Month | Expression, reference?: number | Expression) => Expression;
     getTsForNextISOWeek: (ISOWeek: number | Expression, reference?: number | Expression) => Expression;
+    getTsForStartOfISOWeek: (reference?: number | Expression) => Expression;
     parseValueAsNum: (valueRef: Expression | string | number) => Expression;
     generateRandomNumber: (min: number, max: number) => Expression;
     externalEventEval: (serviceName: string, route?: string, expectFloat?: boolean) => Expression;

package/expression-utils/studyEngineExpressions.js

@@ -209,6 +209,16 @@ const getLastSubmissionDateForIncoming = (surveyKey) => expressionUtils_expressi
  */
 const lastSubmissionDateOlderThan = (reference, surveyKey) => expressionUtils_expressionGen.generateExpression('lastSubmissionDateOlderThan', undefined, reference, surveyKey);
 const lastSubmissionDateOlderThanForIncoming = (reference, surveyKey) => expressionUtils_expressionGen.generateExpression('incomingState:lastSubmissionDateOlderThan', undefined, reference, surveyKey);
+const getStudyVariableBoolean = (key) => expressionUtils_expressionGen.generateExpression('getStudyVariableBoolean', undefined, key);
+const getStudyVariableString = (key) => expressionUtils_expressionGen.generateExpression('getStudyVariableString', undefined, key);
+const getStudyVariableInt = (key) => expressionUtils_expressionGen.generateExpression('getStudyVariableInt', undefined, key);
+const getStudyVariableFloat = (key) => expressionUtils_expressionGen.generateExpression('getStudyVariableFloat', undefined, key);
+const getStudyVariableDate = (key) => expressionUtils_expressionGen.generateExpression('getStudyVariableDate', undefined, key);
+const UPDATE_STUDY_VARIABLE_BOOLEAN = (key, value) => expressionUtils_expressionGen.generateExpression('UPDATE_STUDY_VARIABLE_BOOLEAN', undefined, key, value);
+const UPDATE_STUDY_VARIABLE_STRING = (key, value) => expressionUtils_expressionGen.generateExpression('UPDATE_STUDY_VARIABLE_STRING', undefined, key, value);
+const UPDATE_STUDY_VARIABLE_INT = (key, value) => expressionUtils_expressionGen.generateExpression('UPDATE_STUDY_VARIABLE_INT', undefined, key, value);
+const UPDATE_STUDY_VARIABLE_FLOAT = (key, value) => expressionUtils_expressionGen.generateExpression('UPDATE_STUDY_VARIABLE_FLOAT', undefined, key, value);
+const UPDATE_STUDY_VARIABLE_DATE = (key, value) => expressionUtils_expressionGen.generateExpression('UPDATE_STUDY_VARIABLE_DATE', undefined, key, value);
 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);
@@ -229,6 +239,13 @@ const timestampWithOffset = (delta, reference) => expressionUtils_expressionGen.
  * @returns
  */
 const getISOWeekForTs = (ts) => expressionUtils_expressionGen.generateExpression('getISOWeekForTs', undefined, ts);
+/**
+ * Calculate the signed difference between two POSIX timestamps in seconds.
+ * @param laterTimestamp timestamp or expression returning a timestamp
+ * @param earlierTimestamp timestamp or expression returning a timestamp
+ * @returns laterTimestamp minus earlierTimestamp, which may be negative
+ */
+const timestampDiff = (laterTimestamp, earlierTimestamp) => expressionUtils_expressionGen.generateExpression('timestampDiff', 'float', laterTimestamp, earlierTimestamp);
 /**
  * Generate a timestamp value (POSIX timestamp) for the beginning of the month for the first time that is later than the reference
  * @param month which ISO week should be used for the timestamp generation
@@ -243,6 +260,12 @@ const getTsForNextStartOfMonth = (month, reference) => expressionUtils_expressio
  * @returns
  */
 const getTsForNextISOWeek = (ISOWeek, reference) => expressionUtils_expressionGen.generateExpression('getTsForNextISOWeek', undefined, ISOWeek, reference ? reference : undefined);
+/**
+ * Get the POSIX timestamp for Monday midnight of the ISO week containing the reference, using the backend's local timezone.
+ * @param reference optional timestamp or expression returning a timestamp; defaults to the current time
+ * @returns the start of the reference's ISO week in seconds
+ */
+const getTsForStartOfISOWeek = (reference) => expressionUtils_expressionGen.generateExpression('getTsForStartOfISOWeek', undefined, reference);
 /**
  * Attempt to parse the resolved argument's value as a number
  * @param valueRef resolve this argument, and try to parse this as number. Boolean value will result in error.
@@ -608,6 +631,13 @@ const NativeStudyEngineExpressions = {
             getMessageNextTime: getMessageNextTimeForIncoming,
         }
     },
+    getStudyVariable: {
+        boolean: getStudyVariableBoolean,
+        string: getStudyVariableString,
+        int: getStudyVariableInt,
+        float: getStudyVariableFloat,
+        date: getStudyVariableDate,
+    },
     // logical and comparision
     eq,
     lt,
@@ -621,9 +651,11 @@ const NativeStudyEngineExpressions = {
     neg,
     // Other
     timestampWithOffset,
+    timestampDiff,
     getISOWeekForTs,
     getTsForNextStartOfMonth,
     getTsForNextISOWeek,
+    getTsForStartOfISOWeek,
     parseValueAsNum,
     generateRandomNumber: (min, max) => expressionUtils_expressionGen.generateExpression('generateRandomNumber', undefined, min, max),
     externalEventEval,
@@ -674,6 +706,13 @@ const StudyEngineActions = {
         stopParticipation,
         finishParticipation,
     },
+    updateStudyVariable: {
+        boolean: UPDATE_STUDY_VARIABLE_BOOLEAN,
+        string: UPDATE_STUDY_VARIABLE_STRING,
+        int: UPDATE_STUDY_VARIABLE_INT,
+        float: UPDATE_STUDY_VARIABLE_FLOAT,
+        date: UPDATE_STUDY_VARIABLE_DATE,
+    },
     removeStudyCode: REMOVE_STUDY_CODE,
     resetStudyCounter: RESET_STUDY_COUNTER,
     notifyResearcher: NOTIFY_RESEARCHER,

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

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

@@ -81,6 +81,14 @@ export declare const SurveyEngine: {
         hasKeyAndValue: (key: string, value: string | Expression) => Expression;
         getAsNum: (key: string) => Expression;
     };
+    studyVariables: {
+        hasKey: (key: string | Expression) => Expression;
+        getBoolean: (key: string | Expression) => Expression;
+        getString: (key: string | Expression) => Expression;
+        getInt: (key: string | Expression) => Expression;
+        getFloat: (key: string | Expression) => Expression;
+        getDate: (key: string | Expression) => Expression;
+    };
     isLoggedIn: () => Expression;
     getters: {
         getContext: () => Expression;

package/surveys/survey-engine-expressions.js

@@ -321,6 +321,54 @@ const hasParticipantFlagKey = (key) => {
 const hasParticipantFlagKeyAndValue = (key, value) => {
     return expressionUtils_expressionGen.generateExpression('hasParticipantFlagKeyAndValue', undefined, key, value);
 };
+/**
+ * Check if a study variable is present
+ * @param key look up this study variable
+ * @returns return true if key is present. If any of the two is different, or study variables is empty, it returns false.
+ */
+const hasStudyVariableKey = (key) => {
+    return expressionUtils_expressionGen.generateExpression('hasStudyVariableKey', undefined, key);
+};
+/**
+ * Get a study variable value as a boolean
+ * @param key look up this study variable
+ * @returns return the value of the study variable
+ */
+const getStudyVariableBoolean = (key) => {
+    return expressionUtils_expressionGen.generateExpression('getStudyVariableBoolean', undefined, key);
+};
+/**
+ * Get a study variable value as a string
+ * @param key look up this study variable
+ * @returns return the value of the study variable
+ */
+const getStudyVariableString = (key) => {
+    return expressionUtils_expressionGen.generateExpression('getStudyVariableString', undefined, key);
+};
+/**
+ * Get a study variable value as an integer
+ * @param key look up this study variable
+ * @returns return the value of the study variable
+ */
+const getStudyVariableInt = (key) => {
+    return expressionUtils_expressionGen.generateExpression('getStudyVariableInt', undefined, key);
+};
+/**
+ * Get a study variable value as a float
+ * @param key look up this study variable
+ * @returns return the value of the study variable
+ */
+const getStudyVariableFloat = (key) => {
+    return expressionUtils_expressionGen.generateExpression('getStudyVariableFloat', undefined, key);
+};
+/**
+ * Get a study variable value as a date
+ * @param key look up this study variable
+ * @returns return the value of the study variable in posix timestamp format (seconds since 1970-01-01 00:00:00 UTC)
+ */
+const getStudyVariableDate = (key) => {
+    return expressionUtils_expressionGen.generateExpression('getStudyVariableDate', undefined, key);
+};
 /**
  * Check if the participant is logged in currently.
  * @returns true if context variable isLoggedIn is set and true
@@ -443,6 +491,13 @@ const SurveyEngine = Object.assign(Object.assign({}, NativeSurveyEngineExpressio
         hasKey: hasParticipantFlagKey,
         hasKeyAndValue: hasParticipantFlagKeyAndValue,
         getAsNum: parseParticipantFlagAsNum,
+    }, studyVariables: {
+        hasKey: hasStudyVariableKey,
+        getBoolean: getStudyVariableBoolean,
+        getString: getStudyVariableString,
+        getInt: getStudyVariableInt,
+        getFloat: getStudyVariableFloat,
+        getDate: getStudyVariableDate,
     }, isLoggedIn });
 
 exports.NativeSurveyEngineExpressions = NativeSurveyEngineExpressions;

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":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}