case-editor-tools 1.6.8 → 1.6.10

package/expression-utils/studyEngineExpressions.d.ts

@@ -12,6 +12,7 @@ export declare const NativeStudyEngineExpressions: {
     hasResponseKey: (itemKey: string, responseKey: string) => Expression;
     hasResponseKeyWithValue: (itemKey: string, responseKey: string, value: string) => Expression;
     countResponseItems: (itemKey: string, responseKey: string) => Expression;
+    isStudyCodePresent: (listKey: string | Expression, code: string | Expression) => Expression;
     checkConditionForOldResponses: (condition: Expression, checkType?: number | 'all' | 'any', surveyKey?: string, querySince?: number | Expression, queryUntil?: number | Expression) => Expression;
     eventPayload: {
         hasEventPayload: () => Expression;
@@ -28,6 +29,10 @@ export declare const NativeStudyEngineExpressions: {
         hasStudyStatus: (status: string) => Expression;
         hasParticipantFlagKeyAndValue: (key: string, value: string) => Expression;
         hasParticipantFlagKey: (key: string) => Expression;
+        linkingCode: {
+            has: (forKey: string | Expression) => Expression;
+            get: (forKey: string | Expression) => Expression;
+        };
         getParticipantFlagValue: (key: string) => Expression;
         getParticipantFlagValueAsNum: (key: string) => Expression;
         getLastSubmissionDate: (surveyKey?: string) => Expression;
@@ -57,6 +62,8 @@ export declare const NativeStudyEngineExpressions: {
     or: (...args: Expression[]) => Expression;
     and: (...args: Expression[]) => Expression;
     not: (arg: Expression) => Expression;
+    sum: (...values: (Expression | number)[]) => Expression;
+    neg: (value: Expression | number) => Expression;
     timestampWithOffset: (delta: Duration, reference?: number | Expression) => Expression;
     getISOWeekForTs: (ts: number | Expression) => Expression;
     getTsForNextISOWeek: (ISOWeek: number | Expression, reference?: number | Expression) => Expression;
@@ -87,6 +94,11 @@ export declare const StudyEngineActions: {
             setReportMessage: (reportKey: string, content: string, asTranslationKey?: boolean) => Expression;
             setReportSummary: (reportKey: string, content: string, asTranslationKey?: boolean) => Expression;
         };
+        linkingCodes: {
+            set: (forKey: string | Expression, value: string | Expression) => Expression;
+            delete: (forKey?: string | Expression) => Expression;
+            drawFromStudyCodeList: (listKey: string | Expression, forKey?: string | Expression) => Expression;
+        };
         messages: {
             add: (messageType: string, scheduledFor: number | Expression) => Expression;
             removeAll: () => Expression;
@@ -100,6 +112,7 @@ export declare const StudyEngineActions: {
         stopParticipation: () => Expression;
         finishParticipation: () => Expression;
     };
+    removeStudyCode: (listKey: string | Expression, code: string | Expression) => Expression;
     notifyResearcher: (messageType: string, ...payload: Expression[] | string[]) => Expression;
 };
 export declare const StudyEngine: {
@@ -153,6 +166,11 @@ export declare const StudyEngine: {
             setReportMessage: (reportKey: string, content: string, asTranslationKey?: boolean) => Expression;
             setReportSummary: (reportKey: string, content: string, asTranslationKey?: boolean) => Expression;
         };
+        linkingCodes: {
+            set: (forKey: string | Expression, value: string | Expression) => Expression;
+            delete: (forKey?: string | Expression) => Expression;
+            drawFromStudyCodeList: (listKey: string | Expression, forKey?: string | Expression) => Expression;
+        };
         messages: {
             add: (messageType: string, scheduledFor: number | Expression) => Expression;
             removeAll: () => Expression;
@@ -166,6 +184,7 @@ export declare const StudyEngine: {
         stopParticipation: () => Expression;
         finishParticipation: () => Expression;
     };
+    removeStudyCode: (listKey: string | Expression, code: string | Expression) => Expression;
     notifyResearcher: (messageType: string, ...payload: Expression[] | string[]) => Expression;
     checkEventType: (equalsType: 'ENTER' | 'SUBMIT' | 'TIMER' | 'MERGE' | 'CUSTOM' | 'LEAVE') => Expression;
     checkEventKey: (equalsKey: string) => Expression;
@@ -178,6 +197,7 @@ export declare const StudyEngine: {
     hasResponseKey: (itemKey: string, responseKey: string) => Expression;
     hasResponseKeyWithValue: (itemKey: string, responseKey: string, value: string) => Expression;
     countResponseItems: (itemKey: string, responseKey: string) => Expression;
+    isStudyCodePresent: (listKey: string | Expression, code: string | Expression) => Expression;
     checkConditionForOldResponses: (condition: Expression, checkType?: number | 'all' | 'any', surveyKey?: string, querySince?: number | Expression, queryUntil?: number | Expression) => Expression;
     eventPayload: {
         hasEventPayload: () => Expression;
@@ -194,6 +214,10 @@ export declare const StudyEngine: {
         hasStudyStatus: (status: string) => Expression;
         hasParticipantFlagKeyAndValue: (key: string, value: string) => Expression;
         hasParticipantFlagKey: (key: string) => Expression;
+        linkingCode: {
+            has: (forKey: string | Expression) => Expression;
+            get: (forKey: string | Expression) => Expression;
+        };
         getParticipantFlagValue: (key: string) => Expression;
         getParticipantFlagValueAsNum: (key: string) => Expression;
         getLastSubmissionDate: (surveyKey?: string) => Expression;
@@ -223,6 +247,8 @@ export declare const StudyEngine: {
     or: (...args: Expression[]) => Expression;
     and: (...args: Expression[]) => Expression;
     not: (arg: Expression) => Expression;
+    sum: (...values: (Expression | number)[]) => Expression;
+    neg: (value: Expression | number) => Expression;
     timestampWithOffset: (delta: Duration, reference?: number | Expression) => Expression;
     getISOWeekForTs: (ts: number | Expression) => Expression;
     getTsForNextISOWeek: (ISOWeek: number | Expression, reference?: number | Expression) => Expression;

package/expression-utils/studyEngineExpressions.js

@@ -82,6 +82,15 @@ const getSelectedKeys = (itemKey, responseKey) => {
 const countResponseItems = (itemKey, responseKey) => {
     return expressionUtils_expressionGen.generateExpression('countResponseItems', undefined, itemKey, responseKey);
 };
+/**
+ * Check if a study code is present in the study wide list with the given list key
+ * @param listKey
+ * @param code
+ * @returns
+ */
+const isStudyCodePresent = (listKey, code) => {
+    return expressionUtils_expressionGen.generateExpression('isStudyCodePresent', undefined, listKey, code);
+};
 /**
  * Method to run a check on previous responses of the participant.
  * @param condition expression that will be evaluated on each retrieved response
@@ -189,6 +198,8 @@ const lt = (val1, val2) => expressionUtils_expressionGen.generateExpression('lt'
 const lte = (val1, val2) => expressionUtils_expressionGen.generateExpression('lte', undefined, val1, val2);
 const gt = (val1, val2) => expressionUtils_expressionGen.generateExpression('gt', undefined, val1, val2);
 const gte = (val1, val2) => expressionUtils_expressionGen.generateExpression('gte', undefined, val1, val2);
+const sum = (...values) => expressionUtils_expressionGen.generateExpression('sum', "float", ...values);
+const neg = (value) => expressionUtils_expressionGen.generateExpression("neg", "float", value);
 /**
  * Generate a timestamp value (POSIX timestamp). T = T_ref + delta. If 'reference' is not defined, the current time will be used as a reference.
  * @param delta offset for the timestamp generation
@@ -286,6 +297,13 @@ const REMOVE_ALL_MESSAGES = () => expressionUtils_expressionGen.generateExpressi
  * @returns
  */
 const REMOVE_MESSAGES_BY_TYPE = (messageType) => expressionUtils_expressionGen.generateExpression('REMOVE_MESSAGES_BY_TYPE', undefined, messageType);
+/**
+ * Remove a study code from a list
+ * @param listKey
+ * @param code
+ * @returns
+ */
+const REMOVE_STUDY_CODE = (listKey, code) => expressionUtils_expressionGen.generateExpression('REMOVE_STUDY_CODE', undefined, listKey, code);
 /**
  * Add a new notification message for the subscribed researchers
  * @param messageType message type
@@ -359,6 +377,48 @@ const setReportMessage = (reportKey, content, asTranslationKey) => {
 const setReportSummary = (reportKey, content, asTranslationKey) => {
     return UPDATE_REPORT_DATA(reportKey, 'summary', content, asTranslationKey ? undefined : 'rawMessage');
 };
+/**
+ * Method to check if a participant has any linking code for a specific key
+ * @param forKey
+ * @returns
+ */
+const hasLinkingCode = (forKey) => {
+    return expressionUtils_expressionGen.generateExpression('hasLinkingCode', undefined, forKey);
+};
+/**
+ * Retrieve the value of a linking code for a specific key. Will return empty string if not present
+ * @param forKey
+ * @returns
+ */
+const getLinkingCode = (forKey) => {
+    return expressionUtils_expressionGen.generateExpression("getLinkingCode", undefined, forKey);
+};
+/**
+ * Set a linking code for a specific key. This will override any existing value for that key, if already present.
+ * @param forKey: will result in an error if empty
+ * @param value
+ * @returns
+ */
+const SET_LINKING_CODE = (forKey, value) => {
+    return expressionUtils_expressionGen.generateExpression('SET_LINKING_CODE', undefined, forKey, value);
+};
+/**
+ * Delete a linking code for a specific key or all linling codes if no key is specified
+ * @param forKey
+ * @returns
+ */
+const DELETE_LINKING_CODE = (forKey) => {
+    return expressionUtils_expressionGen.generateExpression('DELETE_LINKING_CODE', undefined, forKey);
+};
+/**
+ * Draw (find one and delete) a study code from a list and store it as a linking code for the participant
+ * @param listKey Pick one from this list of study codes if available
+ * @param forKey optional key to store the linking code for. If not defined, the listKey will be used.
+ * @returns
+ */
+const DRAW_STUDY_CODE_AS_LINKING_CODE = (listKey, forKey) => {
+    return expressionUtils_expressionGen.generateExpression('DRAW_STUDY_CODE_AS_LINKING_CODE', undefined, listKey, forKey);
+};
 /**
  * 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)
@@ -440,6 +500,7 @@ const NativeStudyEngineExpressions = {
     hasResponseKey,
     hasResponseKeyWithValue,
     countResponseItems,
+    isStudyCodePresent,
     // Old responses
     checkConditionForOldResponses,
     // Event payload methods:
@@ -459,6 +520,10 @@ const NativeStudyEngineExpressions = {
         hasStudyStatus,
         hasParticipantFlagKeyAndValue,
         hasParticipantFlagKey,
+        linkingCode: {
+            has: hasLinkingCode,
+            get: getLinkingCode,
+        },
         getParticipantFlagValue,
         getParticipantFlagValueAsNum,
         getLastSubmissionDate,
@@ -490,6 +555,8 @@ const NativeStudyEngineExpressions = {
     or,
     and,
     not,
+    sum,
+    neg,
     // Other
     timestampWithOffset,
     getISOWeekForTs,
@@ -522,6 +589,11 @@ const StudyEngineActions = {
             setReportMessage,
             setReportSummary,
         },
+        linkingCodes: {
+            set: SET_LINKING_CODE,
+            delete: DELETE_LINKING_CODE,
+            drawFromStudyCodeList: DRAW_STUDY_CODE_AS_LINKING_CODE,
+        },
         messages: {
             add: ADD_MESSAGE,
             removeAll: REMOVE_ALL_MESSAGES,
@@ -536,6 +608,7 @@ const StudyEngineActions = {
         stopParticipation,
         finishParticipation,
     },
+    removeStudyCode: REMOVE_STUDY_CODE,
     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.6.8",
+  "version": "1.6.10",
   "main": "index.js",
   "license": "Apache-2.0",
   "repository": "github:case-framework/case-editor-tools",