@protobase/layout 0.22.6 → 0.22.8

package/dist/block-specs.js

@@ -109,6 +109,7 @@ const blockSpecs = {
 			resource: required("text"),
 			filter: optional("text"),
 			groupBy: required("text"),
+			splitBy: optional("text"),
 			type: optional("chartType"),
 			sum: optional("text"),
 			average: optional("text"),

package/dist/blocks.d.ts

@@ -98,6 +98,8 @@ export type ChartProps = Heading & {
   groupBy: string;
   /** Default `bar`; `line` is for a date `groupBy`, `donut` for one of values. */
   type?: ChartType;
+  /** With a date `groupBy`: a filterable field of values that splits each bucket, as stacked bars or a line per value, its 8 largest values and the rest as Other; an index must serve it. */
+  splitBy?: string;
   /** A numeric field each group adds up, instead of counting its records. */
   sum?: string;
   /** A numeric field each group averages, instead of counting its records. */

package/dist/check-chart.js

@@ -8,15 +8,24 @@ const ungroupable = ["json", "file"];
 const text = (value) => typeof value === "string" ? value : void 0;
 /** Whether a chart's `groupBy` is a date or timestamp field, which it buckets, rather than a field of values. */
 const isDatedGroup = (field) => field?.type === "date" || field?.type === "timestamp";
-/** The fields a chart reads: the one it groups by, and the one it adds up when it has `sum` or `average`. */
-const chartFields = (node) => [text(node.props.groupBy), text(node.props.sum) ?? text(node.props.average)].filter((name) => name !== void 0);
+/** The fields a chart reads: the one it groups by, the one it splits by, and the one it adds up when it has `sum` or `average`. */
+const chartFields = (node) => [
+	text(node.props.groupBy),
+	text(node.props.splitBy),
+	text(node.props.sum) ?? text(node.props.average)
+].filter((name) => name !== void 0);
 const fieldOf = (model, name) => Object.hasOwn(model.fields, name) ? model.fields[name] : void 0;
-const groupProblems = (model, name) => {
+const groupProblems = (model, name, prop = "groupBy") => {
 	const field = fieldOf(model, name);
-	if (!field) return [`groupBy: unknown field "${name}" on ${model.name}`];
-	if (field.sensitive) return [`groupBy: "${name}" is sensitive, so a chart cannot show its values`];
-	if (ungroupable.includes(field.type)) return [`groupBy: "${name}" is a ${field.type} field, which has no values to group by`];
-	return field.filterable ? [] : [`groupBy: "${name}" is not filterable, so the API refuses to group by it: mark "${name}" .filterable()`];
+	if (!field) return [`${prop}: unknown field "${name}" on ${model.name}`];
+	if (field.sensitive) return [`${prop}: "${name}" is sensitive, so a chart cannot show its values`];
+	if (ungroupable.includes(field.type)) return [`${prop}: "${name}" is a ${field.type} field, which has no values to group by`];
+	return field.filterable ? [] : [`${prop}: "${name}" is not filterable, so the API refuses to group by it: mark "${name}" .filterable()`];
+};
+const splitProblems = (model, name) => {
+	const problems = groupProblems(model, name, "splitBy");
+	if (problems.length > 0) return problems;
+	return isDatedGroup(fieldOf(model, name)) ? [`splitBy: "${name}" is a date field; split by a field of values`] : [];
 };
 const measureProblems = (model, prop, name) => {
 	const field = fieldOf(model, name);
@@ -27,11 +36,19 @@ const measureProblems = (model, prop, name) => {
 const shapeProblems = (node, dated) => {
 	const type = text(node.props.type) ?? "bar";
 	const given = (names) => names.filter((name) => node.props[name] !== void 0);
-	if (dated) return [...type === "donut" ? ["a donut shares out values, so it needs a groupBy of values, not dates"] : [], ...given(["limit"]).map((name) => `"${name}" is for a groupBy of values, not dates`)];
+	if (dated) return [
+		...type === "donut" ? ["a donut shares out values, so it needs a groupBy of values, not dates"] : [],
+		...type === "bar" && node.props.splitBy !== void 0 && node.props.average !== void 0 ? ["a split bar stacks its parts, and averages add up to none: use a line, or count or sum"] : [],
+		...given(["limit"]).map((name) => `"${name}" is for a groupBy of values, not dates`)
+	];
 	return [
 		...type === "line" ? ["a line runs through time, so it needs a date or timestamp groupBy"] : [],
 		...type === "donut" && node.props.average !== void 0 ? ["a donut shares out a total, and averages add up to none: count or sum instead"] : [],
-		...given(["granularity", "range"]).map((name) => `"${name}" is for a date or timestamp groupBy`)
+		...given([
+			"granularity",
+			"range",
+			"splitBy"
+		]).map((name) => `"${name}" is for a date or timestamp groupBy`)
 	];
 };
 /** What a chart names that its resource does not allow: the field it groups by, the one it adds up, and its shape. */
@@ -39,9 +56,11 @@ const chartProblems = (node, model) => {
 	const groupBy = String(node.props.groupBy);
 	const sum = text(node.props.sum);
 	const average = text(node.props.average);
+	const splitBy = text(node.props.splitBy);
 	const grouped = groupProblems(model, groupBy);
 	return [
 		...grouped,
+		...splitBy !== void 0 ? splitProblems(model, splitBy) : [],
 		...sum !== void 0 ? measureProblems(model, "sum", sum) : [],
 		...average !== void 0 ? measureProblems(model, "average", average) : [],
 		...grouped.length === 0 ? shapeProblems(node, isDatedGroup(fieldOf(model, groupBy))) : []

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/layout",
-  "version": "0.22.6",
+  "version": "0.22.8",
   "description": "Composed pages for Protobase, written as JSX that compiles to plain data, with its JSX runtime.",
   "license": "Apache-2.0",
   "repository": {
@@ -31,7 +31,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@protobase/schema": "0.22.6",
+    "@protobase/schema": "0.22.8",
     "aip-parsers": "^1.0.0"
   }
 }