case-editor-tools 1.6.5 → 1.6.7

package/expression-utils/studyEngineExpressions.d.ts

@@ -1,7 +1,8 @@
 import { Expression } from "survey-engine/data_types";
 import { Duration } from "../types/duration";
 export declare const NativeStudyEngineExpressions: {
-    checkEventType: (equalsType: 'ENTER' | 'SUBMIT' | 'TIMER' | 'MERGE' | 'LEAVE') => Expression;
+    checkEventType: (equalsType: 'ENTER' | 'SUBMIT' | 'TIMER' | 'MERGE' | 'CUSTOM' | 'LEAVE') => Expression;
+    checkEventKey: (equalsKey: string) => Expression;
     checkSurveyResponseKey: (surveyKey: string) => Expression;
     responseHasKeysAny: (itemKey: string, responseSlotKey: string, ...optionKeys: string[]) => Expression;
     responseHasOnlyKeysOtherThan: (itemKey: string, responseSlotKey: string, ...optionKeys: string[]) => Expression;
@@ -12,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;
@@ -157,7 +165,8 @@ export declare const StudyEngine: {
         finishParticipation: () => Expression;
     };
     notifyResearcher: (messageType: string, ...payload: Expression[] | string[]) => Expression;
-    checkEventType: (equalsType: 'ENTER' | 'SUBMIT' | 'TIMER' | 'MERGE' | 'LEAVE') => Expression;
+    checkEventType: (equalsType: 'ENTER' | 'SUBMIT' | 'TIMER' | 'MERGE' | 'CUSTOM' | 'LEAVE') => Expression;
+    checkEventKey: (equalsKey: string) => Expression;
     checkSurveyResponseKey: (surveyKey: string) => Expression;
     responseHasKeysAny: (itemKey: string, responseSlotKey: string, ...optionKeys: string[]) => Expression;
     responseHasOnlyKeysOtherThan: (itemKey: string, responseSlotKey: string, ...optionKeys: string[]) => Expression;
@@ -168,6 +177,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;

package/expression-utils/studyEngineExpressions.js

@@ -17,6 +17,12 @@ const not = (arg) => expressionUtils_expressionGen.generateExpression('not', und
  * @returns if event type matches the argument, return true otherwise false
  */
 const checkEventType = (equalsType) => expressionUtils_expressionGen.generateExpression('checkEventType', undefined, equalsType);
+/**
+ * Check if the current event has the given key
+ * @param equalsKey string
+ * @returns if event key matches the argument, return true otherwise false
+ */
+const checkEventKey = (equalsKey) => expressionUtils_expressionGen.generateExpression('checkEventKey', undefined, equalsKey);
 /**
  * Check if the submitted survey has a specific key
  * @param surveyKey string to check for
@@ -86,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
@@ -411,6 +422,7 @@ const hasSurveyKeyValidUntilSoonerThan = (surveyKey, delta, reference) => {
 };
 const NativeStudyEngineExpressions = {
     checkEventType,
+    checkEventKey,
     // Response checkers
     checkSurveyResponseKey,
     responseHasKeysAny,
@@ -423,6 +435,14 @@ const NativeStudyEngineExpressions = {
     countResponseItems,
     // Old responses
     checkConditionForOldResponses,
+    // Event payload methods:
+    eventPayload: {
+        hasEventPayload,
+        hasEventPayloadKey,
+        hasEventPayloadKeyWithValue,
+        getEventPayloadValueAsStr,
+        getEventPayloadValueAsNum,
+    },
     // Participant state:
     participantState: {
         getStudyEntryTime,

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