@olenbetong/appframe-ds 1.7.2 → 1.9.0

package/src/filter/types.ts

@@ -1,38 +1,38 @@
-import type { FieldMetadata, FilterTree } from "@olenbetong/appframe-core";
-
-/** A selectable value for a field that has a fixed list of values. */
-export type FilterValueOption = {
-	value: string;
-	label?: string;
-};
-
-/**
- * Resolves the list of values offered in the value editor for a field. Return
- * `undefined` to fall back to a free text editor.
- *
- * Lookup fields carry a `valueListRecordSource` in their metadata, but loading
- * that record source needs a data object, which is out of scope for this
- * component. Supply the options from the outside instead.
- */
-export type GetFieldOptions = (field: FieldMetadata) => FilterValueOption[] | undefined;
-
-export type FilterEditorSize = "sm" | "md" | "lg";
-
-export type FilterEditorProps = {
-	/** The fields the user can filter on. Fields with `excludeFromFilter` are hidden. */
-	fields: FieldMetadata[];
-	/** The filter tree. Use together with `onChange` for a controlled component. */
-	value?: FilterTree | null;
-	/** The initial filter tree when uncontrolled. */
-	defaultValue?: FilterTree | null;
-	onChange?: (filter: FilterTree) => void;
-	/** Renders the tree without any editing affordances. */
-	readOnly?: boolean;
-	/** Shows the filter string below the tree, editable unless `readOnly`. */
-	showFilterString?: boolean;
-	/** View the filter applies to. Passed to the conversion endpoint. */
-	viewName?: string;
-	getFieldOptions?: GetFieldOptions;
-	className?: string;
-	"data-size"?: FilterEditorSize;
-};
+import type { FieldMetadata, FilterTree } from "@olenbetong/appframe-core";
+
+/** A selectable value for a field that has a fixed list of values. */
+export type FilterValueOption = {
+	value: string;
+	label?: string;
+};
+
+/**
+ * Resolves the list of values offered in the value editor for a field. Return
+ * `undefined` to fall back to a free text editor.
+ *
+ * Lookup fields carry a `valueListRecordSource` in their metadata, but loading
+ * that record source needs a data object, which is out of scope for this
+ * component. Supply the options from the outside instead.
+ */
+export type GetFieldOptions = (field: FieldMetadata) => FilterValueOption[] | undefined;
+
+export type FilterEditorSize = "sm" | "md" | "lg";
+
+export type FilterEditorProps = {
+	/** The fields the user can filter on. Fields with `excludeFromFilter` are hidden. */
+	fields: FieldMetadata[];
+	/** The filter tree. Use together with `onChange` for a controlled component. */
+	value?: FilterTree | null;
+	/** The initial filter tree when uncontrolled. */
+	defaultValue?: FilterTree | null;
+	onChange?: (filter: FilterTree) => void;
+	/** Renders the tree without any editing affordances. */
+	readOnly?: boolean;
+	/** Shows the filter string below the tree, editable unless `readOnly`. */
+	showFilterString?: boolean;
+	/** View the filter applies to. Passed to the conversion endpoint. */
+	viewName?: string;
+	getFieldOptions?: GetFieldOptions;
+	className?: string;
+	"data-size"?: FilterEditorSize;
+};

package/src/filter/useDistinctValues.test.ts

@@ -1,102 +1,102 @@
-import type { FieldMetadata, FilterExpression, FilterTree } from "@olenbetong/appframe-core";
-import { describe, expect, test } from "vitest";
-
-import { buildDistinctParameters } from "./useDistinctValues.js";
-
-const field: FieldMetadata = { name: "Name", caption: "Name", type: "string", nullable: true };
-
-function expression(column: string, value = "x"): FilterExpression {
-	return { type: "expression", column, operator: "contains", value } as FilterExpression;
-}
-
-function tree(...items: FilterTree["items"]): FilterTree {
-	return { type: "group", mode: "and", items };
-}
-
-describe("buildDistinctParameters", () => {
-	test("groups by the field and counts another field", () => {
-		let parameters = buildDistinctParameters({
-			field,
-			countField: "PrimKey",
-			filter: null,
-			withCounts: true,
-		});
-
-		expect(parameters.fields).toEqual([{ name: "Name" }, { name: "PrimKey", aggregate: "COUNT" }]);
-		expect(parameters).toMatchObject({ groupBy: ["Name"], sortOrder: [{ Name: "asc" }] });
-		expect(parameters).not.toHaveProperty("distinctRows");
-	});
-
-	test("falls back to a plain distinct list without counts", () => {
-		let parameters = buildDistinctParameters({
-			field,
-			countField: "PrimKey",
-			filter: null,
-			withCounts: false,
-		});
-
-		expect(parameters.fields).toEqual([{ name: "Name" }]);
-		expect(parameters).toMatchObject({ distinctRows: true });
-		expect(parameters).not.toHaveProperty("groupBy");
-	});
-
-	test("has no counts when no other field is available to count", () => {
-		let parameters = buildDistinctParameters({ field, countField: null, filter: null, withCounts: true });
-
-		expect(parameters.fields).toEqual([{ name: "Name" }]);
-		expect(parameters).toMatchObject({ distinctRows: true });
-	});
-
-	test("keeps other criteria but drops the field's own", () => {
-		let filter = tree(expression("Name"), expression("Other"));
-		let parameters = buildDistinctParameters({ field, countField: "PrimKey", filter, withCounts: true });
-
-		expect(parameters.filterObject).toEqual(tree(expression("Other")));
-	});
-
-	test("has no filter when the field owns every criterion", () => {
-		let parameters = buildDistinctParameters({
-			field,
-			countField: "PrimKey",
-			filter: tree(expression("Name")),
-			withCounts: true,
-		});
-
-		expect(parameters.filterObject).toBe(null);
-	});
-
-	test("adds the search text as a criterion on the field", () => {
-		let parameters = buildDistinctParameters({
-			field,
-			countField: "PrimKey",
-			filter: null,
-			search: "ab",
-			withCounts: true,
-		});
-
-		expect(parameters.filterObject).toMatchObject({
-			type: "group",
-			items: [{ column: "Name", operator: "contains", value: "ab" }],
-		});
-	});
-
-	test("combines the search text with the other criteria", () => {
-		let parameters = buildDistinctParameters({
-			field,
-			countField: "PrimKey",
-			filter: tree(expression("Other")),
-			search: "ab",
-			withCounts: true,
-		});
-
-		expect(parameters.filterObject).toMatchObject({
-			items: [tree(expression("Other")), { column: "Name", value: "ab" }],
-		});
-	});
-
-	test("caps the number of values loaded", () => {
-		let parameters = buildDistinctParameters({ field, countField: "PrimKey", filter: null, withCounts: true });
-
-		expect(parameters.maxRecords).toBe(200);
-	});
-});
+import type { FieldMetadata, FilterExpression, FilterTree } from "@olenbetong/appframe-core";
+import { describe, expect, test } from "vitest";
+
+import { buildDistinctParameters } from "./useDistinctValues.js";
+
+const field: FieldMetadata = { name: "Name", caption: "Name", type: "string", nullable: true };
+
+function expression(column: string, value = "x"): FilterExpression {
+	return { type: "expression", column, operator: "contains", value } as FilterExpression;
+}
+
+function tree(...items: FilterTree["items"]): FilterTree {
+	return { type: "group", mode: "and", items };
+}
+
+describe("buildDistinctParameters", () => {
+	test("groups by the field and counts another field", () => {
+		let parameters = buildDistinctParameters({
+			field,
+			countField: "PrimKey",
+			filter: null,
+			withCounts: true,
+		});
+
+		expect(parameters.fields).toEqual([{ name: "Name" }, { name: "PrimKey", aggregate: "COUNT" }]);
+		expect(parameters).toMatchObject({ groupBy: ["Name"], sortOrder: [{ Name: "asc" }] });
+		expect(parameters).not.toHaveProperty("distinctRows");
+	});
+
+	test("falls back to a plain distinct list without counts", () => {
+		let parameters = buildDistinctParameters({
+			field,
+			countField: "PrimKey",
+			filter: null,
+			withCounts: false,
+		});
+
+		expect(parameters.fields).toEqual([{ name: "Name" }]);
+		expect(parameters).toMatchObject({ distinctRows: true });
+		expect(parameters).not.toHaveProperty("groupBy");
+	});
+
+	test("has no counts when no other field is available to count", () => {
+		let parameters = buildDistinctParameters({ field, countField: null, filter: null, withCounts: true });
+
+		expect(parameters.fields).toEqual([{ name: "Name" }]);
+		expect(parameters).toMatchObject({ distinctRows: true });
+	});
+
+	test("keeps other criteria but drops the field's own", () => {
+		let filter = tree(expression("Name"), expression("Other"));
+		let parameters = buildDistinctParameters({ field, countField: "PrimKey", filter, withCounts: true });
+
+		expect(parameters.filterObject).toEqual(tree(expression("Other")));
+	});
+
+	test("has no filter when the field owns every criterion", () => {
+		let parameters = buildDistinctParameters({
+			field,
+			countField: "PrimKey",
+			filter: tree(expression("Name")),
+			withCounts: true,
+		});
+
+		expect(parameters.filterObject).toBe(null);
+	});
+
+	test("adds the search text as a criterion on the field", () => {
+		let parameters = buildDistinctParameters({
+			field,
+			countField: "PrimKey",
+			filter: null,
+			search: "ab",
+			withCounts: true,
+		});
+
+		expect(parameters.filterObject).toMatchObject({
+			type: "group",
+			items: [{ column: "Name", operator: "contains", value: "ab" }],
+		});
+	});
+
+	test("combines the search text with the other criteria", () => {
+		let parameters = buildDistinctParameters({
+			field,
+			countField: "PrimKey",
+			filter: tree(expression("Other")),
+			search: "ab",
+			withCounts: true,
+		});
+
+		expect(parameters.filterObject).toMatchObject({
+			items: [tree(expression("Other")), { column: "Name", value: "ab" }],
+		});
+	});
+
+	test("caps the number of values loaded", () => {
+		let parameters = buildDistinctParameters({ field, countField: "PrimKey", filter: null, withCounts: true });
+
+		expect(parameters.maxRecords).toBe(200);
+	});
+});