@olenbetong/appframe-core 2.15.2 → 2.16.0

package/dist/iife/af.common.legacy.js

@@ -2,7 +2,7 @@ this.af = this.af || {};
 this.af.common = (function(exports) {
 
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-//#region ../../node_modules/.pnpm/mitt@3.0.1/node_modules/mitt/dist/mitt.mjs
+// ../../node_modules/.pnpm/mitt@3.0.1/node_modules/mitt/dist/mitt.mjs
 	function mitt_default(n) {
 		return {
 			all: n = n || /* @__PURE__ */ new Map(),
@@ -25,8 +25,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		};
 	}
 
-//#endregion
-//#region src/SessionHandler.ts
+// src/SessionHandler.ts
 	var SessionHandler = class {
 		eventHandler = mitt_default();
 		authenticated() {
@@ -71,8 +70,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		}
 	};
 
-//#endregion
-//#region src/UserSession.ts
+// src/UserSession.ts
 	var UserSession = class extends SessionHandler {
 		amDesignator = "a.m.";
 		dayNames = [
@@ -144,8 +142,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		}
 	};
 
-//#endregion
-//#region src/log.ts
+// src/log.ts
 	const article = window.af?.article?.id ?? window.window?.location.pathname.substring(1).split("/")[0];
 	/**
 	* Logs an activity to the website activity log
@@ -290,15 +287,13 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		};
 	}
 
-//#endregion
-//#region src/errorHandler.ts
+// src/errorHandler.ts
 	window.window?.addEventListener("error", (event) => {
 		if (typeof event === "object" && "error" in event) logError(event.error);
 		else if (typeof event === "object" && "message" in event) logError(event);
 	});
 
-//#endregion
-//#region src/localStorage.ts
+// src/localStorage.ts
 	function getLocalKey(key) {
 		return [
 			af?.article?.id || "",
@@ -333,8 +328,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 	};
 	var localStorage_default = new LocalStorage();
 
-//#endregion
-//#region src/date.ts
+// src/date.ts
 	function toLocalISODate(date) {
 		return date ? toLocalISODateTime(date).substring(0, 10) : null;
 	}
@@ -357,8 +351,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		return date ? date.toISOString().substring(0, 16) : "";
 	}
 
-//#endregion
-//#region src/downloadBlob.ts
+// src/downloadBlob.ts
 	function downloadBlob(blob, fileName) {
 		return new Promise((resolve, reject) => {
 			try {
@@ -380,8 +373,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		});
 	}
 
-//#endregion
-//#region src/invariant.ts
+// src/invariant.ts
 /**
 	* Throws an error if the condition is falsy. The provided message is used as the error message.
 	* A function can be provided to lazily generate the message.
@@ -396,8 +388,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		throw new Error(provided ?? "Invariant failed");
 	}
 
-//#endregion
-//#region src/downloadRequest.ts
+// src/downloadRequest.ts
 	async function downloadRequest(request, { fileName, signal, onProgress }) {
 		let bytesReceived = 0;
 		onProgress?.({ status: "requested" });
@@ -451,8 +442,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		}
 	}
 
-//#endregion
-//#region src/parseFunc.ts
+// src/parseFunc.ts
 	const funcRegex = /^function(?:\s+([a-zA-Z$_][a-zA-Z0-9$_]*))?\s*\(((?:(?:\s*[a-zA-Z$_][a-zA-Z0-9$_]*)(?:\s*,\s*[a-zA-Z$_][a-zA-Z0-9$_]*)*)?)\s*\)\s*\{((?:.|\n|\r)*)\}$/;
 	const arrowBlockRegex = /^(?:\(([^)]*)\)|([a-zA-Z$_][a-zA-Z0-9$_]*))\s*=>\s*\{([\s\S]*)\}$/;
 	const arrowExpressionRegex = /^(?:\(([^)]*)\)|([a-zA-Z$_][a-zA-Z0-9$_]*))\s*=>\s*([\s\S]+)$/;
@@ -486,13 +476,11 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		};
 	}
 
-//#endregion
-//#region src/Namespace.ts
+// src/Namespace.ts
 	function Namespace() {}
 	Namespace.prototype = Object.create(null);
 
-//#endregion
-//#region src/requireNamespace.ts
+// src/requireNamespace.ts
 	function requireNamespace(root, namespace) {
 		if (typeof root === "object") {
 			if (typeof namespace === "string") return requireNamespace(root, namespace.split("."));
@@ -504,8 +492,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		}
 	}
 
-//#endregion
-//#region src/expose.ts
+// src/expose.ts
 /**
 	* Expose a value to a potentially deeply nested global variable
 	* @param name {string | object} Either a dot-separated path to the global variable, or an object to expose the value on
@@ -535,8 +522,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		}
 	}
 
-//#endregion
-//#region src/getLocalizedString.ts
+// src/getLocalizedString.ts
 	async function fetchLocalizedString(text, project) {
 		try {
 			let response = await fetch(`/api/user/localize/new/${encodeURIComponent(project)}`, {
@@ -625,8 +611,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		};
 	}
 
-//#endregion
-//#region src/filter/operators.ts
+// src/filter/operators.ts
 /**
 	* Operators that take no value at all.
 	*
@@ -640,6 +625,26 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		"isblank",
 		"isnotblank"
 	];
+	/**
+	* Whole-period checks for dates, such as "Is last week", in the order of the
+	* Windows filter editor. They take no value. The framework has no operator for
+	* them, so a filter using one is sent as a filter string (`needsFilterString`).
+	*/
+	const PERIOD_OPERATORS = [
+		"isbeyondthisyear",
+		"islaterthisyear",
+		"islaterthismonth",
+		"isnextweek",
+		"islaterthisweek",
+		"istomorrow",
+		"istoday",
+		"isyesterday",
+		"isearlierthisweek",
+		"islastweek",
+		"isearlierthismonth",
+		"isearlierthisyear",
+		"ispriorthisyear"
+	];
 	/** Operators whose value is a two element `[from, to]` array. */
 	const PAIR_OPERATORS = [
 		"between",
@@ -650,7 +655,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 	/** Operators whose value is an array of values. */
 	const LIST_OPERATORS = ["inlist", "notinlist"];
 	function getOperatorArity(operator) {
-		if (PARAMETERLESS_OPERATORS.includes(operator)) return "none";
+		if (PARAMETERLESS_OPERATORS.includes(operator) || PERIOD_OPERATORS.includes(operator)) return "none";
 		if (PAIR_OPERATORS.includes(operator)) return "pair";
 		if (LIST_OPERATORS.includes(operator)) return "list";
 		return "single";
@@ -693,7 +698,20 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		datelessthan: "Before",
 		datelessthanorequal: "Up to",
 		datebetween: "Between",
-		datenotbetween: "Not between"
+		datenotbetween: "Not between",
+		isbeyondthisyear: "Is beyond this year",
+		islaterthisyear: "Is later this year",
+		islaterthismonth: "Is later this month",
+		isnextweek: "Is next week",
+		islaterthisweek: "Is later this week",
+		istomorrow: "Is tomorrow",
+		istoday: "Is today",
+		isyesterday: "Is yesterday",
+		isearlierthisweek: "Is earlier this week",
+		islastweek: "Is last week",
+		isearlierthismonth: "Is earlier this month",
+		isearlierthisyear: "Is earlier this year",
+		ispriorthisyear: "Is prior to this year"
 	};
 	/** Comparison operator labels used for date and time fields. */
 	const DATE_OPERATOR_LABELS = {
@@ -738,13 +756,15 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 			...EQUALITY,
 			...LIST_CHECKS,
 			...RANGE,
-			...COMPARISONS
+			...COMPARISONS,
+			...PERIOD_OPERATORS
 		],
 		datetime: [
 			...EQUALITY,
 			...LIST_CHECKS,
 			...RANGE,
-			...COMPARISONS
+			...COMPARISONS,
+			...PERIOD_OPERATORS
 		],
 		number: [
 			...EQUALITY,
@@ -817,7 +837,10 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 	const RELATIVE_DATE_VALUES = [
 		"Yesterday",
 		"Today",
+		"Now",
 		"Tomorrow",
+		"DayAfterTomorrow",
+		"TwoWeeksAway",
 		"ThisWeek",
 		"ThisMonth",
 		"ThisYear",
@@ -832,7 +855,10 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		CurrentUser: "Current user",
 		Yesterday: "Yesterday",
 		Today: "Today",
+		Now: "Now",
 		Tomorrow: "Tomorrow",
+		DayAfterTomorrow: "Day after tomorrow",
+		TwoWeeksAway: "Two weeks away",
 		ThisWeek: "This week",
 		ThisMonth: "This month",
 		ThisYear: "This year",
@@ -868,6 +894,30 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		if (field.type === "string") return ["CurrentUser"];
 		return [];
 	}
+	/** Operators that can compare a field with another column. */
+	const COLUMN_OPERATORS = [
+		...EQUALITY,
+		...RANGE,
+		...COMPARISONS
+	];
+	/** Whether an operator can take another column as its value. */
+	function supportsColumnValue(operator) {
+		return COLUMN_OPERATORS.includes(operator);
+	}
+	/** Dates and datetimes compare with each other; other types only with their own. */
+	function getComparableType(type) {
+		return type === "datetime" ? "date" : type;
+	}
+	/**
+	* The columns a field can be compared with: the other fields of the same type,
+	* as in the Windows filter editor. Booleans have only true and false checks,
+	* so they get none.
+	*/
+	function getColumnsForField(field, fields) {
+		if (field.type === "boolean") return [];
+		let type = getComparableType(field.type);
+		return fields.filter((other) => other.name !== field.name && !other.excludeFromFilter && getComparableType(other.type) === type);
+	}
 	/**
 	* Aliases for names `eOperators.ToString()` can produce that are not operators
 	* in their own right. `Not` is the bare negation flag (i.e. "not equal to"),
@@ -891,8 +941,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		return OPERATOR_ALIASES[normalized] ?? normalized;
 	}
 
-//#endregion
-//#region src/filter/tree.ts
+// src/filter/tree.ts
 /**
 	* Creates the default empty filter: a single `and` group with no conditions.
 	*/
@@ -979,10 +1028,40 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		let arity = getOperatorArity(normalizeOperator(item.operator));
 		if (arity === "none") return true;
 		if (item.value === null || item.value === void 0 || item.value === "") return false;
-		if (arity === "pair") return Array.isArray(item.value) && item.value.length === 2 && item.value.every((v) => v !== "" && v != null);
+		if (arity === "pair") return Array.isArray(item.value) && item.value.length === 2 && item.value.every((v) => {
+			let end = isRangeEnd(v) ? v.value : v;
+			return end !== "" && end != null;
+		});
 		if (arity === "list") return Array.isArray(item.value) && item.value.length > 0;
 		return true;
 	}
+	/** Whether a range value end is a `FilterRangeEnd` rather than a plain value. */
+	function isRangeEnd(value) {
+		return typeof value === "object" && value !== null && !(value instanceof Date) && "valueType" in value;
+	}
+	/** Dynamic values the framework has no `eDynamicValue` member for. */
+	const DYNAMIC_VALUES_WITHOUT_FRAMEWORK_SUPPORT = /* @__PURE__ */ new Set([
+		"Now",
+		"DayAfterTomorrow",
+		"TwoWeeksAway"
+	]);
+	function needsConversion(valueType, value) {
+		if (valueType === "column") return true;
+		return valueType === "special" && typeof value === "string" && DYNAMIC_VALUES_WITHOUT_FRAMEWORK_SUPPORT.has(value);
+	}
+	/**
+	* True when the filter holds something the framework's data API cannot read
+	* from a filter object: another column, a range end that is not a plain value,
+	* one of the dates only the Windows editor offers, or a whole-period check. Such a filter must be
+	* converted with `convertFilter` and sent as a filter string.
+	*/
+	function needsFilterString(filter) {
+		if (!filter) return false;
+		if (isGroup(filter)) return filter.items.some(needsFilterString);
+		if (PERIOD_OPERATORS.includes(normalizeOperator(filter.operator))) return true;
+		if (needsConversion(filter.valueType, filter.value)) return true;
+		return Array.isArray(filter.value) && filter.value.some((item) => isRangeEnd(item));
+	}
 	/**
 	* Creates an expression for a field, using the field's default operator and an
 	* empty value of the right shape.
@@ -1013,8 +1092,9 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		let previousArity = getOperatorArity(normalizeOperator(expression.operator));
 		let arity = getOperatorArity(operator);
 		let value = expression.value;
-		if (arity !== previousArity) value = createEmptyValue(operator);
-		let valueType = expression.valueType === "special" && arity === previousArity ? "special" : getValueType(field, operator);
+		let holdsColumn = expression.valueType === "column" || Array.isArray(value) && value.some((item) => isRangeEnd(item) && item.valueType === "column");
+		if (arity !== previousArity || holdsColumn && !supportsColumnValue(operator)) value = createEmptyValue(operator);
+		let valueType = (expression.valueType === "special" || expression.valueType === "column") && value === expression.value ? expression.valueType : getValueType(field, operator);
 		return {
 			...expression,
 			operator,
@@ -1080,8 +1160,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		return insertNodeAtPath(filter, path, createEmptyGroup(parent && isGroup(parent) && parent.mode === "and" ? "or" : "and"));
 	}
 
-//#endregion
-//#region src/filter/convertFilter.ts
+// src/filter/convertFilter.ts
 	const CONVERT_URL = "/api/filter/convert";
 	/**
 	* Converts between a structured filter and a DevExpress filter string.
@@ -1106,8 +1185,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		};
 	}
 
-//#endregion
-//#region src/filter/describeFilter.ts
+// src/filter/describeFilter.ts
 /**
 	* Builds a human-readable description of a filter, without contacting the
 	* server. Use this for read-only summaries; the authoritative filter string is
@@ -1135,18 +1213,19 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		let label = getOperatorLabel(operator, field?.type);
 		let arity = getOperatorArity(operator);
 		if (arity === "none") return `[${caption}] ${label}`;
-		return `[${caption}] ${label} ${formatValue(expression, arity)}`;
+		return `[${caption}] ${label} ${formatValue(expression, arity, fields)}`;
 	}
-	function formatValue(expression, arity) {
+	function formatValue(expression, arity, fields) {
 		let { value, valueType } = expression;
-		if (valueType === "special" && typeof value === "string") return getDynamicValueLabel(value);
 		if (Array.isArray(value)) {
-			let formatted = value.map((item) => formatScalar(item, valueType));
+			let formatted = value.map((item) => isRangeEnd(item) ? formatScalar(item.value, item.valueType, fields) : formatScalar(item, valueType, fields));
 			return arity === "pair" ? formatted.join(" - ") : `(${formatted.join(", ")})`;
 		}
-		return formatScalar(value, valueType);
+		return formatScalar(value, valueType, fields);
 	}
-	function formatScalar(value, valueType) {
+	function formatScalar(value, valueType, fields) {
+		if (valueType === "special" && typeof value === "string") return getDynamicValueLabel(value);
+		if (valueType === "column" && typeof value === "string") return `[${fields.get(value.toLowerCase())?.caption ?? value}]`;
 		if (value === null || value === void 0) return "";
 		if (value instanceof Date) return value.toISOString().slice(0, 10);
 		if (typeof value === "number" || typeof value === "boolean") return String(value);
@@ -1154,8 +1233,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		return `'${String(value)}'`;
 	}
 
-//#endregion
-//#region src/filter/fields.ts
+// src/filter/fields.ts
 	const FIELD_TYPES = [
 		"string",
 		"number",
@@ -1190,8 +1268,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		return records.map(toFieldMetadata).filter((field) => field.name !== "" && !field.excludeFromFilter).sort((a, b) => a.name.localeCompare(b.name));
 	}
 
-//#endregion
-//#region src/filter/standardLayout.ts
+// src/filter/standardLayout.ts
 /**
 	* The "standard layout" is the simplified shape the Windows filter editor can
 	* render in its flow view: an outer `or` group whose items are `and` groups of
@@ -1273,8 +1350,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		for (let child of item.items) collectExpressions(child, into);
 	}
 
-//#endregion
-//#region src/filter/savedFilters.ts
+// src/filter/savedFilters.ts
 /**
 	* `sviw_Database_MyFilters` unions in a synthetic "No Filter" row so the Windows
 	* tree can render a "no filter" entry. It is not a real filter and must be
@@ -1373,8 +1449,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 	*/
 	const canSetCrossDomain = canRenameSavedFilter;
 
-//#endregion
-//#region src/getUserImage.ts
+// src/getUserImage.ts
 	const sizeMap = {
 		xs: 64,
 		sm: 128,
@@ -1389,8 +1464,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		return `/api/data/blob/EmployeesLookup/${primKeyOrOptions}/Image/${encodeURIComponent(login ?? "")}${login ? "." : ""}${encodeURIComponent(hash)}.jpg${sizePx ? `?width=${sizePx}` : ""}`;
 	}
 
-//#endregion
-//#region src/localize.ts
+// src/localize.ts
 /**
 	* Localization function for tagged templates. Replaces the arguments
 	* with $n, where n is the index, before asking Appframe to translate
@@ -1414,8 +1488,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		return localized;
 	}
 
-//#endregion
-//#region src/report/recordSource.ts
+// src/report/recordSource.ts
 	const XML_ENTITIES = {
 		amp: "&",
 		lt: "<",
@@ -1501,8 +1574,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		};
 	}
 
-//#endregion
-//#region src/report/parameters.ts
+// src/report/parameters.ts
 /**
 	* Report parameters: mapping the metadata records onto something renderable,
 	* and the XML the parameter values are stored as on a saved filter.
@@ -1655,8 +1727,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		return values;
 	}
 
-//#endregion
-//#region src/report/parameterDefaults.ts
+// src/report/parameterDefaults.ts
 /**
 	* Resolving report parameter defaults that name a stored procedure.
 	*
@@ -1718,8 +1789,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		return row;
 	}
 
-//#endregion
-//#region src/report/render.ts
+// src/report/render.ts
 /**
 	* Rendering a report through the framework's report route.
 	*
@@ -1923,8 +1993,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		}));
 	}
 
-//#endregion
-//#region src/report/report.ts
+// src/report/report.ts
 /**
 	* Mapping a `sviw_WinClient_MyReports` record onto the report model, including
 	* which output formats the report offers.
@@ -1968,8 +2037,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		};
 	}
 
-//#endregion
-//#region src/alert.ts
+// src/alert.ts
 	const template = `
 	<dialog class="alert-dialog">
 			<form method="dialog">
@@ -2080,8 +2148,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		});
 	}
 
-//#endregion
-//#region src/settings.ts
+// src/settings.ts
 	function getKey(article) {
 		return `${article ?? window.af?.article?.id ?? window.window?.location.pathname.substring(1).split("/")[0]}.${window.af?.userSession.login ?? "anonymous"}`;
 	}
@@ -2101,13 +2168,12 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		localStorage.setItem(key, JSON.stringify(userSettings));
 	}
 
-//#endregion
-//#region src/index.ts
+// src/index.ts
 	const version = "2.15.2";
 
-//#endregion
 exports.ConfirmButtons = ConfirmButtons;
 exports.NO_FILTER_ID = NO_FILTER_ID;
+exports.PERIOD_OPERATORS = PERIOD_OPERATORS;
 exports.RELATIVE_DATE_VALUES = RELATIVE_DATE_VALUES;
 exports.SessionHandler = SessionHandler;
 exports.UserSession = UserSession;
@@ -2137,6 +2203,7 @@ exports.encodeXml = encodeXml;
 exports.expose = expose;
 exports.fetchParameterDefault = fetchParameterDefault;
 exports.findSavedFilter = findSavedFilter;
+exports.getColumnsForField = getColumnsForField;
 exports.getDefaultOperator = getDefaultOperator;
 exports.getDefaultParameterValues = getDefaultParameterValues;
 exports.getDynamicValueLabel = getDynamicValueLabel;
@@ -2162,12 +2229,14 @@ exports.isEmptyFilter = isEmptyFilter;
 exports.isExpression = isExpression;
 exports.isGroup = isGroup;
 exports.isProcedureDefault = isProcedureDefault;
+exports.isRangeEnd = isRangeEnd;
 exports.isStandardLayout = isStandardLayout;
 exports.localStorage = localStorage_default;
 exports.localize = localize;
 exports.logActivity = logActivity;
 exports.logError = logError;
 exports.mitt = mitt_default;
+exports.needsFilterString = needsFilterString;
 exports.normalizeOperator = normalizeOperator;
 exports.openAlertDialog = openAlertDialog;
 exports.openReport = openReport;
@@ -2187,6 +2256,7 @@ exports.saveSettings = saveSettings;
 exports.serializeParameters = serializeParameters;
 exports.setGroupMode = setGroupMode;
 exports.startActivity = startActivity;
+exports.supportsColumnValue = supportsColumnValue;
 exports.time = time;
 exports.toFieldMetadata = toFieldMetadata;
 exports.toFieldMetadataList = toFieldMetadataList;