survey-expression 4.4.0 → 4.5.0

package/dist/index.d.ts

@@ -194,6 +194,7 @@ export declare const parseSequenceItems: (state: SurveyExpressionParserState, cl
 export declare const parseSurveyExpression: (source: string) => Result<SurveyExpressionNode, SurveyLogicError>;
 export declare const runSurveyExpression: (source: string, context: SurveyLogicContext) => Result<SurveyLogicValue, SurveyLogicError>;
 export declare const addSurveyLogicMonths: (wallClock: Date, months: number) => void;
+export declare const averageSurveyNumbers: (numbers: number[]) => number | undefined;
 export declare const checkIsCalendarDay: (year: number, month: number, day: number) => boolean;
 export declare const checkIsSurveyFieldName: (text: string) => boolean;
 export declare const checkIsSurveyLogicAllOf: (left: SurveyLogicValue, right: SurveyLogicValue) => boolean;
@@ -204,6 +205,7 @@ export declare const checkIsSurveyLogicLess: (left: SurveyLogicValue, right: Sur
 export declare const checkIsSurveyLogicPrimitiveEqual: (left: SurveyLogicValue, right: SurveyLogicValue) => boolean;
 export declare const checkIsSurveyLogicValueEmpty: (value: SurveyLogicValue) => boolean;
 export declare const checkIsSurveyLogicValueEqual: (left: SurveyLogicValue, right: SurveyLogicValue) => boolean;
+export declare const checkIsSurveyReturnField: (value: unknown) => value is string;
 export declare const compareSurveyLogicTexts: (first: string, second: string) => number;
 export declare const countSurveyLogicDecimals: (number: number) => number;
 export declare const createSurveyLogicWallClock: (year: number, monthIndex: number, day: number, { hour, millisecond, minute, second }?: {
@@ -225,13 +227,14 @@ export declare const getSurveyLogicDayNumber: (wallClock: Date) => number;
 export declare const getSurveyNumberWithPrecision: (args: SurveyLogicValue[]) => [number, number] | undefined;
 export declare const getSurveyOptionalArgument: <T>(value: SurveyLogicValue, defaultValue: T, readArgument: (value: SurveyLogicValue) => T | undefined) => T | undefined;
 export declare const getSurveyTextIndex: (index: number, length: number) => number;
+export declare const mapSurveyLogicValues: <T, U>(record: Record<string, T>, mapValue: (value: T) => U) => Record<string, U>;
 export declare const parseSurveyLogicDate: (value: SurveyLogicValue) => Date | undefined;
 export declare const roundSurveyLogicProduct: (left: number, right: number, product: number) => number;
 export declare const roundSurveyLogicResult: (result: number, digits: number) => number;
 export declare const roundSurveyLogicSum: (left: number, right: number, sum: number) => number;
 export declare const sumSurveyNumbers: (numbers: number[]) => number | undefined;
-export declare const toSurveyLogicAnswers: (record: Record<string, SurveyLogicStoredValue>) => SurveyLogicRecord;
 export declare const toSurveyLogicAnswer: (value: SurveyLogicStoredValue) => SurveyLogicValue;
+export declare const toSurveyLogicAnswers: (record: Record<string, SurveyLogicStoredValue>) => SurveyLogicRecord;
 export declare const toSurveyLogicDate: (wallClock: Date) => string | undefined;
 export declare const toSurveyLogicNumber: (value: SurveyLogicValue) => number | undefined;
 export declare const toSurveyLogicPrimitive: (value: SurveyLogicValue) => SurveyLogicValue;

package/dist/index.js

@@ -52,47 +52,6 @@ let SurveyExpressionUnaryOperator = /* @__PURE__ */ function(SurveyExpressionUna
 	SurveyExpressionUnaryOperator["NotEmpty"] = "notEmpty";
 	return SurveyExpressionUnaryOperator;
 }({});
-// src/services/shared/checkIsSurveyFieldName.ts
-const checkIsSurveyFieldName = (text) => !/[{}><=!]/u.test(text);
-// src/services/shared/getOwnValue.ts
-const getOwnValue = (record, key) => Object.hasOwn(record, key) ? record[key] : void 0;
-// src/services/shared/getSurveyArrayItems.ts
-const getSurveyArrayItems = (data) => {
-	if (Array.isArray(data)) return data;
-	if (typeof data === "object") return Object.values(data);
-	return [];
-};
-// src/services/shared/toSurveyLogicNumber.ts
-const NUMBER_TEXT_REGEX = /^[+-]?(?:\d+\.?\d*|\.\d+)(?:e[+-]?\d+)?$/iu;
-const toSurveyLogicNumber = (value) => {
-	if (typeof value === "number") return Number.isFinite(value) ? value : void 0;
-	if (typeof value !== "string") return void 0;
-	const text = value.trim();
-	if (!NUMBER_TEXT_REGEX.test(text)) return void 0;
-	const number = Number(text);
-	return Number.isFinite(number) ? number : void 0;
-};
-// src/services/shared/getSurveyArrayParams.ts
-const getSurveyArrayParams = (args) => {
-	const [data, name, returnCandidate] = args;
-	if (args.length < 2 || args.length > 4 || typeof name !== "string") return void 0;
-	const hasReturnField = args.length > 2 && typeof returnCandidate === "string" && checkIsSurveyFieldName(returnCandidate);
-	const filterIndex = hasReturnField ? 3 : 2;
-	if (args.length > filterIndex) return void 0;
-	const rows = [];
-	for (const item of getSurveyArrayItems(data)) {
-		if (typeof item !== "object" || Array.isArray(item)) continue;
-		const field = toSurveyLogicNumber(getOwnValue(item, name));
-		if (field !== void 0) rows.push({
-			field,
-			item
-		});
-	}
-	return {
-		returnField: hasReturnField && returnCandidate !== name ? returnCandidate : void 0,
-		rows
-	};
-};
 // src/services/shared/countSurveyLogicDecimals.ts
 const countSurveyLogicDecimals = (number) => {
 	const [mantissa = "", exponent = "0"] = number.toExponential().split("e");
@@ -213,12 +172,59 @@ const sumSurveyNumbers = (numbers) => {
 	for (const number of numbers) total = roundSurveyLogicSum(total, number, total + number);
 	return toSurveyLogicResult(total);
 };
+// src/services/shared/averageSurveyNumbers.ts
+const averageSurveyNumbers = (numbers) => {
+	if (numbers.length === 0) return void 0;
+	const total = sumSurveyNumbers(numbers);
+	return total === void 0 ? void 0 : total / numbers.length;
+};
+// src/services/shared/checkIsSurveyFieldName.ts
+const checkIsSurveyFieldName = (text) => !/[{}><=!]/u.test(text);
+// src/services/shared/checkIsSurveyReturnField.ts
+const checkIsSurveyReturnField = (value) => typeof value === "string" && checkIsSurveyFieldName(value);
+// src/services/shared/getOwnValue.ts
+const getOwnValue = (record, key) => Object.hasOwn(record, key) ? record[key] : void 0;
+// src/services/shared/getSurveyArrayItems.ts
+const getSurveyArrayItems = (data) => {
+	if (Array.isArray(data)) return data;
+	if (typeof data === "object") return Object.values(data);
+	return [];
+};
+// src/services/shared/toSurveyLogicNumber.ts
+const NUMBER_TEXT_REGEX = /^[+-]?(?:\d+\.?\d*|\.\d+)(?:e[+-]?\d+)?$/iu;
+const toSurveyLogicNumber = (value) => {
+	if (typeof value === "number") return Number.isFinite(value) ? value : void 0;
+	if (typeof value !== "string") return void 0;
+	const text = value.trim();
+	if (!NUMBER_TEXT_REGEX.test(text)) return void 0;
+	const number = Number(text);
+	return Number.isFinite(number) ? number : void 0;
+};
+// src/services/shared/getSurveyArrayParams.ts
+const getSurveyArrayParams = (args) => {
+	const [data, name, returnCandidate] = args;
+	if (args.length < 2 || args.length > 4 || typeof name !== "string") return void 0;
+	const hasReturnField = args.length > 2 && checkIsSurveyReturnField(returnCandidate);
+	const filterIndex = hasReturnField ? 3 : 2;
+	if (args.length > filterIndex) return void 0;
+	const rows = [];
+	for (const item of getSurveyArrayItems(data)) {
+		if (typeof item !== "object" || Array.isArray(item)) continue;
+		const field = toSurveyLogicNumber(getOwnValue(item, name));
+		if (field !== void 0) rows.push({
+			field,
+			item
+		});
+	}
+	return {
+		returnField: hasReturnField && returnCandidate !== name ? returnCandidate : void 0,
+		rows
+	};
+};
 // src/services/functions/avgInArrayFunction.ts
 const avgInArrayFunction = (args) => {
 	const params = getSurveyArrayParams(args);
-	if (params === void 0 || params.rows.length === 0) return void 0;
-	const total = sumSurveyNumbers(params.rows.map((row) => row.field));
-	return total === void 0 ? void 0 : total / params.rows.length;
+	return params === void 0 ? void 0 : averageSurveyNumbers(params.rows.map((row) => row.field));
 };
 // src/services/functions/countInArrayFunction.ts
 const countInArrayFunction = (args) => {
@@ -475,12 +481,7 @@ const flattenSurveyNumbers = (values) => values.flatMap((value) => {
 	return number === void 0 ? [] : [number];
 });
 // src/services/functions/avgFunction.ts
-const avgFunction = (args) => {
-	const numbers = flattenSurveyNumbers(args);
-	if (numbers.length === 0) return void 0;
-	const total = sumSurveyNumbers(numbers);
-	return total === void 0 ? void 0 : total / numbers.length;
-};
+const avgFunction = (args) => averageSurveyNumbers(flattenSurveyNumbers(args));
 // src/services/functions/countFunction.ts
 const countFunction = (args) => {
 	return flattenSurveyNumbers(args).length;
@@ -540,7 +541,7 @@ const getCallRefusal = (node) => {
 	if (getOwnValue(SurveyLogicFunctionMap, name) === void 0) return `Unknown function "${node.name}"`;
 	if (getOwnValue(ArrayFunctionMap, name) === void 0 || node.args.length < 3) return void 0;
 	const third = node.args.at(2);
-	return node.args.length === 3 && third?.type === "literal" && typeof third.value === "string" && checkIsSurveyFieldName(third.value) ? void 0 : `The filter form of "${node.name}" is not supported`;
+	return node.args.length === 3 && third?.type === "literal" && checkIsSurveyReturnField(third.value) ? void 0 : `The filter form of "${node.name}" is not supported`;
 };
 // src/services/getSurveyExpressionChildren.ts
 const getSurveyExpressionChildren = (node) => {
@@ -1086,8 +1087,6 @@ const evaluateCall = (node, context, evaluate) => {
 };
 // src/services/evaluator/evaluateList.ts
 const evaluateList = (node, context, evaluate) => node.items.map((item) => evaluate(item, context));
-// src/services/evaluator/readSurveyLogicLength.ts
-const readSurveyLogicLength = (value) => Array.isArray(value) || typeof value === "string" ? value.length : 0;
 // src/services/evaluator/readSurveyLogicKey.ts
 const DIGITS_ONLY_REGEX = /^\d+$/u;
 const readSurveyLogicKey = (container, key) => {
@@ -1109,11 +1108,8 @@ const readSurveyLogicPathUncached = (container, name, readTail) => {
 	const whole = readSurveyLogicPart(container, name);
 	if (whole !== void 0) return whole;
 	for (let separatorIndex = name.indexOf("."); separatorIndex !== -1; separatorIndex = name.indexOf(".", separatorIndex + 1)) {
-		const head = readSurveyLogicPart(container, name.slice(0, separatorIndex));
-		const tail = name.slice(separatorIndex + 1);
-		const value = readTail(head, tail);
+		const value = readTail(readSurveyLogicPart(container, name.slice(0, separatorIndex)), name.slice(separatorIndex + 1));
 		if (value !== void 0) return value;
-		if (tail === "length") return readSurveyLogicLength(head);
 	}
 };
 // src/services/evaluator/readMemoizedSurveyLogicPath.ts
@@ -1124,8 +1120,15 @@ const readMemoizedSurveyLogicPath = (container, name, memo) => {
 	namesRead.set(name, value);
 	return value;
 };
+// src/services/evaluator/readSurveyLogicLength.ts
+const readSurveyLogicLength = (value) => Array.isArray(value) || typeof value === "string" ? value.length : 0;
 // src/services/evaluator/readSurveyLogicPath.ts
-const readSurveyLogicPath = (container, name) => readMemoizedSurveyLogicPath(container, name, /* @__PURE__ */ new Map());
+const LENGTH_SUFFIX = ".length";
+const readSurveyLogicPath = (container, name) => {
+	const value = readMemoizedSurveyLogicPath(container, name, /* @__PURE__ */ new Map());
+	if (value !== void 0 || !name.endsWith(LENGTH_SUFFIX)) return value;
+	return readSurveyLogicLength(readSurveyLogicPath(container, name.slice(0, -7)));
+};
 // src/services/evaluator/readSurveyLogicReference.ts
 const readSurveyLogicReference = (name, context) => {
 	const answer = getOwnValue(context.values, name);
@@ -1165,12 +1168,15 @@ const evaluateSurveyExpression = (node, context) => {
 };
 // src/services/runSurveyExpression.ts
 const runSurveyExpression = (source, context) => parseSurveyExpression(source).map((node) => evaluateSurveyExpression(node, context));
+// src/services/shared/mapSurveyLogicValues.ts
+const mapSurveyLogicValues = (record, mapValue) => Object.fromEntries(Object.entries(record).map(([name, value]) => [name, mapValue(value)]));
 // src/services/shared/toSurveyLogicAnswer.ts
-const toSurveyLogicAnswers = (record) => Object.fromEntries(Object.entries(record).map(([name, answer]) => [name, toSurveyLogicAnswer(answer)]));
 const toSurveyLogicAnswer = (value) => {
 	if (value === null) return void 0;
 	if (Array.isArray(value)) return value.map((item) => toSurveyLogicAnswer(item));
-	if (typeof value === "object") return toSurveyLogicAnswers(value);
+	if (typeof value === "object") return mapSurveyLogicValues(value, toSurveyLogicAnswer);
 	return value;
 };
-export { ArrayFunctionMap, DateFunctionMap, GeneralFunctionMap, LOWEST_POWER, MAX_DECIMAL_PLACES, MAX_SURVEY_EXPRESSION_LENGTH, PUNCTUATION_CHARACTERS, STRING_QUOTES, SYMBOL_OPERATOR_TEXTS, SurveyExpressionBinaryOperator, SurveyExpressionBinaryOperatorMap, SurveyExpressionNodeType, SurveyExpressionPostfixOperatorMap, SurveyExpressionPrefixOperatorMap, SurveyExpressionTokenType, SurveyExpressionUnaryOperator, SurveyLogicFunctionMap, addSurveyLogicMonths, advanceSurveyExpressionWhile, ageFunction, avgFunction, avgInArrayFunction, checkIsCalendarDay, checkIsPunctuation, checkIsSurveyExpressionDigit, checkIsSurveyExpressionKeyword, checkIsSurveyExpressionWhitespace, checkIsSurveyExpressionWordCharacter, checkIsSurveyExpressionWordStart, checkIsSurveyFieldName, checkIsSurveyLogicAllOf, checkIsSurveyLogicAnyOf, checkIsSurveyLogicContaining, checkIsSurveyLogicItemHeld, checkIsSurveyLogicLess, checkIsSurveyLogicPrimitiveEqual, checkIsSurveyLogicValueEmpty, checkIsSurveyLogicValueEqual, checkSurveyExpression, compareSurveyLogicTexts, countFunction, countInArrayFunction, countSurveyLogicDecimals, createSurveyLogicWallClock, dateAddFunction, dateDiffFunction, dayFunction, evaluateArithmeticOperator, evaluateBinary, evaluateCall, evaluateComparisonOperator, evaluateList, evaluateLogicOperator, evaluateMembershipOperator, evaluateReference, evaluateSurveyExpression, evaluateUnary, findSurveyExpressionRefusal, flattenSurveyNumbers, getCallRefusal, getDateDifference, getDateOrNow, getOwnValue, getSurveyArrayExtreme, getSurveyArrayItems, getSurveyArrayParams, getSurveyDateUnit, getSurveyExpressionChildren, getSurveyExtreme, getSurveyLogicDayNumber, getSurveyNumberWithPrecision, getSurveyOptionalArgument, getSurveyTextIndex, iifFunction, maxFunction, maxInArrayFunction, minFunction, minInArrayFunction, monthFunction, parseBinary, parseBinaryOperators, parseCall, parseGroup, parseList, parseOperand, parsePrefixOperator, parseSequence, parseSequenceItems, parseSurveyExpression, parseSurveyLogicDate, readMemoizedSurveyLogicPath, readSurveyExpressionNumber, readSurveyExpressionReference, readSurveyExpressionString, readSurveyExpressionSymbol, readSurveyExpressionToken, readSurveyExpressionWord, readSurveyLogicKey, readSurveyLogicLength, readSurveyLogicPart, readSurveyLogicPath, readSurveyLogicPathUncached, readSurveyLogicReference, roundFunction, roundSurveyLogicProduct, roundSurveyLogicResult, roundSurveyLogicSum, runSurveyExpression, substringFunction, sumFunction, sumInArrayFunction, sumSurveyNumbers, toSurveyLogicAnswer, toSurveyLogicAnswers, toSurveyLogicDate, toSurveyLogicNumber, toSurveyLogicPrimitive, toSurveyLogicResult, toSurveyLogicText, toSurveyLogicWallClock, todayFunction, tokenizeSurveyExpression, truncFunction, weekdayFunction, yearFunction };
+// src/services/shared/toSurveyLogicAnswers.ts
+const toSurveyLogicAnswers = (record) => mapSurveyLogicValues(record, toSurveyLogicAnswer);
+export { ArrayFunctionMap, DateFunctionMap, GeneralFunctionMap, LOWEST_POWER, MAX_DECIMAL_PLACES, MAX_SURVEY_EXPRESSION_LENGTH, PUNCTUATION_CHARACTERS, STRING_QUOTES, SYMBOL_OPERATOR_TEXTS, SurveyExpressionBinaryOperator, SurveyExpressionBinaryOperatorMap, SurveyExpressionNodeType, SurveyExpressionPostfixOperatorMap, SurveyExpressionPrefixOperatorMap, SurveyExpressionTokenType, SurveyExpressionUnaryOperator, SurveyLogicFunctionMap, addSurveyLogicMonths, advanceSurveyExpressionWhile, ageFunction, averageSurveyNumbers, avgFunction, avgInArrayFunction, checkIsCalendarDay, checkIsPunctuation, checkIsSurveyExpressionDigit, checkIsSurveyExpressionKeyword, checkIsSurveyExpressionWhitespace, checkIsSurveyExpressionWordCharacter, checkIsSurveyExpressionWordStart, checkIsSurveyFieldName, checkIsSurveyLogicAllOf, checkIsSurveyLogicAnyOf, checkIsSurveyLogicContaining, checkIsSurveyLogicItemHeld, checkIsSurveyLogicLess, checkIsSurveyLogicPrimitiveEqual, checkIsSurveyLogicValueEmpty, checkIsSurveyLogicValueEqual, checkIsSurveyReturnField, checkSurveyExpression, compareSurveyLogicTexts, countFunction, countInArrayFunction, countSurveyLogicDecimals, createSurveyLogicWallClock, dateAddFunction, dateDiffFunction, dayFunction, evaluateArithmeticOperator, evaluateBinary, evaluateCall, evaluateComparisonOperator, evaluateList, evaluateLogicOperator, evaluateMembershipOperator, evaluateReference, evaluateSurveyExpression, evaluateUnary, findSurveyExpressionRefusal, flattenSurveyNumbers, getCallRefusal, getDateDifference, getDateOrNow, getOwnValue, getSurveyArrayExtreme, getSurveyArrayItems, getSurveyArrayParams, getSurveyDateUnit, getSurveyExpressionChildren, getSurveyExtreme, getSurveyLogicDayNumber, getSurveyNumberWithPrecision, getSurveyOptionalArgument, getSurveyTextIndex, iifFunction, mapSurveyLogicValues, maxFunction, maxInArrayFunction, minFunction, minInArrayFunction, monthFunction, parseBinary, parseBinaryOperators, parseCall, parseGroup, parseList, parseOperand, parsePrefixOperator, parseSequence, parseSequenceItems, parseSurveyExpression, parseSurveyLogicDate, readMemoizedSurveyLogicPath, readSurveyExpressionNumber, readSurveyExpressionReference, readSurveyExpressionString, readSurveyExpressionSymbol, readSurveyExpressionToken, readSurveyExpressionWord, readSurveyLogicKey, readSurveyLogicLength, readSurveyLogicPart, readSurveyLogicPath, readSurveyLogicPathUncached, readSurveyLogicReference, roundFunction, roundSurveyLogicProduct, roundSurveyLogicResult, roundSurveyLogicSum, runSurveyExpression, substringFunction, sumFunction, sumInArrayFunction, sumSurveyNumbers, toSurveyLogicAnswer, toSurveyLogicAnswers, toSurveyLogicDate, toSurveyLogicNumber, toSurveyLogicPrimitive, toSurveyLogicResult, toSurveyLogicText, toSurveyLogicWallClock, todayFunction, tokenizeSurveyExpression, truncFunction, weekdayFunction, yearFunction };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "survey-expression",
-  "version": "4.4.0",
+  "version": "4.5.0",
   "description": "The survey's expression language — conditions, calculated values and validators over a survey's answers, checked against SurveyJS's recorded answers with every deliberate difference listed",
   "keywords": [
     "typescript"
@@ -32,19 +32,20 @@
   "publishConfig": {
     "access": "public"
   },
-  "dependencies": {
-    "@esposter/shared": "4.4.0",
-    "neverthrow": "^8.2.0"
-  },
-  "devDependencies": {
-    "@esposter/configuration": "4.4.0",
-    "tsdown": "^0.23.5"
-  },
   "scripts": {
     "build": "tsdown",
     "lint": "eslint .",
     "lint:fix": "eslint --fix .",
     "test": "vitest",
     "typecheck": "tsrs --fast"
-  }
-}
+  },
+  "dependencies": {
+    "@esposter/shared": "4.5.0",
+    "neverthrow": "^8.2.0"
+  },
+  "devDependencies": {
+    "@esposter/configuration": "4.5.0",
+    "tsdown": "^0.23.5"
+  },
+  "gitHead": "e30c001f3b4b15693e75fb53092d62a97ade4d2b"
+}