case-editor-tools 1.0.0-beta.43 → 1.0.0-beta.46

package/exporter/index.js

@@ -4,6 +4,8 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var fs = require('fs');
 var logger_logger = require('../logger/logger.js');
+var types_messageConfig = require('../types/messageConfig.js');
+require('../types/duration.js');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -22,6 +24,8 @@ const generateFilesForStudy = (study, pretty) => {
     generateStudyRuleFile(study, outputRoot, pretty);
     // Custom Study rules: (manually triggered rules)
     generateCustomStudyRules(study, outputRoot, pretty);
+    // Message configs:
+    generateMessageConfigs(study, outputRoot, pretty);
 };
 const generateSurveyFiles = (study, outputPath, pretty) => {
     if (study.surveys.length > 0) {
@@ -93,6 +97,31 @@ const generateCustomStudyRules = (study, outputPath, pretty) => {
         }
         logger_logger.Logger.success(`\t\tRule ${studyRule.name} saved`);
     });
+};
+const generateMessageConfigs = (study, outputPath, pretty) => {
+    if (!study.messageConfigs || study.messageConfigs.length < 1) {
+        logger_logger.Logger.log(`\tNo message configs in the study.`);
+        return;
+    }
+    else {
+        logger_logger.Logger.log(`\tMessage configs:`);
+    }
+    const messageConfigPath = `${outputPath}/messageConfigs`;
+    if (!fs__default["default"].existsSync(messageConfigPath)) {
+        fs__default["default"].mkdirSync(messageConfigPath, { recursive: true });
+    }
+    study.messageConfigs.forEach(conf => {
+        const fileName = `${messageConfigPath}/${conf.label.replace(' ', '_').toLocaleLowerCase()}.json`;
+        const outputObject = types_messageConfig.buildMessageConfig(conf);
+        try {
+            fs__default["default"].writeFileSync(fileName, JSON.stringify(outputObject, undefined, pretty ? 2 : undefined));
+        }
+        catch (err) {
+            logger_logger.Logger.error(err);
+            return;
+        }
+        logger_logger.Logger.success(`\t\tConfig for "${conf.label}" saved`);
+    });
 };
 
 exports.generateFilesForStudy = generateFilesForStudy;

package/exporter/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/expression-utils/studyEngineExpressions.d.ts

@@ -7,6 +7,7 @@ export declare const NativeStudyEngineExpressions: {
     responseHasOnlyKeysOtherThan: (itemKey: string, responseSlotKey: string, ...optionKeys: string[]) => Expression;
     getResponseValueAsNum: (itemKey: string, responseKey: string) => Expression;
     getResponseValueAsStr: (itemKey: string, responseKey: string) => Expression;
+    getSelectedKeys: (itemKey: string, responseKey: string) => Expression;
     hasResponseKey: (itemKey: string, responseKey: string) => Expression;
     hasResponseKeyWithValue: (itemKey: string, responseKey: string, value: string) => Expression;
     countResponseItems: (itemKey: string, responseKey: string) => Expression;
@@ -64,7 +65,7 @@ export declare const StudyEngineActions: {
         reports: {
             init: (reportKey: string) => Expression;
             cancel: (reportKey: string) => Expression;
-            updateData: (reportKey: string, attributeKey: string, value: number | string | Expression, dtype?: "string" | "date" | "float" | "int" | "rawMessage" | undefined) => Expression;
+            updateData: (reportKey: string, attributeKey: string, value: number | string | Expression, dtype?: "string" | "date" | "float" | "int" | "rawMessage" | "keyList" | undefined) => Expression;
             removeData: (reportKey: string, attributeKey: string) => Expression;
             setReportIcon: (reportKey: string, icon: string) => Expression;
             setReportMessage: (reportKey: string, content: string, asTranslationKey?: boolean | undefined) => Expression;
@@ -127,7 +128,7 @@ export declare const StudyEngine: {
         reports: {
             init: (reportKey: string) => Expression;
             cancel: (reportKey: string) => Expression;
-            updateData: (reportKey: string, attributeKey: string, value: number | string | Expression, dtype?: "string" | "date" | "float" | "int" | "rawMessage" | undefined) => Expression;
+            updateData: (reportKey: string, attributeKey: string, value: number | string | Expression, dtype?: "string" | "date" | "float" | "int" | "rawMessage" | "keyList" | undefined) => Expression;
             removeData: (reportKey: string, attributeKey: string) => Expression;
             setReportIcon: (reportKey: string, icon: string) => Expression;
             setReportMessage: (reportKey: string, content: string, asTranslationKey?: boolean | undefined) => Expression;
@@ -151,6 +152,7 @@ export declare const StudyEngine: {
     responseHasOnlyKeysOtherThan: (itemKey: string, responseSlotKey: string, ...optionKeys: string[]) => Expression;
     getResponseValueAsNum: (itemKey: string, responseKey: string) => Expression;
     getResponseValueAsStr: (itemKey: string, responseKey: string) => Expression;
+    getSelectedKeys: (itemKey: string, responseKey: string) => Expression;
     hasResponseKey: (itemKey: string, responseKey: string) => Expression;
     hasResponseKeyWithValue: (itemKey: string, responseKey: string, value: string) => Expression;
     countResponseItems: (itemKey: string, responseKey: string) => Expression;

package/expression-utils/studyEngineExpressions.js

@@ -62,6 +62,15 @@ const getResponseValueAsNum = (itemKey, responseKey) => {
 const getResponseValueAsStr = (itemKey, responseKey) => {
     return expressionUtils_expressionGen.generateExpression('getResponseValueAsStr', 'string', itemKey, responseKey);
 };
+/**
+ * Retrieve the selected keys from a response slot
+ * @param itemKey full key to the survey item, in the form, e.g., <surveyKey>.<groupKey>.<itemKey>
+ * @param responseKey key of the response slot, where keys should be retrieved from
+ * @returns
+ */
+const getSelectedKeys = (itemKey, responseKey) => {
+    return expressionUtils_expressionGen.generateExpression('getSelectedKeys', 'string', itemKey, responseKey);
+};
 const countResponseItems = (itemKey, responseKey) => {
     return expressionUtils_expressionGen.generateExpression('countResponseItems', undefined, itemKey, responseKey);
 };
@@ -357,6 +366,7 @@ const NativeStudyEngineExpressions = {
     responseHasOnlyKeysOtherThan,
     getResponseValueAsNum,
     getResponseValueAsStr,
+    getSelectedKeys,
     hasResponseKey,
     hasResponseKeyWithValue,
     countResponseItems,

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

package/types/messageConfig.d.ts

@@ -0,0 +1,50 @@
+import { Expression } from "survey-engine/data_types";
+import { Duration } from "./duration";
+export declare type MessageType = 'registration' | 'invitation' | 'verify-email' | 'verification-code' | 'password-reset' | 'password-changed' | 'account-id-changed' | 'weekly' | 'study-reminder' | 'newsletter' | 'account-deleted';
+export interface MessageConfig {
+    sendTo: 'study-participants' | 'all-users' | 'scheduled-participant-messages';
+    studyKey: string;
+    label: string;
+    headerOverrides?: {
+        from: string;
+        sender: string;
+        replyTo: string[];
+    };
+    messageType: MessageType;
+    sendingTime: {
+        hour: number;
+        minute: number;
+    };
+    period: Duration;
+    defaultLanguage: string;
+    condition: Expression;
+    translations: Array<{
+        lang: string;
+        subject: string;
+    }>;
+}
+export declare const buildMessageConfig: (props: MessageConfig) => {
+    sendTo: "study-participants" | "all-users" | "scheduled-participant-messages";
+    studyKey: string;
+    label: string;
+    headerOverrides: {
+        from: string;
+        sender: string;
+        replyTo: string[];
+    } | undefined;
+    messageType: MessageType;
+    sendingTime: {
+        hour: number;
+        minute: number;
+    };
+    condition: {
+        dtype: string;
+        exp: Expression;
+    };
+    period: number;
+    defaultLanguage: string;
+    translations: {
+        lang: string;
+        subject: string;
+    }[];
+};

package/types/messageConfig.js

@@ -0,0 +1,23 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var types_duration = require('./duration.js');
+
+const buildMessageConfig = (props) => {
+    return {
+        sendTo: props.sendTo,
+        studyKey: props.studyKey,
+        label: props.label,
+        headerOverrides: props.headerOverrides,
+        messageType: props.messageType,
+        sendingTime: props.sendingTime,
+        condition: { dtype: 'exp', exp: props.condition },
+        period: Math.floor(types_duration.durationObjectToSeconds(props.period)),
+        defaultLanguage: props.defaultLanguage,
+        translations: props.translations,
+    };
+};
+
+exports.buildMessageConfig = buildMessageConfig;
+//# sourceMappingURL=messageConfig.js.map

package/types/messageConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"messageConfig.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;"}

package/types/study.d.ts

@@ -1,6 +1,7 @@
 import { Expression } from "survey-engine/data_types";
 import { StudyRules } from "./studyRules";
 import { SurveyDefinition } from "../surveys/types/survey-definition";
+import { MessageConfig } from "./messageConfig";
 export interface Study {
     studyKey: string;
     outputFolderName?: string;
@@ -10,4 +11,5 @@ export interface Study {
         name: string;
         rules: Expression[];
     }>;
+    messageConfigs?: Array<MessageConfig>;
 }