case-editor-tools 1.6.6 → 1.6.8

package/expression-utils/studyEngineExpressions.d.ts

@@ -13,6 +13,13 @@ export declare const NativeStudyEngineExpressions: {
     hasResponseKeyWithValue: (itemKey: string, responseKey: string, value: string) => Expression;
     countResponseItems: (itemKey: string, responseKey: string) => Expression;
     checkConditionForOldResponses: (condition: Expression, checkType?: number | 'all' | 'any', surveyKey?: string, querySince?: number | Expression, queryUntil?: number | Expression) => Expression;
+    eventPayload: {
+        hasEventPayload: () => Expression;
+        hasEventPayloadKey: (key: string) => Expression;
+        hasEventPayloadKeyWithValue: (key: string, value: string) => Expression;
+        getEventPayloadValueAsStr: (key: string) => Expression;
+        getEventPayloadValueAsNum: (key: string) => Expression;
+    };
     participantState: {
         getStudyEntryTime: () => Expression;
         hasSurveyKeyAssigned: (surveyKey: string) => Expression;
@@ -23,6 +30,7 @@ export declare const NativeStudyEngineExpressions: {
         hasParticipantFlagKey: (key: string) => Expression;
         getParticipantFlagValue: (key: string) => Expression;
         getParticipantFlagValueAsNum: (key: string) => Expression;
+        getLastSubmissionDate: (surveyKey?: string) => Expression;
         lastSubmissionDateOlderThan: (reference: number | Expression, surveyKey?: string) => Expression;
         hasMessageTypeAssigned: (messageType: string) => Expression;
         getMessageNextTime: (messageType: string) => Expression;
@@ -35,6 +43,7 @@ export declare const NativeStudyEngineExpressions: {
             hasParticipantFlagKeyAndValue: (key: string, value: string) => Expression;
             hasParticipantFlagKey: (key: string) => Expression;
             getParticipantFlagValue: (key: string) => Expression;
+            getLastSubmissionDate: (surveyKey?: string) => Expression;
             lastSubmissionDateOlderThan: (reference: number | Expression, surveyKey?: string) => Expression;
             hasMessageTypeAssigned: (messageType: string) => Expression;
             getMessageNextTime: (messageType: string) => Expression;
@@ -170,6 +179,13 @@ export declare const StudyEngine: {
     hasResponseKeyWithValue: (itemKey: string, responseKey: string, value: string) => Expression;
     countResponseItems: (itemKey: string, responseKey: string) => Expression;
     checkConditionForOldResponses: (condition: Expression, checkType?: number | 'all' | 'any', surveyKey?: string, querySince?: number | Expression, queryUntil?: number | Expression) => Expression;
+    eventPayload: {
+        hasEventPayload: () => Expression;
+        hasEventPayloadKey: (key: string) => Expression;
+        hasEventPayloadKeyWithValue: (key: string, value: string) => Expression;
+        getEventPayloadValueAsStr: (key: string) => Expression;
+        getEventPayloadValueAsNum: (key: string) => Expression;
+    };
     participantState: {
         getStudyEntryTime: () => Expression;
         hasSurveyKeyAssigned: (surveyKey: string) => Expression;
@@ -180,6 +196,7 @@ export declare const StudyEngine: {
         hasParticipantFlagKey: (key: string) => Expression;
         getParticipantFlagValue: (key: string) => Expression;
         getParticipantFlagValueAsNum: (key: string) => Expression;
+        getLastSubmissionDate: (surveyKey?: string) => Expression;
         lastSubmissionDateOlderThan: (reference: number | Expression, surveyKey?: string) => Expression;
         hasMessageTypeAssigned: (messageType: string) => Expression;
         getMessageNextTime: (messageType: string) => Expression;
@@ -192,6 +209,7 @@ export declare const StudyEngine: {
             hasParticipantFlagKeyAndValue: (key: string, value: string) => Expression;
             hasParticipantFlagKey: (key: string) => Expression;
             getParticipantFlagValue: (key: string) => Expression;
+            getLastSubmissionDate: (surveyKey?: string) => Expression;
             lastSubmissionDateOlderThan: (reference: number | Expression, surveyKey?: string) => Expression;
             hasMessageTypeAssigned: (messageType: string) => Expression;
             getMessageNextTime: (messageType: string) => Expression;

package/expression-utils/studyEngineExpressions.js

@@ -92,6 +92,11 @@ const countResponseItems = (itemKey, responseKey) => {
  * @returns true/false
  */
 const checkConditionForOldResponses = (condition, checkType, surveyKey, querySince, queryUntil) => expressionUtils_expressionGen.generateExpression('checkConditionForOldResponses', undefined, condition, checkType, surveyKey, querySince, queryUntil);
+const hasEventPayload = () => expressionUtils_expressionGen.generateExpression('hasEventPayload', undefined);
+const hasEventPayloadKey = (key) => expressionUtils_expressionGen.generateExpression('hasEventPayloadKey', undefined, key);
+const hasEventPayloadKeyWithValue = (key, value) => expressionUtils_expressionGen.generateExpression('hasEventPayloadKeyWithValue', undefined, key, value);
+const getEventPayloadValueAsStr = (key) => expressionUtils_expressionGen.generateExpression('getEventPayloadValueAsStr', 'string', key);
+const getEventPayloadValueAsNum = (key) => expressionUtils_expressionGen.generateExpression('getEventPayloadValueAsNum', 'float', key);
 /**
  * Method to access the timestamp for when the participant entered the study
  * @returns timestamp
@@ -164,6 +169,13 @@ const hasMessageTypeAssignedForIncoming = (messageType) => expressionUtils_expre
  */
 const getMessageNextTime = (messageType) => expressionUtils_expressionGen.generateExpression('getMessageNextTime', undefined, messageType);
 const getMessageNextTimeForIncoming = (messageType) => expressionUtils_expressionGen.generateExpression('incomingState:getMessageNextTime', undefined, messageType);
+/**
+ * Retrieve the timestamp of the last submission
+ * @param surveyKey - optional - check for this specific survey key. If empty, it would check for all the submissions.
+ * @returns timestamp value or zero
+ */
+const getLastSubmissionDate = (surveyKey) => expressionUtils_expressionGen.generateExpression('getLastSubmissionDate', undefined, surveyKey);
+const getLastSubmissionDateForIncoming = (surveyKey) => expressionUtils_expressionGen.generateExpression('incomingState:getLastSubmissionDate', undefined, surveyKey);
 /**
  * Check if the last submission is older than the reference timestamp
  * @param reference look up this flag
@@ -430,6 +442,14 @@ const NativeStudyEngineExpressions = {
     countResponseItems,
     // Old responses
     checkConditionForOldResponses,
+    // Event payload methods:
+    eventPayload: {
+        hasEventPayload,
+        hasEventPayloadKey,
+        hasEventPayloadKeyWithValue,
+        getEventPayloadValueAsStr,
+        getEventPayloadValueAsNum,
+    },
     // Participant state:
     participantState: {
         getStudyEntryTime,
@@ -441,6 +461,7 @@ const NativeStudyEngineExpressions = {
         hasParticipantFlagKey,
         getParticipantFlagValue,
         getParticipantFlagValueAsNum,
+        getLastSubmissionDate,
         lastSubmissionDateOlderThan,
         hasMessageTypeAssigned,
         getMessageNextTime,
@@ -454,6 +475,7 @@ const NativeStudyEngineExpressions = {
             hasParticipantFlagKeyAndValue: hasParticipantFlagKeyAndValueForIncoming,
             hasParticipantFlagKey: hasParticipantFlagKeyForIncoming,
             getParticipantFlagValue: getParticipantFlagValueForIncoming,
+            getLastSubmissionDate: getLastSubmissionDateForIncoming,
             lastSubmissionDateOlderThan: lastSubmissionDateOlderThanForIncoming,
             hasMessageTypeAssigned: hasMessageTypeAssignedForIncoming,
             getMessageNextTime: getMessageNextTimeForIncoming,

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