@olenbetong/appframe-ds 1.0.3 → 1.2.0

package/src/filter/fieldFilter.test.ts

@@ -1,158 +1,158 @@
-import type { FieldMetadata, FilterExpression, FilterTree } from "@olenbetong/appframe-core";
-import { describe, expect, test } from "vitest";
-
-import {
-	getFieldExpressions,
-	getInListValues,
-	getSimpleValue,
-	isSimpleFieldFilter,
-	setFieldExpressions,
-	setInListValues,
-	summarizeFieldFilter,
-} from "./fieldFilter.js";
-
-const nameField: FieldMetadata = { name: "Name", caption: "Name", type: "string", nullable: true };
-
-function expression(column: string, operator: string, value: unknown = "x"): FilterExpression {
-	return { type: "expression", column, operator, value } as FilterExpression;
-}
-
-function tree(...items: FilterTree["items"]): FilterTree {
-	return { type: "group", mode: "and", items };
-}
-
-describe("getFieldExpressions", () => {
-	test("returns only top level expressions for the field", () => {
-		let nested = tree(expression("Name", "equals"));
-		let filter = tree(expression("Name", "contains"), expression("Other", "contains"), nested);
-
-		expect(getFieldExpressions(filter, "Name")).toEqual([expression("Name", "contains")]);
-	});
-
-	test("matches the field case insensitively", () => {
-		expect(getFieldExpressions(tree(expression("Name", "contains")), "name")).toHaveLength(1);
-	});
-
-	test("handles a missing filter", () => {
-		expect(getFieldExpressions(null, "Name")).toEqual([]);
-	});
-});
-
-describe("setFieldExpressions", () => {
-	test("replaces the field's expressions in place", () => {
-		let filter = tree(expression("Other", "contains"), expression("Name", "contains"), expression("Third", "equals"));
-		let result = setFieldExpressions(filter, "Name", [expression("Name", "equals", "y")]);
-
-		expect(result.items).toEqual([
-			expression("Other", "contains"),
-			expression("Name", "equals", "y"),
-			expression("Third", "equals"),
-		]);
-	});
-
-	test("removes the field's expressions when given none", () => {
-		let filter = tree(expression("Name", "contains"), expression("Other", "contains"));
-
-		expect(setFieldExpressions(filter, "Name", []).items).toEqual([expression("Other", "contains")]);
-	});
-
-	test("appends when the field has no expressions yet", () => {
-		let filter = tree(expression("Other", "contains"));
-		let result = setFieldExpressions(filter, "Name", [expression("Name", "equals", "y")]);
-
-		expect(result.items).toEqual([expression("Other", "contains"), expression("Name", "equals", "y")]);
-	});
-
-	test("leaves nested groups alone", () => {
-		let nested = tree(expression("Name", "equals"));
-		let result = setFieldExpressions(tree(nested), "Name", []);
-
-		expect(result.items).toEqual([nested]);
-	});
-});
-
-describe("isSimpleFieldFilter", () => {
-	test("is true for a single single-value criterion", () => {
-		expect(isSimpleFieldFilter([expression("Name", "contains")])).toBe(true);
-	});
-
-	test("is false for several criteria", () => {
-		expect(isSimpleFieldFilter([expression("Name", "contains"), expression("Name", "equals")])).toBe(false);
-	});
-
-	test("is false for a list operator", () => {
-		expect(isSimpleFieldFilter([expression("Name", "inlist", ["a"])])).toBe(false);
-	});
-
-	test("is false for a parameterless operator", () => {
-		expect(isSimpleFieldFilter([expression("Name", "isnull", null)])).toBe(false);
-	});
-});
-
-describe("getSimpleValue", () => {
-	test("returns the value of a directly editable criterion", () => {
-		expect(getSimpleValue([expression("Name", "contains", "abc")])).toBe("abc");
-	});
-
-	test("returns an empty string for complex criteria", () => {
-		expect(getSimpleValue([expression("Name", "inlist", ["a"])])).toBe("");
-	});
-});
-
-describe("summarizeFieldFilter", () => {
-	test("is empty without criteria", () => {
-		expect(summarizeFieldFilter([], nameField)).toBe("");
-	});
-
-	test("counts several criteria", () => {
-		expect(summarizeFieldFilter([expression("Name", "contains"), expression("Name", "equals")], nameField)).toBe(
-			"2 criteria",
-		);
-	});
-
-	test("counts the values of a list operator", () => {
-		expect(summarizeFieldFilter([expression("Name", "inlist", ["a", "b"])], nameField)).toContain("(2)");
-	});
-
-	test("shows the operator alone when it takes no value", () => {
-		let summary = summarizeFieldFilter([expression("Name", "isnull", null)], nameField);
-
-		expect(summary).not.toBe("");
-		expect(summary.trim()).toBe(summary);
-	});
-
-	test("shows the operator and value for a single criterion", () => {
-		expect(summarizeFieldFilter([expression("Name", "contains", "abc")], nameField)).toContain("abc");
-	});
-});
-
-describe("in list values", () => {
-	test("reads the values of the in list criterion", () => {
-		expect(getInListValues([expression("Name", "contains"), expression("Name", "inlist", ["a", "b"])])).toEqual([
-			"a",
-			"b",
-		]);
-	});
-
-	test("returns no values when there is no in list criterion", () => {
-		expect(getInListValues([expression("Name", "contains")])).toEqual([]);
-	});
-
-	test("replaces the in list criterion and keeps the others", () => {
-		let result = setInListValues(
-			[expression("Name", "contains"), expression("Name", "inlist", ["a"])],
-			["b"],
-			nameField,
-		);
-
-		expect(result).toHaveLength(2);
-		expect(result[0]).toEqual(expression("Name", "contains"));
-		expect(result[1]?.value).toEqual(["b"]);
-	});
-
-	test("removes the in list criterion when nothing is selected", () => {
-		let result = setInListValues([expression("Name", "inlist", ["a"])], [], nameField);
-
-		expect(result).toEqual([]);
-	});
-});
+import type { FieldMetadata, FilterExpression, FilterTree } from "@olenbetong/appframe-core";
+import { describe, expect, test } from "vitest";
+
+import {
+	getFieldExpressions,
+	getInListValues,
+	getSimpleValue,
+	isSimpleFieldFilter,
+	setFieldExpressions,
+	setInListValues,
+	summarizeFieldFilter,
+} from "./fieldFilter.js";
+
+const nameField: FieldMetadata = { name: "Name", caption: "Name", type: "string", nullable: true };
+
+function expression(column: string, operator: string, value: unknown = "x"): FilterExpression {
+	return { type: "expression", column, operator, value } as FilterExpression;
+}
+
+function tree(...items: FilterTree["items"]): FilterTree {
+	return { type: "group", mode: "and", items };
+}
+
+describe("getFieldExpressions", () => {
+	test("returns only top level expressions for the field", () => {
+		let nested = tree(expression("Name", "equals"));
+		let filter = tree(expression("Name", "contains"), expression("Other", "contains"), nested);
+
+		expect(getFieldExpressions(filter, "Name")).toEqual([expression("Name", "contains")]);
+	});
+
+	test("matches the field case insensitively", () => {
+		expect(getFieldExpressions(tree(expression("Name", "contains")), "name")).toHaveLength(1);
+	});
+
+	test("handles a missing filter", () => {
+		expect(getFieldExpressions(null, "Name")).toEqual([]);
+	});
+});
+
+describe("setFieldExpressions", () => {
+	test("replaces the field's expressions in place", () => {
+		let filter = tree(expression("Other", "contains"), expression("Name", "contains"), expression("Third", "equals"));
+		let result = setFieldExpressions(filter, "Name", [expression("Name", "equals", "y")]);
+
+		expect(result.items).toEqual([
+			expression("Other", "contains"),
+			expression("Name", "equals", "y"),
+			expression("Third", "equals"),
+		]);
+	});
+
+	test("removes the field's expressions when given none", () => {
+		let filter = tree(expression("Name", "contains"), expression("Other", "contains"));
+
+		expect(setFieldExpressions(filter, "Name", []).items).toEqual([expression("Other", "contains")]);
+	});
+
+	test("appends when the field has no expressions yet", () => {
+		let filter = tree(expression("Other", "contains"));
+		let result = setFieldExpressions(filter, "Name", [expression("Name", "equals", "y")]);
+
+		expect(result.items).toEqual([expression("Other", "contains"), expression("Name", "equals", "y")]);
+	});
+
+	test("leaves nested groups alone", () => {
+		let nested = tree(expression("Name", "equals"));
+		let result = setFieldExpressions(tree(nested), "Name", []);
+
+		expect(result.items).toEqual([nested]);
+	});
+});
+
+describe("isSimpleFieldFilter", () => {
+	test("is true for a single single-value criterion", () => {
+		expect(isSimpleFieldFilter([expression("Name", "contains")])).toBe(true);
+	});
+
+	test("is false for several criteria", () => {
+		expect(isSimpleFieldFilter([expression("Name", "contains"), expression("Name", "equals")])).toBe(false);
+	});
+
+	test("is false for a list operator", () => {
+		expect(isSimpleFieldFilter([expression("Name", "inlist", ["a"])])).toBe(false);
+	});
+
+	test("is false for a parameterless operator", () => {
+		expect(isSimpleFieldFilter([expression("Name", "isnull", null)])).toBe(false);
+	});
+});
+
+describe("getSimpleValue", () => {
+	test("returns the value of a directly editable criterion", () => {
+		expect(getSimpleValue([expression("Name", "contains", "abc")])).toBe("abc");
+	});
+
+	test("returns an empty string for complex criteria", () => {
+		expect(getSimpleValue([expression("Name", "inlist", ["a"])])).toBe("");
+	});
+});
+
+describe("summarizeFieldFilter", () => {
+	test("is empty without criteria", () => {
+		expect(summarizeFieldFilter([], nameField)).toBe("");
+	});
+
+	test("counts several criteria", () => {
+		expect(summarizeFieldFilter([expression("Name", "contains"), expression("Name", "equals")], nameField)).toBe(
+			"2 criteria",
+		);
+	});
+
+	test("counts the values of a list operator", () => {
+		expect(summarizeFieldFilter([expression("Name", "inlist", ["a", "b"])], nameField)).toContain("(2)");
+	});
+
+	test("shows the operator alone when it takes no value", () => {
+		let summary = summarizeFieldFilter([expression("Name", "isnull", null)], nameField);
+
+		expect(summary).not.toBe("");
+		expect(summary.trim()).toBe(summary);
+	});
+
+	test("shows the operator and value for a single criterion", () => {
+		expect(summarizeFieldFilter([expression("Name", "contains", "abc")], nameField)).toContain("abc");
+	});
+});
+
+describe("in list values", () => {
+	test("reads the values of the in list criterion", () => {
+		expect(getInListValues([expression("Name", "contains"), expression("Name", "inlist", ["a", "b"])])).toEqual([
+			"a",
+			"b",
+		]);
+	});
+
+	test("returns no values when there is no in list criterion", () => {
+		expect(getInListValues([expression("Name", "contains")])).toEqual([]);
+	});
+
+	test("replaces the in list criterion and keeps the others", () => {
+		let result = setInListValues(
+			[expression("Name", "contains"), expression("Name", "inlist", ["a"])],
+			["b"],
+			nameField,
+		);
+
+		expect(result).toHaveLength(2);
+		expect(result[0]).toEqual(expression("Name", "contains"));
+		expect(result[1]?.value).toEqual(["b"]);
+	});
+
+	test("removes the in list criterion when nothing is selected", () => {
+		let result = setInListValues([expression("Name", "inlist", ["a"])], [], nameField);
+
+		expect(result).toEqual([]);
+	});
+});

package/src/filter/fieldFilter.ts

@@ -1,139 +1,139 @@
-import {
-	type FieldMetadata,
-	type FilterExpression,
-	type FilterOperator,
-	type FilterTree,
-	getLocalizedString,
-	getOperatorArity,
-	getOperatorLabel,
-	getValueType,
-	isExpression,
-	normalizeOperator,
-} from "@olenbetong/appframe-core";
-
-/**
- * The criteria a header filter owns for a field: the expressions directly in
- * the filter's root group that filter on that field.
- *
- * Expressions nested inside sub-groups are deliberately left out. A header
- * filter is a flat list of criteria combined with the root group's operator, so
- * it cannot represent a nested group without silently changing its meaning.
- * Those stay editable in the filter builder only.
- */
-export function getFieldExpressions(filter: FilterTree | null | undefined, field: string): FilterExpression[] {
-	if (!filter) return [];
-
-	let lowerField = field.toLowerCase();
-
-	return filter.items.filter(
-		(item): item is FilterExpression => isExpression(item) && item.column?.toLowerCase() === lowerField,
-	);
-}
-
-/**
- * Returns a copy of the tree where the field's top-level expressions have been
- * replaced by `expressions`, keeping the position of the first one so criteria
- * do not jump around while they are edited.
- */
-export function setFieldExpressions(filter: FilterTree, field: string, expressions: FilterExpression[]): FilterTree {
-	let lowerField = field.toLowerCase();
-	let isOwn = (item: FilterTree["items"][number]) => isExpression(item) && item.column?.toLowerCase() === lowerField;
-	let firstIndex = filter.items.findIndex(isOwn);
-	let others = filter.items.filter((item) => !isOwn(item));
-
-	if (expressions.length === 0) {
-		return { ...filter, items: others };
-	}
-
-	let insertAt = firstIndex === -1 ? others.length : Math.min(firstIndex, others.length);
-	let items = [...others.slice(0, insertAt), ...expressions, ...others.slice(insertAt)];
-
-	return { ...filter, items };
-}
-
-/**
- * True when the criteria can be edited straight from the header input: exactly
- * one criterion, taking exactly one literal value.
- */
-export function isSimpleFieldFilter(expressions: FilterExpression[]): boolean {
-	if (expressions.length !== 1) return false;
-
-	let expression = expressions[0] as FilterExpression;
-
-	return getOperatorArity(normalizeOperator(expression.operator)) === "single" && expression.valueType !== "special";
-}
-
-function toDisplayValue(value: FilterExpression["value"]): string {
-	if (value === null || value === undefined) return "";
-	if (value instanceof Date) return value.toLocaleDateString();
-	if (Array.isArray(value)) return value.join(", ");
-
-	return String(value);
-}
-
-/** The value shown in the header input when the criteria are directly editable. */
-export function getSimpleValue(expressions: FilterExpression[]): string {
-	return isSimpleFieldFilter(expressions) ? toDisplayValue((expressions[0] as FilterExpression).value) : "";
-}
-
-/**
- * Short read-only description of a field's criteria, shown in the header input
- * when they are too complex to edit inline — e.g. `In list (3)`.
- */
-export function summarizeFieldFilter(expressions: FilterExpression[], field?: FieldMetadata): string {
-	if (expressions.length === 0) return "";
-
-	if (expressions.length > 1) {
-		return getLocalizedString("{0} criteria").replace("{0}", String(expressions.length));
-	}
-
-	let expression = expressions[0] as FilterExpression;
-	let operator = normalizeOperator(expression.operator);
-	let label = getOperatorLabel(operator, field?.type);
-	let arity = getOperatorArity(operator);
-
-	if (arity === "none") return label;
-
-	if (arity === "list") {
-		let count = Array.isArray(expression.value) ? expression.value.length : 0;
-
-		return `${label} (${count})`;
-	}
-
-	return `${label} ${toDisplayValue(expression.value)}`.trim();
-}
-
-/**
- * The values of the field's `inlist` criterion, which is what the distinct
- * value checkbox list edits. Everything else in the panel is a normal
- * criterion row.
- */
-export function getInListValues(expressions: FilterExpression[]): string[] {
-	let inList = expressions.find((expression) => normalizeOperator(expression.operator) === "inlist");
-
-	return Array.isArray(inList?.value) ? inList.value.map(String) : [];
-}
-
-/**
- * Replaces the field's `inlist` criterion with one holding `values`, or removes
- * it when the selection is empty.
- */
-export function setInListValues(
-	expressions: FilterExpression[],
-	values: string[],
-	field: FieldMetadata,
-): FilterExpression[] {
-	let others = expressions.filter((expression) => normalizeOperator(expression.operator) !== "inlist");
-
-	if (values.length === 0) return others;
-
-	let inList: FilterExpression = {
-		type: "expression",
-		column: field.name,
-		operator: "inlist" satisfies FilterOperator,
-		value: values,
-		valueType: getValueType(field, "inlist"),
-	};
-
-	return [...others, inList];
-}
+import {
+	type FieldMetadata,
+	type FilterExpression,
+	type FilterOperator,
+	type FilterTree,
+	getOperatorArity,
+	getOperatorLabel,
+	getValueType,
+	isExpression,
+	normalizeOperator,
+} from "@olenbetong/appframe-core";
+import { getLocalizedString } from "../i18n.js";
+
+/**
+ * The criteria a header filter owns for a field: the expressions directly in
+ * the filter's root group that filter on that field.
+ *
+ * Expressions nested inside sub-groups are deliberately left out. A header
+ * filter is a flat list of criteria combined with the root group's operator, so
+ * it cannot represent a nested group without silently changing its meaning.
+ * Those stay editable in the filter builder only.
+ */
+export function getFieldExpressions(filter: FilterTree | null | undefined, field: string): FilterExpression[] {
+	if (!filter) return [];
+
+	let lowerField = field.toLowerCase();
+
+	return filter.items.filter(
+		(item): item is FilterExpression => isExpression(item) && item.column?.toLowerCase() === lowerField,
+	);
+}
+
+/**
+ * Returns a copy of the tree where the field's top-level expressions have been
+ * replaced by `expressions`, keeping the position of the first one so criteria
+ * do not jump around while they are edited.
+ */
+export function setFieldExpressions(filter: FilterTree, field: string, expressions: FilterExpression[]): FilterTree {
+	let lowerField = field.toLowerCase();
+	let isOwn = (item: FilterTree["items"][number]) => isExpression(item) && item.column?.toLowerCase() === lowerField;
+	let firstIndex = filter.items.findIndex(isOwn);
+	let others = filter.items.filter((item) => !isOwn(item));
+
+	if (expressions.length === 0) {
+		return { ...filter, items: others };
+	}
+
+	let insertAt = firstIndex === -1 ? others.length : Math.min(firstIndex, others.length);
+	let items = [...others.slice(0, insertAt), ...expressions, ...others.slice(insertAt)];
+
+	return { ...filter, items };
+}
+
+/**
+ * True when the criteria can be edited straight from the header input: exactly
+ * one criterion, taking exactly one literal value.
+ */
+export function isSimpleFieldFilter(expressions: FilterExpression[]): boolean {
+	if (expressions.length !== 1) return false;
+
+	let expression = expressions[0] as FilterExpression;
+
+	return getOperatorArity(normalizeOperator(expression.operator)) === "single" && expression.valueType !== "special";
+}
+
+function toDisplayValue(value: FilterExpression["value"]): string {
+	if (value === null || value === undefined) return "";
+	if (value instanceof Date) return value.toLocaleDateString();
+	if (Array.isArray(value)) return value.join(", ");
+
+	return String(value);
+}
+
+/** The value shown in the header input when the criteria are directly editable. */
+export function getSimpleValue(expressions: FilterExpression[]): string {
+	return isSimpleFieldFilter(expressions) ? toDisplayValue((expressions[0] as FilterExpression).value) : "";
+}
+
+/**
+ * Short read-only description of a field's criteria, shown in the header input
+ * when they are too complex to edit inline — e.g. `In list (3)`.
+ */
+export function summarizeFieldFilter(expressions: FilterExpression[], field?: FieldMetadata): string {
+	if (expressions.length === 0) return "";
+
+	if (expressions.length > 1) {
+		return getLocalizedString("{0} criteria").replace("{0}", String(expressions.length));
+	}
+
+	let expression = expressions[0] as FilterExpression;
+	let operator = normalizeOperator(expression.operator);
+	let label = getOperatorLabel(operator, field?.type);
+	let arity = getOperatorArity(operator);
+
+	if (arity === "none") return label;
+
+	if (arity === "list") {
+		let count = Array.isArray(expression.value) ? expression.value.length : 0;
+
+		return `${label} (${count})`;
+	}
+
+	return `${label} ${toDisplayValue(expression.value)}`.trim();
+}
+
+/**
+ * The values of the field's `inlist` criterion, which is what the distinct
+ * value checkbox list edits. Everything else in the panel is a normal
+ * criterion row.
+ */
+export function getInListValues(expressions: FilterExpression[]): string[] {
+	let inList = expressions.find((expression) => normalizeOperator(expression.operator) === "inlist");
+
+	return Array.isArray(inList?.value) ? inList.value.map(String) : [];
+}
+
+/**
+ * Replaces the field's `inlist` criterion with one holding `values`, or removes
+ * it when the selection is empty.
+ */
+export function setInListValues(
+	expressions: FilterExpression[],
+	values: string[],
+	field: FieldMetadata,
+): FilterExpression[] {
+	let others = expressions.filter((expression) => normalizeOperator(expression.operator) !== "inlist");
+
+	if (values.length === 0) return others;
+
+	let inList: FilterExpression = {
+		type: "expression",
+		column: field.name,
+		operator: "inlist" satisfies FilterOperator,
+		value: values,
+		valueType: getValueType(field, "inlist"),
+	};
+
+	return [...others, inList];
+}

package/src/filter/index.ts

@@ -1,27 +1,27 @@
-export { ChipListInput, type ChipListInputProps } from "./ChipListInput.js";
-export {
-	getFieldExpressions,
-	getInListValues,
-	getSimpleValue,
-	isSimpleFieldFilter,
-	setFieldExpressions,
-	setInListValues,
-	summarizeFieldFilter,
-} from "./fieldFilter.js";
-export { FieldFilterPanel, type FieldFilterPanelProps } from "./FieldFilterPanel.js";
-export { FilterBuilder, type FilterBuilderProps, type SavedFilterValues } from "./FilterBuilder.js";
-export { FilterEditor } from "./FilterEditor.js";
-export { FilterGroupEditor, type FilterGroupEditorProps } from "./FilterGroupEditor.js";
-export { FilterNameDialog, type FilterNameDialogProps } from "./FilterNameDialog.js";
-export { FilterRow, type FilterRowProps } from "./FilterRow.js";
-export { FilterShareDialog, type FilterShareDialogProps } from "./FilterShareDialog.js";
-export { FilterStringField, type FilterStringFieldProps } from "./FilterStringField.js";
-export { FilterValueEditor, type FilterValueEditorProps } from "./FilterValueEditor.js";
-export { SavedFilterTree, type SavedFilterSelection, type SavedFilterTreeProps } from "./SavedFilterTree.js";
-export type { FilterEditorProps, FilterEditorSize, FilterValueOption, GetFieldOptions } from "./types.js";
-export {
-	type DistinctValue,
-	supportsDistinctValues,
-	useDistinctValues,
-	type UseDistinctValuesResult,
-} from "./useDistinctValues.js";
+export { ChipListInput, type ChipListInputProps } from "./ChipListInput.js";
+export {
+	getFieldExpressions,
+	getInListValues,
+	getSimpleValue,
+	isSimpleFieldFilter,
+	setFieldExpressions,
+	setInListValues,
+	summarizeFieldFilter,
+} from "./fieldFilter.js";
+export { FieldFilterPanel, type FieldFilterPanelProps } from "./FieldFilterPanel.js";
+export { FilterBuilder, type FilterBuilderProps, type SavedFilterValues } from "./FilterBuilder.js";
+export { FilterEditor } from "./FilterEditor.js";
+export { FilterGroupEditor, type FilterGroupEditorProps } from "./FilterGroupEditor.js";
+export { FilterNameDialog, type FilterNameDialogProps } from "./FilterNameDialog.js";
+export { FilterRow, type FilterRowProps } from "./FilterRow.js";
+export { FilterShareDialog, type FilterShareDialogProps } from "./FilterShareDialog.js";
+export { FilterStringField, type FilterStringFieldProps } from "./FilterStringField.js";
+export { FilterValueEditor, type FilterValueEditorProps } from "./FilterValueEditor.js";
+export { SavedFilterTree, type SavedFilterSelection, type SavedFilterTreeProps } from "./SavedFilterTree.js";
+export type { FilterEditorProps, FilterEditorSize, FilterValueOption, GetFieldOptions } from "./types.js";
+export {
+	type DistinctValue,
+	supportsDistinctValues,
+	useDistinctValues,
+	type UseDistinctValuesResult,
+} from "./useDistinctValues.js";