@case-framework/survey-core 0.2.0 → 0.3.0

package/build/index.mjs

@@ -1,7 +1,6 @@
-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 { A as FunctionExpressionNames, C as serializeTemplateValues, D as Expression, E as ContextVariableType, F as generateCodingKey, I as generateId, L as shuffleIndices, M as ReferenceUsageType, N as ValueReference, O as ExpressionType, P as ValueReferenceMethod, R as structuredCloneMethod, S as serializeTemplateValue, T as ContextVariableExpression, _ as NumberPrecision, a as createFullRegistry, b as deserializeTemplateValue, c as toItemTypeDefinitionRegistry, d as builtInItemCoreRegistry, f as isBuiltInItemType, g as DurationUnits, h as SurveyItemCore, i as validateLocale, j as ResponseVariableExpression, k as FunctionExpression, 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 ValueType, w as ConstExpression, x as deserializeTemplateValues, y as TemplateDefTypes } from "./survey-DJbgFVPz.mjs";
 import { format } from "date-fns";
 import { enUS } from "date-fns/locale";
-
 //#region src/to_mirgrate/data_types/legacy-types.ts
 const isLegacyItemGroupComponent = (item) => {
 	const items = item.items;
@@ -11,7 +10,6 @@ const isLegacySurveyGroupItem = (item) => {
 	const items = item.items;
 	return items !== void 0 && items.length > 0;
 };
-
 //#endregion
 //#region src/survey/responses/item-response.ts
 /**
@@ -66,7 +64,6 @@ var ResponseItem = class ResponseItem {
 		return new ResponseItem(json.slotValues);
 	}
 };
-
 //#endregion
 //#region src/survey/responses/response-meta.ts
 const SurveyEventTypes = {
@@ -75,7 +72,6 @@ const SurveyEventTypes = {
 	responeChanged: "responeChanged",
 	languageChanged: "languageChanged"
 };
-
 //#endregion
 //#region src/survey/responses/survey-response.ts
 /**
@@ -120,36 +116,6 @@ var SurveyResponse = class SurveyResponse {
 		return response;
 	}
 };
-
-//#endregion
-//#region src/survey/responses/value-types.ts
-const ValueType = {
-	string: "string",
-	duration: "duration",
-	reference: "reference",
-	number: "number",
-	boolean: "boolean",
-	date: "date",
-	stringArray: "string[]",
-	durationArray: "duration[]",
-	referenceArray: "reference[]",
-	numberArray: "number[]",
-	dateArray: "date[]"
-};
-const DurationUnits = {
-	seconds: "seconds",
-	minutes: "minutes",
-	hours: "hours",
-	days: "days",
-	weeks: "weeks",
-	months: "months",
-	years: "years"
-};
-const NumberPrecision = {
-	int: "int",
-	float: "float"
-};
-
 //#endregion
 //#region src/survey/responses/utils.ts
 const initValueForType = (returnType) => {
@@ -203,7 +169,6 @@ const initValueForType = (returnType) => {
 		default: throw new Error("Invalid return type: " + returnType);
 	}
 };
-
 //#endregion
 //#region src/expressions/expression-evaluator.ts
 var ExpressionEvaluator = class {
@@ -533,7 +498,6 @@ var ExpressionEvaluator = class {
 		});
 	}
 };
-
 //#endregion
 //#region src/expressions/editors/expression-editor.ts
 var ExpressionEditor = class {
@@ -1056,7 +1020,6 @@ var MaxExpressionEditor = class extends GroupExpressionEditor {
 		return new FunctionExpression(FunctionExpressionNames.max, this.args.map((arg) => arg.getExpression()), this._editorConfig);
 	}
 };
-
 //#endregion
 //#region src/expressions/editors/expression-editor-generators.ts
 const const_string_array = (...values) => {
@@ -1161,7 +1124,6 @@ const min = (...args) => {
 const max = (...args) => {
 	return new MaxExpressionEditor(args);
 };
-
 //#endregion
 //#region src/survey/utils/content.ts
 let ContentType = /* @__PURE__ */ function(ContentType) {
@@ -1174,7 +1136,6 @@ let AttributionType = /* @__PURE__ */ function(AttributionType) {
 	AttributionType["template"] = "template";
 	return AttributionType;
 }({});
-
 //#endregion
 //#region src/engine/engine.ts
 var SurveyEngineCore = class {
@@ -1583,7 +1544,6 @@ const flattenTree = (itemTree) => {
 	});
 	return flatTree;
 };
-
 //#endregion
 //#region src/response-exporter/types.ts
 /** Meta column keys in fixed order (common attributes first). */
@@ -1599,13 +1559,14 @@ const SlotTransformMode = {
 	mask: "mask",
 	dateFormat: "dateFormat"
 };
+/** Separator between item key path and slot coding path in default export headers. */
+const EXPORT_COLUMN_SLOT_SEPARATOR = "__";
 /** 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. */
@@ -1672,7 +1633,6 @@ function valueToString(value) {
 		default: return String(value.value ?? "");
 	}
 }
-
 //#endregion
 //#region src/response-exporter/csv-serializer.ts
 const DEFAULT_OPTIONS = {
@@ -1699,32 +1659,28 @@ function serializeToCsv(columns, rows, 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));
+	const headers = columns.map((c) => c.header);
+	if (opts.includeHeader) lines.push(headers.map((header) => escapeCsvCell(header, sep)).join(sep));
 	for (const row of rows) {
-		const cells = keys.map((k) => escapeCsvCell(row[k] ?? "", sep));
+		const cells = headers.map((header) => escapeCsvCell(row[header] ?? "", 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 responseColumnId(itemId, slotId) {
+	return `${itemId}::${slotId}`;
+}
+function metaColumnId(metaField) {
+	return `meta:${metaField}`;
+}
+function contextColumnId(contextKey) {
+	return `context:${contextKey}`;
+}
 function formatMetaValue(response, metaField) {
 	switch (metaField) {
 		case "submittedAt":
@@ -1752,25 +1708,27 @@ var SurveyResponseExporter = class {
 		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;
+		for (const { itemId, slots } of survey.getResponseSlotDefinitions()) {
 			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
-			});
+			const itemBaseKey = keyInfo ? [...keyInfo.keyPath, keyInfo.key].join(".") : itemId;
+			for (const slot of slots) {
+				const columnId = responseColumnId(itemId, slot.slotId);
+				const codingPath = [...slot.keyPath, slot.key].filter((part) => part.trim().length > 0);
+				const defaultHeader = codingPath.length > 0 ? `${itemBaseKey}__${codingPath.join(".")}` : `${itemBaseKey}__${slot.slotId}`;
+				const header = this.resolveColumnHeader(profile, columnId, defaultHeader);
+				columns.push({
+					id: columnId,
+					header,
+					source: ExportColumnSource.response,
+					itemId,
+					slotId: slot.slotId,
+					valueType: slot.valueType
+				});
+			}
 		}
 		return columns;
 	}
@@ -1782,13 +1740,14 @@ var SurveyResponseExporter = class {
 		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);
+		for (const vid of vids) for (const c of this.computeResponseColumns(vid)) if (!seen.has(c.id)) {
+			seen.add(c.id);
 			responseCols.push(c);
 		}
 		const profile = this.resolveProfileForVersion(versionId);
 		const metaColumns = META_COLUMN_ORDER.map((metaField) => ({
-			key: metaField,
+			id: metaColumnId(metaField),
+			header: this.resolveColumnHeader(profile, metaColumnId(metaField), metaField),
 			source: ExportColumnSource.meta,
 			metaField
 		}));
@@ -1803,23 +1762,38 @@ var SurveyResponseExporter = class {
 			if (ib >= 0) return 1;
 			return a.localeCompare(b);
 		} : void 0).map((contextKey) => ({
-			key: `context.${contextKey}`,
+			id: contextColumnId(contextKey),
+			header: this.resolveColumnHeader(profile, contextColumnId(contextKey), `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 byOrder = respOrder.filter((id) => responseCols.some((c) => c.id === id)).map((id) => responseCols.find((c) => c.id === id));
+		const remaining = responseCols.filter((c) => !respOrder.includes(c.id)).sort((a, b) => a.header.localeCompare(b.header));
 		const respCols = [...byOrder, ...remaining];
-		return [
+		const columns = [
 			...metaColumns,
 			...contextCols,
 			...respCols
 		];
+		this.assertUniqueHeaders(columns);
+		return columns;
 	}
 	resolveProfileForVersion(versionId) {
 		return this.profiles.find((p) => !p.versionId || p.versionId === versionId);
 	}
+	resolveColumnHeader(profile, columnId, defaultHeader) {
+		const override = profile?.columnHeaders?.[columnId]?.trim();
+		return override && override.length > 0 ? override : defaultHeader;
+	}
+	assertUniqueHeaders(columns) {
+		const seen = /* @__PURE__ */ new Map();
+		for (const column of columns) {
+			const existingId = seen.get(column.header);
+			if (existingId && existingId !== column.id) throw new Error(`Duplicate export column header '${column.header}' for columns '${existingId}' and '${column.id}'`);
+			seen.set(column.header, column.id);
+		}
+	}
 	getTransformConfig(versionId, itemId, slotId) {
 		return this.resolveProfileForVersion(versionId)?.slotOverrides?.[slotOverrideKey(itemId, slotId)] ?? DEFAULT_TRANSFORM;
 	}
@@ -1832,14 +1806,14 @@ var SurveyResponseExporter = class {
 		const row = {};
 		for (const col of columns) {
 			if (col.source === ExportColumnSource.meta && col.metaField) {
-				row[col.key] = formatMetaValue(response, col.metaField);
+				row[col.header] = 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({
+				row[col.header] = exportSingleResponseSlot({
 					value,
 					valueType,
 					transformConfig
@@ -1849,7 +1823,7 @@ var SurveyResponseExporter = class {
 			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({
+				row[col.header] = exportSingleResponseSlot({
 					value,
 					valueType: col.valueType,
 					transformConfig
@@ -1872,10 +1846,8 @@ var SurveyResponseExporter = class {
 		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.
 */
@@ -1890,26 +1862,18 @@ 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 slotDefsByItemId = new Map(survey.getResponseSlotDefinitions().map(({ itemId, slots }) => [itemId, slots.map((slot) => ({
+		slotId: slot.slotId,
+		key: slot.key,
+		keyPath: [...slot.keyPath],
+		valueType: slot.valueType
+	}))]));
 	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) ?? [];
+		const slotList = slotDefsByItemId.get(item.id) ?? [];
 		slotList.sort((a, b) => a.slotId.localeCompare(b.slotId));
 		let contentByLocale;
 		if (locales.length > 0) {
@@ -1939,7 +1903,7 @@ function generateCodebook(survey, options) {
 		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 };
+export { AndExpressionEditor, AttributionType, ConstBooleanEditor, ConstDateArrayEditor, ConstDateEditor, ConstExpression, ConstNumberArrayEditor, ConstNumberEditor, ConstStringArrayEditor, ConstStringEditor, ContentType, ContextVariableExpression, ContextVariableType, CtxCustomExpressionEditor, CtxCustomValueEditor, CtxLocaleEditor, CtxPFlagDateEditor, CtxPFlagIsDefinedEditor, CtxPFlagNumEditor, CtxPFlagStringEditor, DEFAULT_TRANSFORM, DurationUnits, EXPORT_COLUMN_SLOT_SEPARATOR, 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