@case-framework/survey-core 0.1.0 → 0.2.0

package/build/index.mjs

@@ -1,4 +1,4 @@
-import { C as ValueReference, D as structuredCloneMethod, E as shuffleIndices, S as ReferenceUsageType, T as generateId, _ as Expression, a as validateLocale, b as FunctionExpressionNames, c as SurveyItemCore, d as deserializeTemplateValues, f as serializeTemplateValue, g as ContextVariableType, h as ContextVariableExpression, i as SurveyTranslations, l as TemplateDefTypes, m as ConstExpression, o as SurveyItemKey, p as serializeTemplateValues, r as SurveyItemTranslations, s as ReservedSurveyItemTypes, t as Survey, u as deserializeTemplateValue, v as ExpressionType, w as ValueReferenceMethod, x as ResponseVariableExpression, y as FunctionExpression } from "./survey-C3ZHI-5z.mjs";
+import { A as ValueReference, C as ContextVariableType, D as FunctionExpressionNames, E as FunctionExpression, F as structuredCloneMethod, M as generateCodingKey, N as generateId, O as ResponseVariableExpression, P as shuffleIndices, S as ContextVariableExpression, T as ExpressionType, _ as deserializeTemplateValue, a as createFullRegistry, b as serializeTemplateValues, c as toItemTypeDefinitionRegistry, d as builtInItemCoreRegistry, f as isBuiltInItemType, g as TemplateDefTypes, h as SurveyItemCore, i as validateLocale, j as ValueReferenceMethod, k as ReferenceUsageType, l as GroupItemCore, m as ReservedSurveyItemTypes, n as SurveyItemTranslations, o as createItemCore, p as SurveyItemKey, r as SurveyTranslations, s as createItemTypeDefinitionRegistry, t as Survey, u as PageBreakItemCore, v as deserializeTemplateValues, w as Expression, x as ConstExpression, y as serializeTemplateValue } from "./survey-DQmpzihl.mjs";
 import { format } from "date-fns";
 import { enUS } from "date-fns/locale";
 
@@ -113,6 +113,9 @@ var SurveyResponse = class SurveyResponse {
 		response.participantId = json.participantId;
 		response.submittedAt = json.submittedAt;
 		response.responses = new Map(json.responses.map((r) => [r.itemId, SurveyItemResponse.deserialize(r)]));
+		response.events = json.events ?? [];
+		response.versionId = json.versionId;
+		response.key = json.key;
 		response.context = json.context;
 		return response;
 	}
@@ -1582,5 +1585,361 @@ const flattenTree = (itemTree) => {
 };
 
 //#endregion
-export { AndExpressionEditor, AttributionType, ConstBooleanEditor, ConstDateArrayEditor, ConstDateEditor, ConstExpression, ConstNumberArrayEditor, ConstNumberEditor, ConstStringArrayEditor, ConstStringEditor, ContentType, ContextVariableExpression, ContextVariableType, CtxCustomExpressionEditor, CtxCustomValueEditor, CtxLocaleEditor, CtxPFlagDateEditor, CtxPFlagIsDefinedEditor, CtxPFlagNumEditor, CtxPFlagStringEditor, DurationUnits, EqExpressionEditor, Expression, ExpressionEditor, ExpressionEvaluator, ExpressionType, FunctionExpression, FunctionExpressionNames, GtExpressionEditor, GteExpressionEditor, InRangeExpressionEditor, LtExpressionEditor, LteExpressionEditor, MaxExpressionEditor, MinExpressionEditor, NumberPrecision, OrExpressionEditor, ReferenceUsageType, ReservedSurveyItemTypes, ResponseItem, ResponseVariableEditor, ResponseVariableExpression, StrEqExpressionEditor, StrListContainsExpressionEditor, SumExpressionEditor, Survey, SurveyEngineCore, SurveyEventTypes, SurveyItemCore, SurveyItemKey, SurveyItemResponse, SurveyItemTranslations, SurveyResponse, SurveyTranslations, TemplateDefTypes, ValueReference, ValueReferenceMethod, ValueType, and, const_boolean, const_date, const_date_array, const_number, const_number_array, const_string, const_string_array, ctx_custom_expression, ctx_custom_value, ctx_locale, ctx_pflag_date, ctx_pflag_is_defined, ctx_pflag_num, ctx_pflag_string, deserializeTemplateValue, deserializeTemplateValues, eq, flattenTree, generateId, gt, gte, in_range, initValueForType, isLegacyItemGroupComponent, isLegacySurveyGroupItem, lt, lte, max, min, or, response_boolean, response_date, response_date_array, response_number, response_number_array, response_string, response_string_array, serializeTemplateValue, serializeTemplateValues, shuffleIndices, str_eq, str_list_contains, structuredCloneMethod, sum, validateLocale };
+//#region src/response-exporter/types.ts
+/** Meta column keys in fixed order (common attributes first). */
+const META_COLUMN_ORDER = [
+	"submittedAt",
+	"participantId",
+	"responseId",
+	"versionId"
+];
+/** Built-in transform modes for slot export. */
+const SlotTransformMode = {
+	default: "default",
+	mask: "mask",
+	dateFormat: "dateFormat"
+};
+/** Source of an export column. */
+const ExportColumnSource = {
+	meta: "meta",
+	context: "context",
+	response: "response"
+};
+
+//#endregion
+//#region src/response-exporter/slot-formatter.ts
+/** Default transform config when no profile override. */
+const DEFAULT_TRANSFORM = { mode: SlotTransformMode.default };
+/**
+* Export a single response slot to a string. Pure function for unit testing.
+* Uses default formatting by ValueType unless overridden by transformConfig.
+*/
+function exportSingleResponseSlot(params) {
+	const { value, valueType, transformConfig } = params;
+	if (value === void 0 || value === null) return "";
+	const mode = transformConfig.mode;
+	if (mode === SlotTransformMode.mask) return maskValue(value, transformConfig.maskChar ?? "***");
+	if (mode === SlotTransformMode.dateFormat && (valueType === ValueType.date || valueType === ValueType.dateArray)) return formatDateValue(value, transformConfig.dateFormat?.pattern ?? "yyyy-MM-dd");
+	return formatDefault(value);
+}
+const BooleanExportValues = {
+	TRUE: "TRUE",
+	FALSE: "FALSE"
+};
+function formatDefault(value) {
+	switch (value.type) {
+		case ValueType.string: return String(value.value);
+		case ValueType.reference: return String(value.value);
+		case ValueType.boolean: return value.value ? BooleanExportValues.TRUE : BooleanExportValues.FALSE;
+		case ValueType.number: return value.precision === NumberPrecision.int ? String(Math.floor(value.value)) : String(value.value);
+		case ValueType.date: return (/* @__PURE__ */ new Date(value.value * 1e3)).toISOString();
+		case ValueType.duration: {
+			const d = value;
+			return `${d.precision === NumberPrecision.int ? Math.floor(d.value) : d.value} ${d.unit}`;
+		}
+		case ValueType.stringArray: return value.value.join("; ");
+		case ValueType.referenceArray: return value.value.join("; ");
+		case ValueType.numberArray: {
+			const arr = value.value;
+			const prec = value.precision;
+			const fmt = (n) => prec === NumberPrecision.int ? Math.floor(n) : n;
+			return arr.map(fmt).join("; ");
+		}
+		case ValueType.dateArray: return value.value.map((ts) => (/* @__PURE__ */ new Date(ts * 1e3)).toISOString()).join("; ");
+		case ValueType.durationArray: {
+			const d = value;
+			const prec = d.precision === NumberPrecision.int;
+			const fmt = (n) => prec ? Math.floor(n) : n;
+			return d.value.map((v) => `${fmt(v)} ${d.unit}`).join("; ");
+		}
+		default: return String(value.value ?? "");
+	}
+}
+function formatDateValue(value, pattern) {
+	if (value.type === ValueType.date) return format(/* @__PURE__ */ new Date(value.value * 1e3), pattern);
+	if (value.type === ValueType.dateArray) return value.value.map((ts) => format(/* @__PURE__ */ new Date(ts * 1e3), pattern)).join("; ");
+	return formatDefault(value);
+}
+function maskValue(value, maskChar) {
+	return valueToString(value) ? maskChar : "";
+}
+function valueToString(value) {
+	switch (value.type) {
+		case ValueType.string:
+		case ValueType.reference: return String(value.value);
+		case ValueType.stringArray:
+		case ValueType.referenceArray: return value.value.join(" ");
+		default: return String(value.value ?? "");
+	}
+}
+
+//#endregion
+//#region src/response-exporter/csv-serializer.ts
+const DEFAULT_OPTIONS = {
+	separator: ",",
+	lineEnding: "\n",
+	includeHeader: true
+};
+/**
+* Escape a cell value for CSV. Quotes the cell when it contains separator, quote, CR, or LF.
+* Doubles embedded quotes. Preserves multiline content inside quoted cells.
+*/
+function escapeCsvCell(value, separator = ",") {
+	if (value === "") return value;
+	if (!(value.includes(separator) || value.includes("\"") || value.includes("\r") || value.includes("\n"))) return value;
+	return `"${value.replace(/"/g, "\"\"")}"`;
+}
+/**
+* Serialize export rows to CSV string.
+*/
+function serializeToCsv(columns, rows, options) {
+	const opts = {
+		...DEFAULT_OPTIONS,
+		...options
+	};
+	const sep = opts.separator;
+	const lines = [];
+	const keys = columns.map((c) => c.key);
+	if (opts.includeHeader) lines.push(keys.map((k) => escapeCsvCell(k, sep)).join(sep));
+	for (const row of rows) {
+		const cells = keys.map((k) => escapeCsvCell(row[k] ?? "", sep));
+		lines.push(cells.join(sep));
+	}
+	return lines.join(opts.lineEnding);
+}
+
+//#endregion
+//#region src/response-exporter/exporter.ts
+const VALUE_REF_SEP$1 = "...";
+function parseValueRef(ref) {
+	const parts = ref.split(VALUE_REF_SEP$1);
+	if (parts.length !== 3 || parts[1] !== ValueReferenceMethod.get) return {
+		itemId: "",
+		slotId: ""
+	};
+	return {
+		itemId: parts[0],
+		slotId: parts[2]
+	};
+}
+function slotOverrideKey(itemId, slotId) {
+	return `${itemId}::${slotId}`;
+}
+function formatMetaValue(response, metaField) {
+	switch (metaField) {
+		case "submittedAt":
+			if (response.submittedAt == null || response.submittedAt === 0) return "";
+			return format(/* @__PURE__ */ new Date(response.submittedAt * 1e3), "yyyy-MM-dd'T'HH:mm:ss.SSSxxx");
+		case "participantId": return response.participantId ?? "";
+		case "responseId": return response.key;
+		case "versionId": return response.versionId;
+		default: return "";
+	}
+}
+var SurveyResponseExporter = class {
+	versions = /* @__PURE__ */ new Map();
+	constructor(versionBindings, profiles = []) {
+		this.profiles = profiles;
+		for (const vb of versionBindings) this.versions.set(vb.versionId, vb);
+	}
+	getSurveyForVersion(versionId) {
+		return this.versions.get(versionId);
+	}
+	/**
+	* Compute response-only columns from survey definition.
+	*/
+	computeResponseColumns(versionId) {
+		const binding = this.versions.get(versionId);
+		if (!binding) return [];
+		const survey = binding.survey;
+		const slots = survey.getAvailableResponseValueSlots();
+		const keyIndex = survey.keyIndex;
+		const keyByItemId = new Map(keyIndex.map((r) => [r.itemId, r]));
+		const profile = this.resolveProfileForVersion(versionId);
+		const columns = [];
+		for (const [valueRef, valueType] of Object.entries(slots)) {
+			const { itemId, slotId } = parseValueRef(valueRef);
+			if (!itemId || !slotId) continue;
+			if (valueRef.includes(`${VALUE_REF_SEP$1}${ValueReferenceMethod.isDefined}`)) continue;
+			const keyInfo = keyByItemId.get(itemId);
+			const defaultExportKey = `${keyInfo ? [...keyInfo.keyPath, keyInfo.key].join(".") : itemId}__${slotId}`;
+			const exportKey = (profile?.slotOverrides?.[slotOverrideKey(itemId, slotId)])?.exportKey ?? defaultExportKey;
+			columns.push({
+				key: exportKey,
+				source: ExportColumnSource.response,
+				itemId,
+				slotId,
+				valueType
+			});
+		}
+		return columns;
+	}
+	/**
+	* Compute full export columns: meta first, then context (from responses), then response columns.
+	* Column order: meta (fixed) -> context (profile order or alphabetical) -> response (profile order + alphabetical).
+	*/
+	computeColumns(versionId, responses, versionIds) {
+		const vids = versionIds ?? [versionId];
+		const responseCols = [];
+		const seen = /* @__PURE__ */ new Set();
+		for (const vid of vids) for (const c of this.computeResponseColumns(vid)) if (!seen.has(c.key)) {
+			seen.add(c.key);
+			responseCols.push(c);
+		}
+		const profile = this.resolveProfileForVersion(versionId);
+		const metaColumns = META_COLUMN_ORDER.map((metaField) => ({
+			key: metaField,
+			source: ExportColumnSource.meta,
+			metaField
+		}));
+		const contextKeys = /* @__PURE__ */ new Set();
+		for (const r of responses ?? []) if (r.context) for (const k of Object.keys(r.context)) contextKeys.add(k);
+		const contextOrder = profile?.contextColumnOrder;
+		const contextCols = Array.from(contextKeys).sort(contextOrder ? (a, b) => {
+			const ia = contextOrder.indexOf(a);
+			const ib = contextOrder.indexOf(b);
+			if (ia >= 0 && ib >= 0) return ia - ib;
+			if (ia >= 0) return -1;
+			if (ib >= 0) return 1;
+			return a.localeCompare(b);
+		} : void 0).map((contextKey) => ({
+			key: `context.${contextKey}`,
+			source: ExportColumnSource.context,
+			contextKey
+		}));
+		const respOrder = profile?.responseColumnOrder ?? [];
+		const byOrder = respOrder.filter((k) => responseCols.some((c) => c.key === k)).map((k) => responseCols.find((c) => c.key === k));
+		const remaining = responseCols.filter((c) => !respOrder.includes(c.key)).sort((a, b) => a.key.localeCompare(b.key));
+		const respCols = [...byOrder, ...remaining];
+		return [
+			...metaColumns,
+			...contextCols,
+			...respCols
+		];
+	}
+	resolveProfileForVersion(versionId) {
+		return this.profiles.find((p) => !p.versionId || p.versionId === versionId);
+	}
+	getTransformConfig(versionId, itemId, slotId) {
+		return this.resolveProfileForVersion(versionId)?.slotOverrides?.[slotOverrideKey(itemId, slotId)] ?? DEFAULT_TRANSFORM;
+	}
+	getContextTransformConfig(versionId, contextKey) {
+		return this.resolveProfileForVersion(versionId)?.contextOverrides?.[contextKey] ?? DEFAULT_TRANSFORM;
+	}
+	exportResponse(response) {
+		if (!this.versions.get(response.versionId)) return null;
+		const columns = this.computeColumns(response.versionId, [response]);
+		const row = {};
+		for (const col of columns) {
+			if (col.source === ExportColumnSource.meta && col.metaField) {
+				row[col.key] = formatMetaValue(response, col.metaField);
+				continue;
+			}
+			if (col.source === ExportColumnSource.context && col.contextKey) {
+				const value = response.context?.[col.contextKey];
+				const transformConfig = this.getContextTransformConfig(response.versionId, col.contextKey);
+				const valueType = value?.type ?? ValueType.string;
+				row[col.key] = exportSingleResponseSlot({
+					value,
+					valueType,
+					transformConfig
+				});
+				continue;
+			}
+			if (col.source === ExportColumnSource.response && col.itemId != null && col.slotId != null && col.valueType != null) {
+				const value = response.responses.get(col.itemId)?.response?.get(col.slotId);
+				const transformConfig = this.getTransformConfig(response.versionId, col.itemId, col.slotId);
+				row[col.key] = exportSingleResponseSlot({
+					value,
+					valueType: col.valueType,
+					transformConfig
+				});
+			}
+		}
+		return row;
+	}
+	/**
+	* Compute columns for a batch of responses (union of response columns across versions).
+	*/
+	computeColumnsForBatch(responses) {
+		if (responses.length === 0) return [];
+		const versionIds = [...new Set(responses.map((r) => r.versionId))];
+		const primaryVersionId = versionIds[0];
+		return this.computeColumns(primaryVersionId, responses, versionIds);
+	}
+	exportResponsesToCsv(responses, options) {
+		if (responses.length === 0) return "";
+		return serializeToCsv(this.computeColumnsForBatch(responses), responses.map((r) => this.exportResponse(r)).filter((r) => r !== null), options);
+	}
+};
+
+//#endregion
+//#region src/response-exporter/codebook.ts
+const VALUE_REF_SEP = "...";
+/**
+* Extract plain text from Content for codebook display.
+*/
+function contentToPlainText(c) {
+	if (!c) return "";
+	return c.content ?? "";
+}
+/**
+* Generate a structured codebook from a survey definition.
+*/
+function generateCodebook(survey, options) {
+	const locales = options?.locales ?? survey.locales;
+	const keyIndex = survey.keyIndex;
+	const keyByItemId = new Map(keyIndex.map((r) => [r.itemId, r]));
+	const slots = survey.getAvailableResponseValueSlots();
+	const valueRefToSlots = /* @__PURE__ */ new Map();
+	for (const [valueRef, valueType] of Object.entries(slots)) {
+		const parts = valueRef.split(VALUE_REF_SEP);
+		if (parts.length !== 3 || parts[1] !== ValueReferenceMethod.get) continue;
+		const itemId = parts[0];
+		const slotId = parts[2];
+		const list = valueRefToSlots.get(itemId) ?? [];
+		if (!list.some((s) => s.slotId === slotId)) list.push({
+			slotId,
+			valueType
+		});
+		valueRefToSlots.set(itemId, list);
+	}
+	const items = [];
+	for (const item of survey.surveyItems.values()) {
+		const keyInfo = keyByItemId.get(item.id);
+		const key = keyInfo?.key ?? item.id;
+		const keyPath = keyInfo?.keyPath ?? [];
+		const slotList = valueRefToSlots.get(item.id) ?? [];
+		slotList.sort((a, b) => a.slotId.localeCompare(b.slotId));
+		let contentByLocale;
+		if (locales.length > 0) {
+			contentByLocale = {};
+			const itemTranslations = survey.getItemTranslations(item.id);
+			if (itemTranslations) for (const locale of locales) {
+				const all = itemTranslations.getAllForLocale(locale);
+				if (all) {
+					const flat = {};
+					for (const [contentKey, content] of Object.entries(all)) flat[contentKey] = contentToPlainText(content);
+					contentByLocale[locale] = flat;
+				}
+			}
+		}
+		items.push({
+			id: item.id,
+			key,
+			keyPath,
+			type: item.type,
+			interactive: item.isInteractive(),
+			slots: slotList,
+			contentByLocale
+		});
+	}
+	return {
+		surveyKey: survey.surveyKey,
+		items: items.sort((a, b) => a.key.localeCompare(b.key))
+	};
+}
+
+//#endregion
+export { AndExpressionEditor, AttributionType, ConstBooleanEditor, ConstDateArrayEditor, ConstDateEditor, ConstExpression, ConstNumberArrayEditor, ConstNumberEditor, ConstStringArrayEditor, ConstStringEditor, ContentType, ContextVariableExpression, ContextVariableType, CtxCustomExpressionEditor, CtxCustomValueEditor, CtxLocaleEditor, CtxPFlagDateEditor, CtxPFlagIsDefinedEditor, CtxPFlagNumEditor, CtxPFlagStringEditor, DEFAULT_TRANSFORM, DurationUnits, EqExpressionEditor, Expression, ExpressionEditor, ExpressionEvaluator, ExpressionType, FunctionExpression, FunctionExpressionNames, GroupItemCore, GtExpressionEditor, GteExpressionEditor, InRangeExpressionEditor, LtExpressionEditor, LteExpressionEditor, META_COLUMN_ORDER, MaxExpressionEditor, MinExpressionEditor, NumberPrecision, OrExpressionEditor, PageBreakItemCore, ReferenceUsageType, ReservedSurveyItemTypes, ResponseItem, ResponseVariableEditor, ResponseVariableExpression, SlotTransformMode, StrEqExpressionEditor, StrListContainsExpressionEditor, SumExpressionEditor, Survey, SurveyEngineCore, SurveyEventTypes, SurveyItemCore, SurveyItemKey, SurveyItemResponse, SurveyItemTranslations, SurveyResponse, SurveyResponseExporter, SurveyTranslations, TemplateDefTypes, ValueReference, ValueReferenceMethod, ValueType, and, builtInItemCoreRegistry, const_boolean, const_date, const_date_array, const_number, const_number_array, const_string, const_string_array, createFullRegistry, createItemCore, createItemTypeDefinitionRegistry, ctx_custom_expression, ctx_custom_value, ctx_locale, ctx_pflag_date, ctx_pflag_is_defined, ctx_pflag_num, ctx_pflag_string, deserializeTemplateValue, deserializeTemplateValues, eq, escapeCsvCell, exportSingleResponseSlot, flattenTree, generateCodebook, generateCodingKey, generateId, gt, gte, in_range, initValueForType, isBuiltInItemType, isLegacyItemGroupComponent, isLegacySurveyGroupItem, lt, lte, max, min, or, response_boolean, response_date, response_date_array, response_number, response_number_array, response_string, response_string_array, serializeTemplateValue, serializeTemplateValues, serializeToCsv, shuffleIndices, str_eq, str_list_contains, structuredCloneMethod, sum, toItemTypeDefinitionRegistry, validateLocale };
 //# sourceMappingURL=index.mjs.map