case-editor-tools 1.7.0 → 1.7.2

package/expression-utils/studyEngineExpressions.d.ts

@@ -14,6 +14,8 @@ export declare const NativeStudyEngineExpressions: {
     hasResponseKeyWithValue: (itemKey: string, responseKey: string, value: string) => Expression;
     countResponseItems: (itemKey: string, responseKey: string) => Expression;
     isStudyCodePresent: (listKey: string | Expression, code: string | Expression) => Expression;
+    getCurrentStudyCounterValue: (scopeKey: string | Expression) => Expression;
+    getNextStudyCounterValue: (scopeKey: string | Expression) => Expression;
     checkConditionForOldResponses: (condition: Expression, checkType?: number | 'all' | 'any', surveyKey?: string, querySince?: number | Expression, queryUntil?: number | Expression) => Expression;
     eventPayload: {
         hasEventPayload: () => Expression;
@@ -80,8 +82,9 @@ export declare const StudyEngineActions: {
     participantActions: {
         updateStudyStatus: (status: string) => Expression;
         startNewStudySession: () => Expression;
-        updateFlag: (key: string, newValue: string | number | Expression) => Expression;
-        removeFlag: (key: string) => Expression;
+        updateFlag: (key: string | Expression, newValue: string | number | Expression) => Expression;
+        removeFlag: (key: string | Expression) => Expression;
+        getNextStudyCounterAsFlag: (scopeKey: string | Expression, flagKey: string | Expression, prefix: string | Expression, padding: number | Expression) => Expression;
         assignedSurveys: {
             add: (surveyKey: string, category: 'immediate' | 'prio' | 'normal' | 'optional', activeFrom?: number | Expression, activeUntil?: number | Expression) => Expression;
             removeAll: () => Expression;
@@ -100,11 +103,13 @@ export declare const StudyEngineActions: {
             set: (forKey: string | Expression, value: string | Expression) => Expression;
             delete: (forKey?: string | Expression) => Expression;
             drawFromStudyCodeList: (listKey: string | Expression, forKey?: string | Expression) => Expression;
+            getNextStudyCounterAsLinkingCode: (scopeKey: string | Expression, linkingCodeKey: string | Expression, prefix: string | Expression, padding: number | Expression) => Expression;
         };
         messages: {
             add: (messageType: string, scheduledFor: number | Expression) => Expression;
             removeAll: () => Expression;
             remove: (messageType: string) => Expression;
+            sendNow: (messageType: string, languageOverride?: string) => Expression;
         };
         confidentialResponses: {
             removeByKey: (key: string) => Expression;
@@ -115,6 +120,7 @@ export declare const StudyEngineActions: {
         finishParticipation: () => Expression;
     };
     removeStudyCode: (listKey: string | Expression, code: string | Expression) => Expression;
+    resetStudyCounter: (scopeKey: string | Expression) => Expression;
     notifyResearcher: (messageType: string, ...payload: Expression[] | string[]) => Expression;
 };
 export declare const StudyEngine: {
@@ -152,8 +158,9 @@ export declare const StudyEngine: {
     participantActions: {
         updateStudyStatus: (status: string) => Expression;
         startNewStudySession: () => Expression;
-        updateFlag: (key: string, newValue: string | number | Expression) => Expression;
-        removeFlag: (key: string) => Expression;
+        updateFlag: (key: string | Expression, newValue: string | number | Expression) => Expression;
+        removeFlag: (key: string | Expression) => Expression;
+        getNextStudyCounterAsFlag: (scopeKey: string | Expression, flagKey: string | Expression, prefix: string | Expression, padding: number | Expression) => Expression;
         assignedSurveys: {
             add: (surveyKey: string, category: 'immediate' | 'prio' | 'normal' | 'optional', activeFrom?: number | Expression, activeUntil?: number | Expression) => Expression;
             removeAll: () => Expression;
@@ -172,11 +179,13 @@ export declare const StudyEngine: {
             set: (forKey: string | Expression, value: string | Expression) => Expression;
             delete: (forKey?: string | Expression) => Expression;
             drawFromStudyCodeList: (listKey: string | Expression, forKey?: string | Expression) => Expression;
+            getNextStudyCounterAsLinkingCode: (scopeKey: string | Expression, linkingCodeKey: string | Expression, prefix: string | Expression, padding: number | Expression) => Expression;
         };
         messages: {
             add: (messageType: string, scheduledFor: number | Expression) => Expression;
             removeAll: () => Expression;
             remove: (messageType: string) => Expression;
+            sendNow: (messageType: string, languageOverride?: string) => Expression;
         };
         confidentialResponses: {
             removeByKey: (key: string) => Expression;
@@ -187,6 +196,7 @@ export declare const StudyEngine: {
         finishParticipation: () => Expression;
     };
     removeStudyCode: (listKey: string | Expression, code: string | Expression) => Expression;
+    resetStudyCounter: (scopeKey: string | Expression) => Expression;
     notifyResearcher: (messageType: string, ...payload: Expression[] | string[]) => Expression;
     checkEventType: (equalsType: 'ENTER' | 'SUBMIT' | 'TIMER' | 'MERGE' | 'CUSTOM' | 'LEAVE') => Expression;
     checkEventKey: (equalsKey: string) => Expression;
@@ -200,6 +210,8 @@ export declare const StudyEngine: {
     hasResponseKeyWithValue: (itemKey: string, responseKey: string, value: string) => Expression;
     countResponseItems: (itemKey: string, responseKey: string) => Expression;
     isStudyCodePresent: (listKey: string | Expression, code: string | Expression) => Expression;
+    getCurrentStudyCounterValue: (scopeKey: string | Expression) => Expression;
+    getNextStudyCounterValue: (scopeKey: string | Expression) => Expression;
     checkConditionForOldResponses: (condition: Expression, checkType?: number | 'all' | 'any', surveyKey?: string, querySince?: number | Expression, queryUntil?: number | Expression) => Expression;
     eventPayload: {
         hasEventPayload: () => Expression;

package/expression-utils/studyEngineExpressions.js

@@ -91,6 +91,22 @@ const countResponseItems = (itemKey, responseKey) => {
 const isStudyCodePresent = (listKey, code) => {
     return expressionUtils_expressionGen.generateExpression('isStudyCodePresent', undefined, listKey, code);
 };
+/**
+ * Get the current study counter value for the given scope key (does not change the counter)
+ * @param scopeKey
+ * @returns
+ */
+const getCurrentStudyCounterValue = (scopeKey) => {
+    return expressionUtils_expressionGen.generateExpression('getCurrentStudyCounterValue', undefined, scopeKey);
+};
+/**
+ * Get the next study counter value for the given scope key (increases the counter by 1)
+ * @param scopeKey
+ * @returns
+ */
+const getNextStudyCounterValue = (scopeKey) => {
+    return expressionUtils_expressionGen.generateExpression('getNextStudyCounterValue', undefined, scopeKey);
+};
 /**
  * Method to run a check on previous responses of the participant.
  * @param condition expression that will be evaluated on each retrieved response
@@ -304,6 +320,13 @@ const REMOVE_ALL_MESSAGES = () => expressionUtils_expressionGen.generateExpressi
  * @returns
  */
 const REMOVE_MESSAGES_BY_TYPE = (messageType) => expressionUtils_expressionGen.generateExpression('REMOVE_MESSAGES_BY_TYPE', undefined, messageType);
+/**
+ * Send a message now
+ * @param messageType message type
+ * @param languageOverride optional language override
+ * @returns
+ */
+const SEND_MESSAGE_NOW = (messageType, languageOverride) => expressionUtils_expressionGen.generateExpression('SEND_MESSAGE_NOW', undefined, messageType, languageOverride);
 /**
  * Remove a study code from a list
  * @param listKey
@@ -426,6 +449,36 @@ const DELETE_LINKING_CODE = (forKey) => {
 const DRAW_STUDY_CODE_AS_LINKING_CODE = (listKey, forKey) => {
     return expressionUtils_expressionGen.generateExpression('DRAW_STUDY_CODE_AS_LINKING_CODE', undefined, listKey, forKey);
 };
+/**
+ * Get the next study counter value for the given scope key (increases the counter by 1) and store it as a flag for the participant
+ * @param scopeKey
+ * @param flagKey
+ * @param prefix prefix to be added to the flag
+ * @param padding number of digits to pad the counter with
+ * @returns
+ */
+const GET_NEXT_STUDY_COUNTER_AS_FLAG = (scopeKey, flagKey, prefix, padding) => {
+    return expressionUtils_expressionGen.generateExpression('GET_NEXT_STUDY_COUNTER_AS_FLAG', undefined, scopeKey, flagKey, prefix, padding);
+};
+/**
+ * Get the next study counter value for the given scope key (increases the counter by 1) and store it as a linking code for the participant
+ * @param scopeKey
+ * @param linkingCodeKey
+ * @param prefix prefix to be added to the linking code
+ * @param padding number of digits to pad the counter with
+ * @returns
+ */
+const GET_NEXT_STUDY_COUNTER_AS_LINKING_CODE = (scopeKey, linkingCodeKey, prefix, padding) => {
+    return expressionUtils_expressionGen.generateExpression('GET_NEXT_STUDY_COUNTER_AS_LINKING_CODE', undefined, scopeKey, linkingCodeKey, prefix, padding);
+};
+/**
+ * Reset the study counter for the given scope key
+ * @param scopeKey
+ * @returns
+ */
+const RESET_STUDY_COUNTER = (scopeKey) => {
+    return expressionUtils_expressionGen.generateExpression('RESET_STUDY_COUNTER', undefined, scopeKey);
+};
 /**
  * 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)
@@ -508,6 +561,8 @@ const NativeStudyEngineExpressions = {
     hasResponseKeyWithValue,
     countResponseItems,
     isStudyCodePresent,
+    getCurrentStudyCounterValue,
+    getNextStudyCounterValue,
     // Old responses
     checkConditionForOldResponses,
     // Event payload methods:
@@ -582,6 +637,7 @@ const StudyEngineActions = {
         startNewStudySession: START_NEW_STUDY_SESSION,
         updateFlag: UPDATE_FLAG,
         removeFlag: REMOVE_FLAG,
+        getNextStudyCounterAsFlag: GET_NEXT_STUDY_COUNTER_AS_FLAG,
         assignedSurveys: {
             add: ADD_NEW_SURVEY,
             removeAll: REMOVE_ALL_SURVEYS,
@@ -601,11 +657,13 @@ const StudyEngineActions = {
             set: SET_LINKING_CODE,
             delete: DELETE_LINKING_CODE,
             drawFromStudyCodeList: DRAW_STUDY_CODE_AS_LINKING_CODE,
+            getNextStudyCounterAsLinkingCode: GET_NEXT_STUDY_COUNTER_AS_LINKING_CODE,
         },
         messages: {
             add: ADD_MESSAGE,
             removeAll: REMOVE_ALL_MESSAGES,
             remove: REMOVE_MESSAGES_BY_TYPE,
+            sendNow: SEND_MESSAGE_NOW,
         },
         confidentialResponses: {
             removeByKey: REMOVE_CONFIDENTIAL_RESPONSE_BY_KEY,
@@ -617,6 +675,7 @@ const StudyEngineActions = {
         finishParticipation,
     },
     removeStudyCode: REMOVE_STUDY_CODE,
+    resetStudyCounter: RESET_STUDY_COUNTER,
     notifyResearcher: NOTIFY_RESEARCHER,
 };
 const StudyEngine = Object.assign(Object.assign(Object.assign({}, NativeStudyEngineExpressions), StudyEngineActions), { singleChoice: {

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