@case-framework/survey-core 0.1.0 → 0.3.0

package/build/{package.json/package.json → package.json}

@@ -1,6 +1,6 @@
 {
   "name": "@case-framework/survey-core",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Implementation of the survey core to use in typescript/javascript projects.",
   "type": "module",
   "files": [
@@ -18,14 +18,14 @@
   "author": "phev8",
   "license": "ISC",
   "devDependencies": {
-    "@eslint/js": "^9.39.2",
+    "@eslint/js": "^9.39.4",
     "@types/jest": "^30.0.0",
-    "eslint": "^9.39.2",
-    "jest": "^30.0.2",
+    "eslint": "^9.39.4",
+    "jest": "^30.3.0",
     "ts-jest": "^29.4.6",
-    "tsdown": "^0.20.1",
+    "tsdown": "^0.21.4",
     "typescript": "^5.8.3",
-    "typescript-eslint": "^8.54.0"
+    "typescript-eslint": "^8.57.1"
   },
   "dependencies": {
     "date-fns": "^4.1.0"

package/build/{survey-C3ZHI-5z.mjs → survey-DJbgFVPz.mjs}

@@ -31,7 +31,19 @@ function generateId() {
 	for (let i = 0; i < length; i++) randomPart += ALPHABET.charAt(Math.floor(Math.random() * base));
 	return randomPart + encodedTimestamp;
 }
-
+/** Alphanumeric chars without ambiguous ones (0/O, 1/I) for human-readable coding keys. */
+const CODING_KEY_ALPHABET = "23456789ABCDEFGHJKLMNPQRSTUVWXYZ";
+/**
+* Generates a short random coding key suitable for item keys in exports/codebooks.
+* @param length - Key length (default 4)
+* @returns A random string of the specified length.
+*/
+function generateCodingKey(length = 4) {
+	const base = 32;
+	let key = "";
+	for (let i = 0; i < length; i++) key += CODING_KEY_ALPHABET.charAt(Math.floor(Math.random() * base));
+	return key;
+}
 //#endregion
 //#region src/survey/utils/value-reference.ts
 const SEPARATOR = "...";
@@ -77,7 +89,6 @@ let ReferenceUsageType = /* @__PURE__ */ function(ReferenceUsageType) {
 	ReferenceUsageType["disabledConditions"] = "disabledConditions";
 	return ReferenceUsageType;
 }({});
-
 //#endregion
 //#region src/expressions/expression.ts
 const ExpressionType = {
@@ -247,7 +258,6 @@ var FunctionExpression = class FunctionExpression extends Expression {
 		};
 	}
 };
-
 //#endregion
 //#region src/expressions/template-value.ts
 let TemplateDefTypes = /* @__PURE__ */ function(TemplateDefTypes) {
@@ -280,7 +290,34 @@ const deserializeTemplateValue = (json) => {
 const deserializeTemplateValues = (json) => {
 	return new Map(Object.entries(json).map(([key, value]) => [key, deserializeTemplateValue(value)]));
 };
-
+//#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/items/utils.ts
 const displayConditionsFromJson = (json) => {
@@ -292,7 +329,6 @@ const displayConditionsFromJson = (json) => {
 const disabledConditionsFromJson = (json) => {
 	return { components: json.components ? Object.fromEntries(Object.entries(json.components).map(([key, value]) => [key, Expression.deserialize(value)])) : void 0 };
 };
-
 //#endregion
 //#region src/survey/items/survey-item.ts
 /**
@@ -316,9 +352,31 @@ var SurveyItemCore = class {
 		this.key = this._rawItem.key;
 		this.config = this.parseConfig(this._rawItem.config);
 	}
+	getAdditionalResponseValueSlots() {
+		return {};
+	}
+	getAvailableResponseValueSlots(byType) {
+		const valueRefs = {};
+		for (const slot of this.getResponseSlotDefinitions()) {
+			valueRefs[`${this.id}...${ValueReferenceMethod.get}...${slot.slotId}`] = slot.valueType;
+			valueRefs[`${this.id}...${ValueReferenceMethod.isDefined}...${slot.slotId}`] = ValueType.boolean;
+		}
+		Object.assign(valueRefs, this.getAdditionalResponseValueSlots());
+		if (!byType) return valueRefs;
+		return Object.fromEntries(Object.entries(valueRefs).filter(([, valueType]) => valueType === byType));
+	}
 	get rawItem() {
 		return this._rawItem;
 	}
+	get metadata() {
+		return this._rawItem.metadata ?? {};
+	}
+	set metadata(metadata) {
+		this.updateRawItem({
+			...this._rawItem,
+			metadata
+		});
+	}
 	updateRawItem(rawItem) {
 		if (rawItem.id !== this.id) throw new Error("Cannot update raw item with a different id");
 		this._rawItem = rawItem;
@@ -362,7 +420,6 @@ var SurveyItemCore = class {
 		return usages;
 	}
 };
-
 //#endregion
 //#region src/survey/items/types.ts
 let ReservedSurveyItemTypes = /* @__PURE__ */ function(ReservedSurveyItemTypes) {
@@ -370,7 +427,6 @@ let ReservedSurveyItemTypes = /* @__PURE__ */ function(ReservedSurveyItemTypes)
 	ReservedSurveyItemTypes["PageBreak"] = "page-break";
 	return ReservedSurveyItemTypes;
 }({});
-
 //#endregion
 //#region src/survey/item-key.ts
 /**
@@ -407,11 +463,210 @@ var SurveyItemKey = class {
 		this._keySeparator = keySeparator;
 	}
 };
-
+//#endregion
+//#region src/survey/utils/group-utils.ts
+/**
+* Shared utilities for array operations.
+*/
+/**
+* Swap two elements in an array by index.
+* @returns A new array with the elements swapped
+*/
+function swapArrayElements(arr, fromIndex, toIndex) {
+	const result = [...arr];
+	[result[fromIndex], result[toIndex]] = [result[toIndex], result[fromIndex]];
+	return result;
+}
+/**
+* Move an element from one index to another.
+* @returns A new array with the element moved
+*/
+function moveArrayElement(arr, fromIndex, toIndex) {
+	const result = [...arr];
+	const [moved] = result.splice(fromIndex, 1);
+	result.splice(toIndex, 0, moved);
+	return result;
+}
+//#endregion
+//#region src/survey/registry/built-in-items.ts
+var GroupItemCore = class extends SurveyItemCore {
+	type = ReservedSurveyItemTypes.Group;
+	parseConfig(rawConfig) {
+		const cfg = rawConfig ?? {};
+		return {
+			items: cfg.items,
+			shuffleItems: cfg.shuffleItems,
+			isRoot: cfg.isRoot
+		};
+	}
+	serializeConfig() {
+		return this.config;
+	}
+	isInteractive() {
+		return false;
+	}
+	getResponseSlotDefinitions() {
+		return [];
+	}
+	isRoot() {
+		return this.config.isRoot ?? false;
+	}
+	get items() {
+		return this.config.items ?? [];
+	}
+	/**
+	* Add a child item id to this group at the given index.
+	* @param itemId The id of the item to add to this group.
+	* @param index The index at which to add the item. If not provided, the item is added to the end of the group.
+	*/
+	addChild(itemId, index) {
+		const items = this.config.items ??= [];
+		const insertIndex = index !== void 0 ? Math.min(index, items.length) : items.length;
+		items.splice(insertIndex, 0, itemId);
+		this.updateRawItem({
+			...this.rawItem,
+			config: { ...this.config }
+		});
+	}
+	/**
+	* Remove a child item id from this group.
+	* @param itemId The id of the item to remove from this group.
+	*/
+	removeChild(itemId) {
+		const items = this.config.items ??= [];
+		const index = items.indexOf(itemId);
+		if (index !== -1) {
+			items.splice(index, 1);
+			this.updateRawItem({
+				...this.rawItem,
+				config: { ...this.config }
+			});
+		}
+	}
+	/**
+	* Check if an item is a direct child of this group.
+	*/
+	hasChild(itemId) {
+		return this.items.includes(itemId);
+	}
+	/** Whether items in this group should be shuffled. */
+	get shuffleItems() {
+		return this.config.shuffleItems ?? false;
+	}
+	set shuffleItems(value) {
+		this.config.shuffleItems = value;
+		this.updateRawItem({
+			...this.rawItem,
+			config: { ...this.config }
+		});
+	}
+	/**
+	* Get the ordered list of child item ids.
+	*/
+	getChildrenIds() {
+		return [...this.items];
+	}
+	/**
+	* Swap two items by their positions in the group.
+	* @throws Error if indices are out of bounds
+	*/
+	swapItemsByIndex(from, to) {
+		const items = this.items;
+		if (from < 0 || from >= items.length || to < 0 || to >= items.length) throw new Error(`Index out of bounds. Valid range is 0-${items.length - 1}`);
+		if (from === to) return;
+		this.config.items = swapArrayElements(items, from, to);
+		this.updateRawItem({
+			...this.rawItem,
+			config: { ...this.config }
+		});
+	}
+	/**
+	* Swap two items by their ids.
+	* @throws Error if either id is not found in this group
+	*/
+	swapItemsById(id, withId) {
+		const items = this.items;
+		const index1 = items.indexOf(id);
+		const index2 = items.indexOf(withId);
+		if (index1 === -1) throw new Error(`Item '${id}' not found in group '${this.key}'`);
+		if (index2 === -1) throw new Error(`Item '${withId}' not found in group '${this.key}'`);
+		this.swapItemsByIndex(index1, index2);
+	}
+	/**
+	* Move an item by id to a specific index.
+	* @throws Error if the item is not found or index is out of bounds
+	*/
+	moveItemToIndex(id, index) {
+		const items = this.items;
+		const fromIndex = items.indexOf(id);
+		if (fromIndex === -1) throw new Error(`Item '${id}' not found in group '${this.key}'`);
+		if (index < 0 || index >= items.length) throw new Error(`Index out of bounds. Valid range is 0-${items.length - 1}`);
+		if (fromIndex === index) return;
+		this.config.items = moveArrayElement(items, fromIndex, index);
+		this.updateRawItem({
+			...this.rawItem,
+			config: { ...this.config }
+		});
+	}
+};
+var PageBreakItemCore = class extends SurveyItemCore {
+	type = ReservedSurveyItemTypes.PageBreak;
+	parseConfig(_rawConfig) {
+		return {};
+	}
+	serializeConfig() {}
+	isInteractive() {
+		return false;
+	}
+	getResponseSlotDefinitions() {
+		return [];
+	}
+};
+const builtInItemCoreRegistry = {
+	[ReservedSurveyItemTypes.Group]: GroupItemCore,
+	[ReservedSurveyItemTypes.PageBreak]: PageBreakItemCore
+};
+const isBuiltInItemType = (itemType) => itemType in builtInItemCoreRegistry;
+//#endregion
+//#region src/survey/registry/item-registry.ts
+/** Convert constructor registry to explicit definitions for higher-layer composition. */
+function toItemTypeDefinitionRegistry(registry) {
+	return Object.fromEntries(Object.entries(registry).map(([itemType, constructor]) => [itemType, {
+		itemType,
+		constructor
+	}]));
+}
+/**
+* Creates a handler instance for a raw survey item.
+* Uses built-in registry for group/page-break, otherwise the provided plugin registry.
+*/
+function createItemCore(rawItem, pluginRegistry) {
+	if (isBuiltInItemType(rawItem.itemType)) {
+		const HandlerClass = builtInItemCoreRegistry[rawItem.itemType];
+		return new HandlerClass(rawItem);
+	}
+	if (pluginRegistry && rawItem.itemType in pluginRegistry) {
+		const HandlerClass = pluginRegistry[rawItem.itemType];
+		return new HandlerClass(rawItem);
+	}
+	throw new Error(`Unknown item type: ${rawItem.itemType}`);
+}
+/**
+* Merge built-in handlers with plugin registry for a complete registry.
+*/
+function createFullRegistry(pluginRegistry) {
+	return {
+		...builtInItemCoreRegistry,
+		...pluginRegistry
+	};
+}
+/** Build full registry as explicit definitions for editor/ui composition. */
+function createItemTypeDefinitionRegistry(pluginRegistry) {
+	return toItemTypeDefinitionRegistry(createFullRegistry(pluginRegistry));
+}
 //#endregion
 //#region src/survey/survey-file-schema.ts
 const CURRENT_SURVEY_SCHEMA = "https://github.com/case-framework/case-survey-toolkit/packages/survey-core/schemas/survey-schema.json";
-
 //#endregion
 //#region src/survey/utils/translations.ts
 const validateLocale = (locale) => {
@@ -588,191 +843,6 @@ var SurveyTranslations = class {
 		for (const locale of this.locales) delete this._translations[locale].itemTranslations?.[id];
 	}
 };
-
-//#endregion
-//#region src/survey/utils/group-utils.ts
-/**
-* Shared utilities for array operations.
-*/
-/**
-* Swap two elements in an array by index.
-* @returns A new array with the elements swapped
-*/
-function swapArrayElements(arr, fromIndex, toIndex) {
-	const result = [...arr];
-	[result[fromIndex], result[toIndex]] = [result[toIndex], result[fromIndex]];
-	return result;
-}
-/**
-* Move an element from one index to another.
-* @returns A new array with the element moved
-*/
-function moveArrayElement(arr, fromIndex, toIndex) {
-	const result = [...arr];
-	const [moved] = result.splice(fromIndex, 1);
-	result.splice(toIndex, 0, moved);
-	return result;
-}
-
-//#endregion
-//#region src/survey/registry/built-in-items.ts
-var GroupItemCore = class extends SurveyItemCore {
-	type = ReservedSurveyItemTypes.Group;
-	parseConfig(rawConfig) {
-		const cfg = rawConfig ?? {};
-		return {
-			items: cfg.items,
-			shuffleItems: cfg.shuffleItems,
-			isRoot: cfg.isRoot
-		};
-	}
-	serializeConfig() {
-		return this.config;
-	}
-	isInteractive() {
-		return false;
-	}
-	getAvailableResponseValueSlots() {
-		return {};
-	}
-	isRoot() {
-		return this.config.isRoot ?? false;
-	}
-	get items() {
-		return this.config.items ?? [];
-	}
-	/**
-	* Add a child item id to this group at the given index.
-	* @param itemId The id of the item to add to this group.
-	* @param index The index at which to add the item. If not provided, the item is added to the end of the group.
-	*/
-	addChild(itemId, index) {
-		const items = this.config.items ??= [];
-		const insertIndex = index !== void 0 ? Math.min(index, items.length) : items.length;
-		items.splice(insertIndex, 0, itemId);
-		this.updateRawItem({
-			...this.rawItem,
-			config: { ...this.config }
-		});
-	}
-	/**
-	* Remove a child item id from this group.
-	* @param itemId The id of the item to remove from this group.
-	*/
-	removeChild(itemId) {
-		const items = this.config.items ??= [];
-		const index = items.indexOf(itemId);
-		if (index !== -1) {
-			items.splice(index, 1);
-			this.updateRawItem({
-				...this.rawItem,
-				config: { ...this.config }
-			});
-		}
-	}
-	/**
-	* Check if an item is a direct child of this group.
-	*/
-	hasChild(itemId) {
-		return this.items.includes(itemId);
-	}
-	/** Whether items in this group should be shuffled. */
-	get shuffleItems() {
-		return this.config.shuffleItems ?? false;
-	}
-	set shuffleItems(value) {
-		this.config.shuffleItems = value;
-		this.updateRawItem({
-			...this.rawItem,
-			config: { ...this.config }
-		});
-	}
-	/**
-	* Get the ordered list of child item ids.
-	*/
-	getChildrenIds() {
-		return [...this.items];
-	}
-	/**
-	* Swap two items by their positions in the group.
-	* @throws Error if indices are out of bounds
-	*/
-	swapItemsByIndex(from, to) {
-		const items = this.items;
-		if (from < 0 || from >= items.length || to < 0 || to >= items.length) throw new Error(`Index out of bounds. Valid range is 0-${items.length - 1}`);
-		if (from === to) return;
-		this.config.items = swapArrayElements(items, from, to);
-		this.updateRawItem({
-			...this.rawItem,
-			config: { ...this.config }
-		});
-	}
-	/**
-	* Swap two items by their ids.
-	* @throws Error if either id is not found in this group
-	*/
-	swapItemsById(id, withId) {
-		const items = this.items;
-		const index1 = items.indexOf(id);
-		const index2 = items.indexOf(withId);
-		if (index1 === -1) throw new Error(`Item '${id}' not found in group '${this.key}'`);
-		if (index2 === -1) throw new Error(`Item '${withId}' not found in group '${this.key}'`);
-		this.swapItemsByIndex(index1, index2);
-	}
-	/**
-	* Move an item by id to a specific index.
-	* @throws Error if the item is not found or index is out of bounds
-	*/
-	moveItemToIndex(id, index) {
-		const items = this.items;
-		const fromIndex = items.indexOf(id);
-		if (fromIndex === -1) throw new Error(`Item '${id}' not found in group '${this.key}'`);
-		if (index < 0 || index >= items.length) throw new Error(`Index out of bounds. Valid range is 0-${items.length - 1}`);
-		if (fromIndex === index) return;
-		this.config.items = moveArrayElement(items, fromIndex, index);
-		this.updateRawItem({
-			...this.rawItem,
-			config: { ...this.config }
-		});
-	}
-};
-var PageBreakItemCore = class extends SurveyItemCore {
-	type = ReservedSurveyItemTypes.PageBreak;
-	parseConfig(_rawConfig) {
-		return {};
-	}
-	serializeConfig() {}
-	isInteractive() {
-		return false;
-	}
-	getAvailableResponseValueSlots() {
-		return {};
-	}
-};
-const builtInItemCoreRegistry = {
-	[ReservedSurveyItemTypes.Group]: GroupItemCore,
-	[ReservedSurveyItemTypes.PageBreak]: PageBreakItemCore
-};
-const isBuiltInItemType = (itemType) => itemType in builtInItemCoreRegistry;
-
-//#endregion
-//#region src/survey/registry/item-registry.ts
-/**
-* Creates a handler instance for a raw survey item.
-* Uses built-in registry for group/page-break, otherwise the provided plugin registry.
-*/
-function createItemCore(rawItem, pluginRegistry) {
-	if (isBuiltInItemType(rawItem.itemType)) {
-		const HandlerClass = builtInItemCoreRegistry[rawItem.itemType];
-		return new HandlerClass(rawItem);
-	}
-	if (pluginRegistry && rawItem.itemType in pluginRegistry) {
-		const HandlerClass = pluginRegistry[rawItem.itemType];
-		return new HandlerClass(rawItem);
-	}
-	throw new Error(`Unknown item type: ${rawItem.itemType}`);
-}
-
 //#endregion
 //#region src/survey/survey.ts
 var Survey = class Survey {
@@ -785,6 +855,10 @@ var Survey = class Survey {
 		this.pluginRegistry = pluginRegistry;
 		this._translations = new SurveyTranslations();
 	}
+	/** Plugin registry used when parsing items. Exposed for editors that re-parse without their own registry. */
+	getPluginRegistry() {
+		return this.pluginRegistry;
+	}
 	/**
 	* Create a survey item from raw JSON data.
 	* Uses the survey's plugin registry when available.
@@ -792,10 +866,30 @@ var Survey = class Survey {
 	createItemFromRaw(rawItem) {
 		return createItemCore(rawItem, this.pluginRegistry);
 	}
+	/**
+	* Create a minimal blank survey with a root group and one empty page.
+	*/
+	static createBlankSurvey(pluginRegistry, surveyKey) {
+		const newKey = surveyKey ?? generateCodingKey();
+		const rawSurvey = {
+			$schema: CURRENT_SURVEY_SCHEMA,
+			surveyItems: [{
+				id: generateId(),
+				key: newKey,
+				itemType: ReservedSurveyItemTypes.Group,
+				config: {
+					isRoot: true,
+					items: [],
+					shuffleItems: false
+				}
+			}]
+		};
+		return Survey.fromJson(rawSurvey, pluginRegistry);
+	}
 	static fromJson(json, pluginRegistry) {
 		const survey = new Survey(pluginRegistry);
 		const rawSurvey = json;
-		if (rawSurvey.$schema !== CURRENT_SURVEY_SCHEMA) throw new Error(`Unsupported survey schema: ${rawSurvey.$schema}`);
+		if (rawSurvey.$schema !== "https://github.com/case-framework/case-survey-toolkit/packages/survey-core/schemas/survey-schema.json") throw new Error(`Unsupported survey schema: ${rawSurvey.$schema}`);
 		survey.surveyItems = /* @__PURE__ */ new Map();
 		if (!rawSurvey.surveyItems || rawSurvey.surveyItems.length === 0) throw new Error("surveyItems is required");
 		rawSurvey.surveyItems.forEach((item) => {
@@ -902,6 +996,12 @@ var Survey = class Survey {
 		};
 		return valueRefs;
 	}
+	getResponseSlotDefinitions() {
+		return Array.from(this.surveyItems.values()).map((item) => ({
+			itemId: item.id,
+			slots: item.getResponseSlotDefinitions()
+		}));
+	}
 	/**
 	* Get all reference usages for the survey
 	* @param forItemId - optional item id to filter usages for a specific item and its children (if not provided, all usages are returned)
@@ -925,7 +1025,7 @@ var Survey = class Survey {
 		return this.getItemPath(targetId).includes(ancestorId);
 	}
 };
-
 //#endregion
-export { ValueReference as C, structuredCloneMethod as D, shuffleIndices as E, ReferenceUsageType as S, generateId as T, Expression as _, validateLocale as a, FunctionExpressionNames as b, SurveyItemCore as c, deserializeTemplateValues as d, serializeTemplateValue as f, ContextVariableType as g, ContextVariableExpression as h, SurveyTranslations as i, TemplateDefTypes as l, ConstExpression as m, GroupItemCore as n, SurveyItemKey as o, serializeTemplateValues as p, SurveyItemTranslations as r, ReservedSurveyItemTypes as s, Survey as t, deserializeTemplateValue as u, ExpressionType as v, ValueReferenceMethod as w, ResponseVariableExpression as x, FunctionExpression as y };
-//# sourceMappingURL=survey-C3ZHI-5z.mjs.map
+export { FunctionExpressionNames as A, serializeTemplateValues as C, Expression as D, ContextVariableType as E, generateCodingKey as F, generateId as I, shuffleIndices as L, ReferenceUsageType as M, ValueReference as N, ExpressionType as O, ValueReferenceMethod as P, structuredCloneMethod as R, serializeTemplateValue as S, ContextVariableExpression as T, NumberPrecision as _, createFullRegistry as a, deserializeTemplateValue as b, toItemTypeDefinitionRegistry as c, builtInItemCoreRegistry as d, isBuiltInItemType as f, DurationUnits as g, SurveyItemCore as h, validateLocale as i, ResponseVariableExpression as j, FunctionExpression as k, GroupItemCore as l, ReservedSurveyItemTypes as m, SurveyItemTranslations as n, createItemCore as o, SurveyItemKey as p, SurveyTranslations as r, createItemTypeDefinitionRegistry as s, Survey as t, PageBreakItemCore as u, ValueType as v, ConstExpression as w, deserializeTemplateValues as x, TemplateDefTypes as y };
+
+//# sourceMappingURL=survey-DJbgFVPz.mjs.map