case-editor-tools 1.0.5 → 1.0.6

package/expression-utils/studyEngineExpressions.d.ts

@@ -47,6 +47,7 @@ export declare const NativeStudyEngineExpressions: {
     and: (...args: Expression[]) => Expression;
     not: (arg: Expression) => Expression;
     timestampWithOffset: (delta: Duration, reference?: number | Expression | undefined) => Expression;
+    externalEventEval: (serviceName: string, expectFloat?: boolean | undefined) => Expression;
 };
 export declare const StudyEngineActions: {
     if: (condition: Expression, actionIfTrue: Expression, actionIfFalse?: Expression | undefined) => Expression;
@@ -75,11 +76,13 @@ export declare const StudyEngineActions: {
             add: (messageType: string, scheduledFor: number | Expression) => Expression;
             removeAll: () => Expression;
             remove: (messageType: string) => Expression;
+            notifyResearcher: (messageType: string, ...payload: Expression[] | string[]) => Expression;
         };
         confidentialResponses: {
             removeByKey: (key: string) => Expression;
             removeAll: () => Expression;
         };
+        externalEventHandler: (serviceName: string) => Expression;
         stopParticipation: () => Expression;
         finishParticipation: () => Expression;
     };
@@ -139,11 +142,13 @@ export declare const StudyEngine: {
             add: (messageType: string, scheduledFor: number | Expression) => Expression;
             removeAll: () => Expression;
             remove: (messageType: string) => Expression;
+            notifyResearcher: (messageType: string, ...payload: Expression[] | string[]) => Expression;
         };
         confidentialResponses: {
             removeByKey: (key: string) => Expression;
             removeAll: () => Expression;
         };
+        externalEventHandler: (serviceName: string) => Expression;
         stopParticipation: () => Expression;
         finishParticipation: () => Expression;
     };
@@ -193,4 +198,5 @@ export declare const StudyEngine: {
     and: (...args: Expression[]) => Expression;
     not: (arg: Expression) => Expression;
     timestampWithOffset: (delta: Duration, reference?: number | Expression | undefined) => Expression;
+    externalEventEval: (serviceName: string, expectFloat?: boolean | undefined) => Expression;
 };

package/expression-utils/studyEngineExpressions.js

@@ -174,6 +174,13 @@ const gte = (val1, val2) => expressionUtils_expressionGen.generateExpression('gt
  * @returns
  */
 const timestampWithOffset = (delta, reference) => expressionUtils_expressionGen.generateExpression('timestampWithOffset', undefined, types_duration.durationObjectToSeconds(delta), reference ? reference : undefined);
+/**
+ *
+ * @param serviceName name of the external service endpoint that should be used (URL and API key are config of the service)
+ * @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);
 /**
  * Control flow method to use an if-else like structure
  * @param condition expression, return value interpreted as boolean
@@ -235,6 +242,12 @@ const REMOVE_ALL_MESSAGES = () => expressionUtils_expressionGen.generateExpressi
  * @returns
  */
 const REMOVE_MESSAGES_BY_TYPE = (messageType) => expressionUtils_expressionGen.generateExpression('REMOVE_MESSAGES_BY_TYPE', undefined, messageType);
+/**
+ * Add a new notification message for the subscribed researchers
+ * @param messageType message type
+ * @returns
+ */
+const NOTIFY_RESEARCHER = (messageType, ...payload) => expressionUtils_expressionGen.generateExpression('NOTIFY_RESEARCHER', undefined, messageType, ...payload);
 const REMOVE_SURVEY_BY_KEY = (surveyKey, selector) => {
     if (selector === 'all') {
         return expressionUtils_expressionGen.generateExpression('REMOVE_SURVEYS_BY_KEY', undefined, surveyKey);
@@ -302,6 +315,14 @@ const setReportMessage = (reportKey, content, asTranslationKey) => {
 const setReportSummary = (reportKey, content, asTranslationKey) => {
     return UPDATE_REPORT_DATA(reportKey, 'summary', content, asTranslationKey ? undefined : 'rawMessage');
 };
+/**
+ * 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)
+ * @returns
+ */
+const EXTERNAL_EVENT_HANDLER = (serviceName) => {
+    return expressionUtils_expressionGen.generateExpression('EXTERNAL_EVENT_HANDLER', undefined, serviceName);
+};
 // ##################
 // Prefill rule methods:
 const PREFILL_SLOT_WITH_VALUE = (itemKey, slotKey, value) => {
@@ -414,6 +435,7 @@ const NativeStudyEngineExpressions = {
     not,
     // Other
     timestampWithOffset,
+    externalEventEval,
 };
 const StudyEngineActions = {
     if: IF,
@@ -443,11 +465,13 @@ const StudyEngineActions = {
             add: ADD_MESSAGE,
             removeAll: REMOVE_ALL_MESSAGES,
             remove: REMOVE_MESSAGES_BY_TYPE,
+            notifyResearcher: NOTIFY_RESEARCHER,
         },
         confidentialResponses: {
             removeByKey: REMOVE_CONFIDENTIAL_RESPONSE_BY_KEY,
             removeAll: REMOVE_ALL_CONFIDENTIAL_RESPONSES,
         },
+        externalEventHandler: EXTERNAL_EVENT_HANDLER,
         // Extra methods:
         stopParticipation,
         finishParticipation,

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