@object-ui/plugin-report 17.5.0 → 17.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +333 -0
- package/README.md +399 -127
- package/dist/DatasetReportRenderer.d.ts +13 -0
- package/dist/index.js +414 -373
- package/dist/index.umd.cjs +2 -2
- package/dist/useDatasetDimensionLabels.d.ts +12 -1
- package/package.json +11 -11
|
@@ -84,6 +84,17 @@ interface DatasetReportLike {
|
|
|
84
84
|
columns?: string[];
|
|
85
85
|
values?: string[];
|
|
86
86
|
runtimeFilter?: Record<string, unknown>;
|
|
87
|
+
/**
|
|
88
|
+
* ⛔ NOT an authorable key, and NEVER applied as a filter (objectui#5137).
|
|
89
|
+
*
|
|
90
|
+
* `ReportSchema` (`@objectstack/spec`) is `z.core.$strict` and rejects
|
|
91
|
+
* `filter` outright, naming the replacement itself
|
|
92
|
+
* (`Did you mean … → runtimeFilter?`) — so a document carrying it did not
|
|
93
|
+
* arrive through the validated path. It stays declared for exactly one reason:
|
|
94
|
+
* so {@link warnOnRejectedFilterAlias} can SEE it on a stored document and
|
|
95
|
+
* say out loud that no filter was applied. Reading it AS a scope filter is
|
|
96
|
+
* the consumer tolerance this card removed. Author `runtimeFilter`.
|
|
97
|
+
*/
|
|
87
98
|
filter?: Record<string, unknown>;
|
|
88
99
|
/**
|
|
89
100
|
* Result ordering, most significant key first (framework#3916). Each `by`
|
|
@@ -117,6 +128,8 @@ export interface DatasetReportRendererProps {
|
|
|
117
128
|
}
|
|
118
129
|
/** `true` when this report should render through the dataset path. */
|
|
119
130
|
export declare function isDatasetReport(value: unknown): value is DatasetReportLike;
|
|
131
|
+
/** Reset the warn-once memo. Exported for tests. */
|
|
132
|
+
export declare function resetReportFilterAliasWarnings(): void;
|
|
120
133
|
/**
|
|
121
134
|
* Resolve a report's declared `type` — the spec's `ReportType`
|
|
122
135
|
* (`ui/report.zod.ts`: `tabular | summary | matrix | joined`) — to the
|