@multiplatform.one/frappe-ui 7.23.2 → 7.24.0

package/types/insights/InsightsFacetTags.d.ts

@@ -0,0 +1,11 @@
+import type { InsightsCount } from "./insightsData";
+export interface InsightsFacetTagsProps {
+    distribution: readonly InsightsCount[];
+    label: (value: string) => string;
+    tint?: (value: string) => string | undefined;
+    onSelect: (value: string) => void;
+    testID?: string;
+}
+/** A facet's values with their record counts, each opening the list narrowed to it. */
+export declare function InsightsFacetTags({ distribution, label, tint, onSelect, testID, }: InsightsFacetTagsProps): import("react/jsx-runtime").JSX.Element;
+//# sourceMappingURL=InsightsFacetTags.d.ts.map

package/types/insights/InsightsFacetTags.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"InsightsFacetTags.d.ts","sourceRoot":"","sources":["../../src/insights/InsightsFacetTags.tsx"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAqFpD,MAAM,WAAW,sBAAsB;IACrC,YAAY,EAAE,SAAS,aAAa,EAAE,CAAC;IACvC,KAAK,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;IACjC,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAAC;IAC7C,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,uFAAuF;AACvF,wBAAgB,iBAAiB,CAAC,EAChC,YAAY,EACZ,KAAK,EACL,IAAI,EACJ,QAAQ,EACR,MAAM,GACP,EAAE,sBAAsB,2CAoBxB"}

package/types/insights/InsightsKpiBand.d.ts

@@ -0,0 +1,22 @@
+import { type ChartConfig, type KPICardConfig } from "@multiplatform.one/components";
+export interface InsightsTile {
+    id: string;
+    title: string;
+    value: string | number;
+    hint?: string;
+    spark?: number[];
+}
+export interface InsightsKpiBandProps {
+    hero: KPICardConfig;
+    tiles: readonly InsightsTile[];
+    charts: readonly ChartConfig[];
+    testID?: string;
+}
+/**
+ * The hero count with its denser companions, then the charts. Rows wrap on
+ * flexBasis rather than riding the catalog Dashboard grid, whose percent
+ * widths plus its gap overflow a row that sums to 100%. Every child shrinks
+ * so a line narrower than one tile stays inside its frame (LC-10).
+ */
+export declare function InsightsKpiBand({ hero, tiles, charts, testID }: InsightsKpiBandProps): import("react/jsx-runtime").JSX.Element;
+//# sourceMappingURL=InsightsKpiBand.d.ts.map

package/types/insights/InsightsKpiBand.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"InsightsKpiBand.d.ts","sourceRoot":"","sources":["../../src/insights/InsightsKpiBand.tsx"],"names":[],"mappings":"AAAA,OAAO,EAML,KAAK,WAAW,EAChB,KAAK,aAAa,EACnB,MAAM,+BAA+B,CAAC;AAIvC,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,aAAa,CAAC;IACpB,KAAK,EAAE,SAAS,YAAY,EAAE,CAAC;IAC/B,MAAM,EAAE,SAAS,WAAW,EAAE,CAAC;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAwCD;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,oBAAoB,2CA0CpF"}

package/types/insights/InsightsLeaders.d.ts

@@ -0,0 +1,16 @@
+import { type FrappeInsightsMetric, type InsightsRecordView } from "./insightsRecord";
+export interface InsightsLeadersProps<TDoc> {
+    rows: readonly TDoc[];
+    metrics: readonly FrappeInsightsMetric[];
+    record: InsightsRecordView<TDoc>;
+    /** Rows per metric. */
+    count?: number;
+    testID?: string;
+}
+/**
+ * The top records by a metric the reader picks on a contained tab strip,
+ * in one compact read-only DataTable; a row opens its record. Nested cell
+ * chrome uses the compact nestedControl and label type (LC-73).
+ */
+export declare function InsightsLeaders<TDoc>({ rows, metrics, record, count, testID, }: InsightsLeadersProps<TDoc>): import("react/jsx-runtime").JSX.Element | null;
+//# sourceMappingURL=InsightsLeaders.d.ts.map

package/types/insights/InsightsLeaders.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"InsightsLeaders.d.ts","sourceRoot":"","sources":["../../src/insights/InsightsLeaders.tsx"],"names":[],"mappings":"AAOA,OAAO,EAGL,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACxB,MAAM,kBAAkB,CAAC;AAS1B,MAAM,WAAW,oBAAoB,CAAC,IAAI;IACxC,IAAI,EAAE,SAAS,IAAI,EAAE,CAAC;IACtB,OAAO,EAAE,SAAS,oBAAoB,EAAE,CAAC;IACzC,MAAM,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAC;IACjC,uBAAuB;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,EACpC,IAAI,EACJ,OAAO,EACP,MAAM,EACN,KAAS,EACT,MAAM,GACP,EAAE,oBAAoB,CAAC,IAAI,CAAC,kDAwG5B"}

package/types/insights/InsightsRecords.d.ts

@@ -0,0 +1,19 @@
+import type { InsightsRecordView } from "./insightsRecord";
+export interface InsightsRecordTile<TDoc> {
+    id: string;
+    label: string;
+    doc: TDoc;
+    value: string;
+}
+export interface InsightsRecordsProps<TDoc> {
+    tiles: readonly InsightsRecordTile<TDoc>[];
+    record: InsightsRecordView<TDoc>;
+    testID?: string;
+}
+/**
+ * Record holders as quiet fact tiles: the holder's tinted image well, its
+ * title and code, and the value. Nested chrome steps with the compact
+ * nestedControl, not the page's 44px floor (LC-73).
+ */
+export declare function InsightsRecords<TDoc>({ tiles, record, testID }: InsightsRecordsProps<TDoc>): import("react/jsx-runtime").JSX.Element;
+//# sourceMappingURL=InsightsRecords.d.ts.map

package/types/insights/InsightsRecords.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"InsightsRecords.d.ts","sourceRoot":"","sources":["../../src/insights/InsightsRecords.tsx"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAE3D,MAAM,WAAW,kBAAkB,CAAC,IAAI;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,IAAI,CAAC;IACV,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,oBAAoB,CAAC,IAAI;IACxC,KAAK,EAAE,SAAS,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC;IAC3C,MAAM,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,oBAAoB,CAAC,IAAI,CAAC,2CA+C1F"}

package/types/insights/InsightsTable.d.ts

@@ -0,0 +1,17 @@
+import { type FrappeInsightsMetric, type InsightsRecordView } from "./insightsRecord";
+export interface InsightsTableProps<TDoc> {
+    rows: readonly TDoc[];
+    metrics: readonly FrappeInsightsMetric[];
+    record: InsightsRecordView<TDoc>;
+    /** Header of the facet column; without it, no facet column. */
+    facetLabel?: string;
+    pageSize?: number;
+    label: string;
+    testID?: string;
+}
+/**
+ * Every record in the catalog DataTable: sortable metric columns, a pager,
+ * and the stacked card layout below `$sm`. A row opens its record.
+ */
+export declare function InsightsTable<TDoc>({ rows, metrics, record, facetLabel, pageSize, label, testID, }: InsightsTableProps<TDoc>): import("react/jsx-runtime").JSX.Element;
+//# sourceMappingURL=InsightsTable.d.ts.map

package/types/insights/InsightsTable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"InsightsTable.d.ts","sourceRoot":"","sources":["../../src/insights/InsightsTable.tsx"],"names":[],"mappings":"AAMA,OAAO,EAGL,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACxB,MAAM,kBAAkB,CAAC;AAU1B,MAAM,WAAW,kBAAkB,CAAC,IAAI;IACtC,IAAI,EAAE,SAAS,IAAI,EAAE,CAAC;IACtB,OAAO,EAAE,SAAS,oBAAoB,EAAE,CAAC;IACzC,MAAM,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAC;IACjC,+DAA+D;IAC/D,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,EAClC,IAAI,EACJ,OAAO,EACP,MAAM,EACN,UAAU,EACV,QAAY,EACZ,KAAK,EACL,MAAM,GACP,EAAE,kBAAkB,CAAC,IAAI,CAAC,2CA4H1B"}

package/types/insights/insightsData.d.ts

@@ -0,0 +1,45 @@
+/**
+ * The aggregates an insights page draws from the rows one list reads and the
+ * values its facet reading found: no React, no IO.
+ */
+type Row = {
+    name?: string;
+} & Record<string, unknown>;
+export interface InsightsCount {
+    value: string;
+    count: number;
+    /** The folded tail of a distribution. */
+    other?: boolean;
+}
+export interface InsightsBucket {
+    /** The bucket's range, "60–119". */
+    label: string;
+    value: number;
+}
+/** Records per facet value among `rows`, most common first, ties A to Z. */
+export declare function facetDistribution(values: ReadonlyMap<string, readonly string[]>, rows: readonly Row[]): InsightsCount[];
+/** At most `max` entries: the tail folds into one `other` entry holding its sum. */
+export declare function foldDistribution(entries: readonly InsightsCount[], max: number): InsightsCount[];
+/** Records among `rows` carrying more than one facet value. */
+export declare function multiValued(values: ReadonlyMap<string, readonly string[]>, rows: readonly Row[]): number;
+export declare function average(rows: readonly Row[], field: string): number;
+/**
+ * The rows in an order-by's order, key by key: a collection does not promise
+ * it (a fixture corpus answers in insertion order), and ranks break their
+ * ties in this order.
+ */
+export declare function orderRows<TRow extends Row>(rows: readonly TRow[], orderBy: ReadonlyArray<{
+    field: string;
+    order: string;
+}> | undefined): TRow[];
+/** The `n` rows with the largest `field`; ties keep the rows' order. */
+export declare function topBy<TRow extends Row>(rows: readonly TRow[], field: string, n: number): TRow[];
+/** A round bucket width (1, 2 or 5 times a power of ten) for about six buckets up to `max`. */
+export declare function bucketWidth(max: number): number;
+/**
+ * Counts of `field` in `width`-wide buckets from 0, empty buckets between
+ * occupied ones kept so a bar chart's axis reads as a scale.
+ */
+export declare function histogram(rows: readonly Row[], field: string, width?: number): InsightsBucket[];
+export {};
+//# sourceMappingURL=insightsData.d.ts.map

package/types/insights/insightsData.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"insightsData.d.ts","sourceRoot":"","sources":["../../src/insights/insightsData.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,KAAK,GAAG,GAAG;IAAE,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEvD,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,yCAAyC;IACzC,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,cAAc;IAC7B,oCAAoC;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf;AAOD,4EAA4E;AAC5E,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,WAAW,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC,EAC9C,IAAI,EAAE,SAAS,GAAG,EAAE,GACnB,aAAa,EAAE,CAUjB;AAED,oFAAoF;AACpF,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,SAAS,aAAa,EAAE,EAAE,GAAG,EAAE,MAAM,GAAG,aAAa,EAAE,CAKhG;AAED,+DAA+D;AAC/D,wBAAgB,WAAW,CACzB,MAAM,EAAE,WAAW,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC,EAC9C,IAAI,EAAE,SAAS,GAAG,EAAE,GACnB,MAAM,CAER;AAED,wBAAgB,OAAO,CAAC,IAAI,EAAE,SAAS,GAAG,EAAE,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAGnE;AAUD;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,IAAI,SAAS,GAAG,EACxC,IAAI,EAAE,SAAS,IAAI,EAAE,EACrB,OAAO,EAAE,aAAa,CAAC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC,GAAG,SAAS,GACnE,IAAI,EAAE,CASR;AAED,wEAAwE;AACxE,wBAAgB,KAAK,CAAC,IAAI,SAAS,GAAG,EAAE,IAAI,EAAE,SAAS,IAAI,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,EAAE,CAE/F;AAED,+FAA+F;AAC/F,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAK/C;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,SAAS,GAAG,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,cAAc,EAAE,CAe/F"}

package/types/insights/insightsRecord.d.ts

@@ -0,0 +1,29 @@
+/** A record as the insights sections draw it, resolved once by FrappeInsights. */
+export interface InsightsRecordView<TDoc> {
+    title: (doc: TDoc) => string;
+    code: (doc: TDoc) => string | undefined;
+    images: (doc: TDoc) => string[];
+    /** The facet values' tints, first value first. */
+    tints: (doc: TDoc) => (string | undefined)[];
+    /** The record's facet values. */
+    values: (doc: TDoc) => string[];
+    valueLabel: (value: string) => string;
+    valueTint: (value: string) => string | undefined;
+    open: (doc: TDoc) => void;
+}
+export interface FrappeInsightsMetric {
+    /** A numeric field of the doctype. */
+    field: string;
+    label: string;
+    /** A value as shown (units, precision); defaults to the number. */
+    format?: (value: number) => string;
+    /** Names the metric's record-holder tile ("Tallest"); without it, no tile. */
+    record?: string;
+    /** Histogram bucket width; defaults to a round width for about six buckets. */
+    bucket?: number;
+    /** A record page fills a bar under the value to this ceiling. */
+    max?: number;
+}
+export declare function metricValue(doc: unknown, field: string): number;
+export declare function formatMetric(metric: FrappeInsightsMetric, value: number): string;
+//# sourceMappingURL=insightsRecord.d.ts.map

package/types/insights/insightsRecord.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"insightsRecord.d.ts","sourceRoot":"","sources":["../../src/insights/insightsRecord.ts"],"names":[],"mappings":"AAAA,kFAAkF;AAClF,MAAM,WAAW,kBAAkB,CAAC,IAAI;IACtC,KAAK,EAAE,CAAC,GAAG,EAAE,IAAI,KAAK,MAAM,CAAC;IAC7B,IAAI,EAAE,CAAC,GAAG,EAAE,IAAI,KAAK,MAAM,GAAG,SAAS,CAAC;IACxC,MAAM,EAAE,CAAC,GAAG,EAAE,IAAI,KAAK,MAAM,EAAE,CAAC;IAChC,kDAAkD;IAClD,KAAK,EAAE,CAAC,GAAG,EAAE,IAAI,KAAK,CAAC,MAAM,GAAG,SAAS,CAAC,EAAE,CAAC;IAC7C,iCAAiC;IACjC,MAAM,EAAE,CAAC,GAAG,EAAE,IAAI,KAAK,MAAM,EAAE,CAAC;IAChC,UAAU,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;IACtC,SAAS,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAAC;IACjD,IAAI,EAAE,CAAC,GAAG,EAAE,IAAI,KAAK,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,oBAAoB;IACnC,sCAAsC;IACtC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,mEAAmE;IACnE,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;IACnC,8EAA8E;IAC9E,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,+EAA+E;IAC/E,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iEAAiE;IACjE,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,wBAAgB,WAAW,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAG/D;AAED,wBAAgB,YAAY,CAAC,MAAM,EAAE,oBAAoB,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAEhF"}

package/types/list/FacetBadge.d.ts

@@ -0,0 +1,13 @@
+export interface FacetBadgeProps {
+    label: string;
+    /** Theme hue (`"grass"`) painting the badge from its ramp. */
+    tint?: string;
+    /** A step smaller, for image wells and table cells. */
+    compact?: boolean;
+}
+/**
+ * One facet value as a static badge: nested density (LC-73), the tint's
+ * step-4 fill, step-7 border and step-12 text (DF-04, AA in both schemes).
+ */
+export declare function FacetBadge({ label, tint, compact }: FacetBadgeProps): import("react/jsx-runtime").JSX.Element;
+//# sourceMappingURL=FacetBadge.d.ts.map

package/types/list/FacetBadge.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FacetBadge.d.ts","sourceRoot":"","sources":["../../src/list/FacetBadge.tsx"],"names":[],"mappings":"AAGA,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,8DAA8D;IAC9D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uDAAuD;IACvD,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,EAAE,KAAK,EAAE,IAAa,EAAE,OAAe,EAAE,EAAE,eAAe,2CAyBpF"}

package/types/list/FacetRail.d.ts

@@ -0,0 +1,26 @@
+export interface FacetRailOption {
+    /** Facet value; "" is the chip that clears the facet. */
+    value: string;
+    label: string;
+    /** Theme hue (`"grass"`) painting the chip from its ramp. */
+    tint?: string;
+    count?: number;
+}
+export interface FacetRailProps {
+    /** Names the radiogroup. */
+    label: string;
+    /** Active value, or "" for none. */
+    value: string;
+    options: readonly FacetRailOption[];
+    onChange: (value: string) => void;
+    testID?: string;
+}
+/**
+ * A single-select facet as a horizontally scrolling chip rail. One tap
+ * narrows, a second tap on the active chip clears. One tab stop (LC-49):
+ * arrows, Home and End move and select like a radiogroup, and the focused
+ * chip paints the only ring (LC-71). Scrolls on narrow viewports instead of
+ * wrapping into a wall of chips.
+ */
+export declare function FacetRail({ label, value, options, onChange, testID }: FacetRailProps): import("react/jsx-runtime").JSX.Element;
+//# sourceMappingURL=FacetRail.d.ts.map

package/types/list/FacetRail.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FacetRail.d.ts","sourceRoot":"","sources":["../../src/list/FacetRail.tsx"],"names":[],"mappings":"AAWA,MAAM,WAAW,eAAe;IAC9B,yDAAyD;IACzD,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,6DAA6D;IAC7D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,cAAc;IAC7B,4BAA4B;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,oCAAoC;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,SAAS,eAAe,EAAE,CAAC;IACpC,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAqID;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,cAAc,2CAkEpF"}

package/types/list/ImageWell.d.ts

@@ -0,0 +1,24 @@
+import { type YStackProps } from "@multiplatform.one/components";
+export interface ImageWellProps extends Omit<YStackProps, "children"> {
+    /** Candidate URLs in order; a failed load moves to the next. */
+    sources: readonly string[];
+    alt: string;
+    /**
+     * Theme hues (`"grass"`) painting the well from their ramps: one fills it,
+     * two split it down the middle.
+     */
+    tints?: readonly (string | undefined)[];
+    /** Nearest-neighbor upscaling, for pixel art. */
+    pixelated?: boolean;
+    /** Gap between the well's edge and the image, as a fraction of its width. */
+    inset?: number;
+    /** Fetch only as the image nears the viewport (web). */
+    lazy?: boolean;
+}
+/**
+ * A square image well: a tinted surface (the tint is data, from the theme's
+ * ramps) holding an image that walks its candidate list on error and fades
+ * in on web, with a "?" when every candidate fails.
+ */
+export declare function ImageWell({ sources, alt, tints, pixelated, inset, lazy, ...wellProps }: ImageWellProps): import("react/jsx-runtime").JSX.Element;
+//# sourceMappingURL=ImageWell.d.ts.map

package/types/list/ImageWell.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ImageWell.d.ts","sourceRoot":"","sources":["../../src/list/ImageWell.tsx"],"names":[],"mappings":"AAAA,OAAO,EAML,KAAK,WAAW,EACjB,MAAM,+BAA+B,CAAC;AAIvC,MAAM,WAAW,cAAe,SAAQ,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC;IACnE,gEAAgE;IAChE,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ;;;OAGG;IACH,KAAK,CAAC,EAAE,SAAS,CAAC,MAAM,GAAG,SAAS,CAAC,EAAE,CAAC;IACxC,iDAAiD;IACjD,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,6EAA6E;IAC7E,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,wDAAwD;IACxD,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,EACxB,OAAO,EACP,GAAG,EACH,KAAK,EACL,SAAiB,EACjB,KAAY,EACZ,IAAY,EACZ,GAAG,SAAS,EACb,EAAE,cAAc,2CAoEhB"}

package/types/list/ListControls.d.ts

@@ -0,0 +1,30 @@
+import type React from "react";
+import { type FrappeListControls } from "./listState";
+import type { ListControlsResult } from "./useListControls";
+export interface ListControlsProps {
+    controls: FrappeListControls;
+    list: ListControlsResult;
+    /** DOM id of the search box's wrapper, which the "/" shortcut focuses. */
+    searchId: string;
+    searchPlaceholder?: string;
+    showSearch: boolean;
+    showFavorites: boolean;
+    /** Present when the list offers a random pick. */
+    shuffle?: {
+        open: boolean;
+        toggle: () => void;
+        panelId: string;
+    };
+    /** The random pick, under the search row while open. */
+    shufflePanel?: React.ReactNode;
+    /** A hairline under the band, when the list below paints no surface. */
+    separator: boolean;
+    testID: string;
+}
+/**
+ * The band above a list: search growing on the left, sort, favorites and
+ * shuffle anchored right; then one chip rail per facet; then the range
+ * sliders with Clear filters. Under sm the search takes its own row.
+ */
+export declare function ListControls({ controls, list, searchId, searchPlaceholder, showSearch, showFavorites, shuffle, shufflePanel, separator, testID, }: ListControlsProps): import("react/jsx-runtime").JSX.Element;
+//# sourceMappingURL=ListControls.d.ts.map

package/types/list/ListControls.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ListControls.d.ts","sourceRoot":"","sources":["../../src/list/ListControls.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAG/B,OAAO,EAAkB,KAAK,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAEtE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAE5D,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,IAAI,EAAE,kBAAkB,CAAC;IACzB,0EAA0E;IAC1E,QAAQ,EAAE,MAAM,CAAC;IACjB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,UAAU,EAAE,OAAO,CAAC;IACpB,aAAa,EAAE,OAAO,CAAC;IACvB,kDAAkD;IAClD,OAAO,CAAC,EAAE;QAAE,IAAI,EAAE,OAAO,CAAC;QAAC,MAAM,EAAE,MAAM,IAAI,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IACjE,wDAAwD;IACxD,YAAY,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC/B,wEAAwE;IACxE,SAAS,EAAE,OAAO,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;CAChB;AAOD;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,EAC3B,QAAQ,EACR,IAAI,EACJ,QAAQ,EACR,iBAAiB,EACjB,UAAU,EACV,aAAa,EACb,OAAO,EACP,YAAY,EACZ,SAAS,EACT,MAAM,GACP,EAAE,iBAAiB,2CA8JnB"}

package/types/list/ListToastHost.d.ts

@@ -0,0 +1,7 @@
+/**
+ * A list page's toast viewport, for its favorites feedback. `showToast`
+ * writes to a module store either way; a host without a root viewport (the
+ * One app mounts none) would otherwise never paint the entries.
+ */
+export declare function ListToastHost(): import("react/jsx-runtime").JSX.Element;
+//# sourceMappingURL=ListToastHost.d.ts.map

package/types/list/ListToastHost.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ListToastHost.d.ts","sourceRoot":"","sources":["../../src/list/ListToastHost.tsx"],"names":[],"mappings":"AAeA;;;;GAIG;AACH,wBAAgB,aAAa,4CAM5B"}

package/types/list/RangeFilter.d.ts

@@ -0,0 +1,14 @@
+export interface RangeFilterProps {
+    label: string;
+    /** Current minimum; 0 is no minimum. */
+    value: number;
+    /** Upper bound of the slider. */
+    max: number;
+    step?: number;
+    onChange: (value: number) => void;
+}
+/** A "minimum value" filter for a numeric field: label, slider, readout. */
+export declare function RangeFilter(props: RangeFilterProps): import("react/jsx-runtime").JSX.Element;
+/** A slider ceiling that follows the data, rounded up to a tidy stop. */
+export declare function rangeCeiling(highest: number, stop?: number, floor?: number): number;
+//# sourceMappingURL=RangeFilter.d.ts.map

package/types/list/RangeFilter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RangeFilter.d.ts","sourceRoot":"","sources":["../../src/list/RangeFilter.tsx"],"names":[],"mappings":"AAKA,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,wCAAwC;IACxC,KAAK,EAAE,MAAM,CAAC;IACd,iCAAiC;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;CACnC;AAyDD,4EAA4E;AAC5E,wBAAgB,WAAW,CAAC,KAAK,EAAE,gBAAgB,2CAMlD;AAED,yEAAyE;AACzE,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,SAAK,EAAE,KAAK,SAAK,GAAG,MAAM,CAE3E"}

package/types/list/RecordCard.d.ts

@@ -0,0 +1,38 @@
+export interface RecordCardBadge {
+    value: string;
+    label: string;
+    tint?: string;
+}
+export interface RecordCardProps {
+    title: string;
+    subtitle?: string;
+    /** Stamped on the well's corner ("#025"). */
+    code?: string;
+    /** Image candidates in order; a failed load moves to the next. */
+    images: readonly string[];
+    /** Theme hues painting the well: one fills it, two split it. */
+    tints?: readonly (string | undefined)[];
+    /** Facet values stickered on the well. */
+    badges?: readonly RecordCardBadge[];
+    /** The record's page: the card becomes a real link (SSR, new tab). */
+    href?: string;
+    onPress?: () => void;
+    favorite?: {
+        active: boolean;
+        toggle: () => void;
+    };
+    /** Fetch the image only as it nears the viewport. */
+    lazy?: boolean;
+    testID?: string;
+    favoriteTestID?: string;
+}
+/**
+ * A record as a tile: the image well is the card (tinted by the record's
+ * facet, its values stickered on it, its code stamped in the corner) with
+ * the title and a muted subtitle under it. A routed card is a stretched
+ * link with the heart as its sibling button (LC-74), so a first-paint click
+ * on the heart never follows the link; modified clicks keep the browser's
+ * new-tab semantics.
+ */
+export declare function RecordCard({ title, subtitle, code, images, tints, badges, href, onPress, favorite, lazy, testID, favoriteTestID, }: RecordCardProps): import("react/jsx-runtime").JSX.Element;
+//# sourceMappingURL=RecordCard.d.ts.map

package/types/list/RecordCard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RecordCard.d.ts","sourceRoot":"","sources":["../../src/list/RecordCard.tsx"],"names":[],"mappings":"AAeA,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,6CAA6C;IAC7C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kEAAkE;IAClE,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;IAC1B,gEAAgE;IAChE,KAAK,CAAC,EAAE,SAAS,CAAC,MAAM,GAAG,SAAS,CAAC,EAAE,CAAC;IACxC,0CAA0C;IAC1C,MAAM,CAAC,EAAE,SAAS,eAAe,EAAE,CAAC;IACpC,sEAAsE;IACtE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;IACrB,QAAQ,CAAC,EAAE;QAAE,MAAM,EAAE,OAAO,CAAC;QAAC,MAAM,EAAE,MAAM,IAAI,CAAA;KAAE,CAAC;IACnD,qDAAqD;IACrD,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAyBD;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,EACzB,KAAK,EACL,QAAQ,EACR,IAAI,EACJ,MAAM,EACN,KAAK,EACL,MAAW,EACX,IAAI,EACJ,OAAO,EACP,QAAQ,EACR,IAAY,EACZ,MAAM,EACN,cAAc,GACf,EAAE,eAAe,2CA6KjB"}

package/types/list/RecordCard.native.d.ts

@@ -0,0 +1,9 @@
+import type { RecordCardProps } from "./RecordCard";
+export type { RecordCardBadge, RecordCardProps } from "./RecordCard";
+/**
+ * Native twin of RecordCard. On React Native an Anchor is a Text node whose
+ * press the Card (a View with its own responder) claims, so the card's
+ * press sits on the Card itself and the heart stops it from bubbling there.
+ */
+export declare function RecordCard({ title, subtitle, code, images, tints, badges, onPress, favorite, testID, favoriteTestID, }: RecordCardProps): import("react/jsx-runtime").JSX.Element;
+//# sourceMappingURL=RecordCard.native.d.ts.map

package/types/list/RecordCard.native.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RecordCard.native.d.ts","sourceRoot":"","sources":["../../src/list/RecordCard.native.tsx"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAEpD,YAAY,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAErE;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,EACzB,KAAK,EACL,QAAQ,EACR,IAAI,EACJ,MAAM,EACN,KAAK,EACL,MAAW,EACX,OAAO,EACP,QAAQ,EACR,MAAM,EACN,cAAc,GACf,EAAE,eAAe,2CAkGjB"}

package/types/list/ShufflePanel.d.ts

@@ -0,0 +1,24 @@
+import type React from "react";
+export interface ShufflePanelProps<TDoc extends {
+    name?: string;
+}> {
+    /** DOM id the toggle names in aria-controls. */
+    id?: string;
+    label: string;
+    /** Records to pick from, in wheel order. */
+    rows: readonly TDoc[];
+    /** A record's wheel label. */
+    itemLabel: (doc: TDoc) => string;
+    /** Draws the current pick beside the wheel. */
+    renderPick: (doc: TDoc) => React.ReactNode;
+    onGo: (doc: TDoc) => void;
+    testID?: string;
+}
+/**
+ * Pick a random record: a wheel of record labels beside the current pick.
+ * Drag or flick the wheel, or Spin for a random jump, then Go opens it.
+ */
+export declare function ShufflePanel<TDoc extends {
+    name?: string;
+}>({ id, label, rows, itemLabel, renderPick, onGo, testID, }: ShufflePanelProps<TDoc>): import("react/jsx-runtime").JSX.Element | null;
+//# sourceMappingURL=ShufflePanel.d.ts.map

package/types/list/ShufflePanel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ShufflePanel.d.ts","sourceRoot":"","sources":["../../src/list/ShufflePanel.tsx"],"names":[],"mappings":"AAGA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAI/B,MAAM,WAAW,iBAAiB,CAAC,IAAI,SAAS;IAAE,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE;IAC/D,gDAAgD;IAChD,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,4CAA4C;IAC5C,IAAI,EAAE,SAAS,IAAI,EAAE,CAAC;IACtB,8BAA8B;IAC9B,SAAS,EAAE,CAAC,GAAG,EAAE,IAAI,KAAK,MAAM,CAAC;IACjC,+CAA+C;IAC/C,UAAU,EAAE,CAAC,GAAG,EAAE,IAAI,KAAK,KAAK,CAAC,SAAS,CAAC;IAC3C,IAAI,EAAE,CAAC,GAAG,EAAE,IAAI,KAAK,IAAI,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAUD;;;GAGG;AACH,wBAAgB,YAAY,CAAC,IAAI,SAAS;IAAE,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,EAAE,EAC3D,EAAE,EACF,KAAK,EACL,IAAI,EACJ,SAAS,EACT,UAAU,EACV,IAAI,EACJ,MAAM,GACP,EAAE,iBAAiB,CAAC,IAAI,CAAC,kDAiEzB"}

package/types/list/facetReading.d.ts

@@ -0,0 +1,33 @@
+/**
+ * How a facet's values are read: which rows, and how they fold into each
+ * record's values and each value's record count. Pure: no React, no IO.
+ */
+import type { FrappeConnection } from "../frappeConnections";
+import type { FrappeListFacet } from "./listState";
+type Row = Record<string, unknown>;
+export interface FacetReading {
+    /** Record name to its values, ordered by the facet's `orderBy`. */
+    values: ReadonlyMap<string, string[]>;
+    /** Value to the number of records carrying it. */
+    counts: Readonly<Record<string, number>>;
+}
+export interface FacetRead {
+    /** The doctype whose rows carry the facet's field. */
+    doctype: string;
+    /** The field of those rows naming the record; "name" on the list doctype. */
+    linkField: string;
+    options: {
+        fields: string[];
+        limit: number;
+    };
+    /** False while a connection doctype's link is still unknown. */
+    ready: boolean;
+}
+/**
+ * The read behind a facet. A connection doctype's read asks for the fields
+ * its declared connection reads too, so both share one collection.
+ */
+export declare function facetRead(facet: FrappeListFacet, doctype: string, connections: readonly FrappeConnection[] | undefined, limit: number | undefined): FacetRead;
+export declare function readFacet(facet: FrappeListFacet, linkField: string, rows: readonly Row[]): FacetReading;
+export {};
+//# sourceMappingURL=facetReading.d.ts.map

package/types/list/facetReading.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"facetReading.d.ts","sourceRoot":"","sources":["../../src/list/facetReading.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAC7D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAEnD,KAAK,GAAG,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEnC,MAAM,WAAW,YAAY;IAC3B,mEAAmE;IACnE,MAAM,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IACtC,kDAAkD;IAClD,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;CAC1C;AAED,MAAM,WAAW,SAAS;IACxB,sDAAsD;IACtD,OAAO,EAAE,MAAM,CAAC;IAChB,6EAA6E;IAC7E,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAC7C,gEAAgE;IAChE,KAAK,EAAE,OAAO,CAAC;CAChB;AAED;;;GAGG;AACH,wBAAgB,SAAS,CACvB,KAAK,EAAE,eAAe,EACtB,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,SAAS,gBAAgB,EAAE,GAAG,SAAS,EACpD,KAAK,EAAE,MAAM,GAAG,SAAS,GACxB,SAAS,CAeX;AAED,wBAAgB,SAAS,CACvB,KAAK,EAAE,eAAe,EACtB,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,SAAS,GAAG,EAAE,GACnB,YAAY,CAsBd"}

package/types/list/favorites.d.ts

@@ -0,0 +1,26 @@
+/**
+ * A list's favorites: the record names a reader starred, kept on the device
+ * (no bench write, so a guest can star too). One persistent store per
+ * storage key, following docs/standards/frontend/persistent-stores.md.
+ */
+import { type PersistStore, type Storage } from "@multiplatform.one/store";
+export interface FavoritesState {
+    /** Starred record names, in the order they were starred. */
+    names: string[];
+}
+export declare function createFavoritesStore(key: string, storageImpl?: Storage): PersistStore<FavoritesState>;
+/** The shared store for a storage key. */
+export declare function favoritesStore(key: string): PersistStore<FavoritesState>;
+/** The storage key a doctype's favorites default to. */
+export declare function favoritesKey(doctype: string): string;
+export declare function toggleFavoriteIn(store: PersistStore<FavoritesState>, name: string): void;
+export interface UseFavorites {
+    favorites: string[];
+    favoriteSet: ReadonlySet<string>;
+    isFavorite: (name: string) => boolean;
+    toggle: (name: string) => void;
+    count: number;
+}
+/** A key's favorites; without a key, none (and toggling does nothing). */
+export declare function useFavorites(key: string | undefined): UseFavorites;
+//# sourceMappingURL=favorites.d.ts.map

package/types/list/favorites.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"favorites.d.ts","sourceRoot":"","sources":["../../src/list/favorites.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAKL,KAAK,YAAY,EACjB,KAAK,OAAO,EACb,MAAM,0BAA0B,CAAC;AAGlC,MAAM,WAAW,cAAc;IAC7B,4DAA4D;IAC5D,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,wBAAgB,oBAAoB,CAClC,GAAG,EAAE,MAAM,EACX,WAAW,GAAE,OAAiB,GAC7B,YAAY,CAAC,cAAc,CAAC,CAE9B;AAID,0CAA0C;AAC1C,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,CAAC,cAAc,CAAC,CAOxE;AAED,wDAAwD;AACxD,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAEpD;AAED,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,YAAY,CAAC,cAAc,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,CAMxF;AAED,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,WAAW,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IACjC,UAAU,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC;IACtC,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC;CACf;AAID,0EAA0E;AAC1E,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,YAAY,CAelE"}

package/types/list/listState.d.ts

@@ -0,0 +1,94 @@
+/**
+ * The state of a list page's controls (search, sort, facets, ranges,
+ * favorites, view) and its two codecs: URL params, so a refresh or a shared
+ * link reproduces the list, and bench filters, so the list reads exactly
+ * the rows the controls describe. Pure: no React, no IO.
+ *
+ * Params: `q` search, `sort` the sort's value (absent for the first sort),
+ * one param per facet and per range (absent when unset), `fav=1` favorites
+ * only, `view` (absent for the default view).
+ */
+import type { Order } from "@multiplatform.one/frappe";
+export type FrappeListViewMode = "list" | "table" | "grid";
+export interface FrappeListSort {
+    /** URL value. */
+    value: string;
+    label: string;
+    orderBy: ReadonlyArray<{
+        field: string;
+        order: Order;
+    }>;
+}
+/** Narrow the list to records carrying one value of a field. */
+export interface FrappeListFacet {
+    /** URL param and state key. */
+    param: string;
+    /** Field whose value narrows. */
+    field: string;
+    /**
+     * A connection doctype whose rows carry `field` (Pokemon's types live on
+     * Pokemon Poke Type rows). Omitted, `field` is the list doctype's own.
+     */
+    doctype?: string;
+    /** Values offered, in display order. */
+    options: readonly string[];
+    /** Names the rail for assistive tech. */
+    label: string;
+    /** The chip that clears the facet. */
+    allLabel?: string;
+    optionLabel?: (value: string) => string;
+    /** A theme hue per value (`"grass"`), painting its chip from that ramp. */
+    tint?: (value: string) => string | undefined;
+    /** Connection field that orders one record's values (a `slot`). */
+    orderBy?: string;
+}
+/** Narrow the list to records whose numeric field is at least a value. */
+export interface FrappeListRange {
+    param: string;
+    field: string;
+    label: string;
+    step?: number;
+}
+export interface FrappeListControls {
+    sorts?: readonly FrappeListSort[];
+    facets?: readonly FrappeListFacet[];
+    ranges?: readonly FrappeListRange[];
+    views?: readonly FrappeListViewMode[];
+    defaultView?: FrappeListViewMode;
+}
+export interface FrappeListState {
+    search: string;
+    /** The chosen sort's value; the first sort when none was chosen. */
+    sort: string | undefined;
+    /** Facet param to the value it narrows to. */
+    facets: Record<string, string>;
+    /** Range param to its minimum; absent or 0 is no minimum. */
+    ranges: Record<string, number>;
+    favoritesOnly: boolean;
+    view: FrappeListViewMode | undefined;
+}
+export type FrappeListParams = Record<string, string | undefined>;
+export type FrappeListFilter = [string, string, unknown] | [string, string, string, unknown];
+export declare function listStateFromParams(params: FrappeListParams, controls: FrappeListControls): FrappeListState;
+/** A state patch as the URL params it changes; a default value drops its param. */
+export declare function listStateParams(patch: Partial<FrappeListState>, controls: FrappeListControls): FrappeListParams;
+/** Search, a facet, a range or favorites narrows the rows. */
+export declare function isListNarrowed(state: FrappeListState): boolean;
+export interface ListStateFilterOptions {
+    /** Filters that always apply, ahead of the controls'. */
+    base?: readonly FrappeListFilter[];
+    /** The bench filters a search query becomes. */
+    search?: (query: string) => readonly FrappeListFilter[];
+    /** Starred names, for favorites only. */
+    favorites?: ReadonlySet<string>;
+}
+/** The bench filters the state describes, or undefined when nothing filters. */
+export declare function listStateFilters(state: FrappeListState, controls: FrappeListControls, options?: ListStateFilterOptions): FrappeListFilter[] | undefined;
+export declare function listStateOrderBy(state: FrappeListState, controls: FrappeListControls, fallback?: ReadonlyArray<{
+    field: string;
+    order: Order;
+}>): ReadonlyArray<{
+    field: string;
+    order: Order;
+}> | undefined;
+//# sourceMappingURL=listState.d.ts.map

package/types/list/listState.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"listState.d.ts","sourceRoot":"","sources":["../../src/list/listState.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,2BAA2B,CAAC;AAEvD,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;AAE3D,MAAM,WAAW,cAAc;IAC7B,iBAAiB;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,aAAa,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE,CAAC,CAAC;CACzD;AAED,gEAAgE;AAChE,MAAM,WAAW,eAAe;IAC9B,+BAA+B;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,iCAAiC;IACjC,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,wCAAwC;IACxC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IAC3B,yCAAyC;IACzC,KAAK,EAAE,MAAM,CAAC;IACd,sCAAsC;IACtC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;IACxC,2EAA2E;IAC3E,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAAC;IAC7C,mEAAmE;IACnE,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,0EAA0E;AAC1E,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,CAAC,EAAE,SAAS,cAAc,EAAE,CAAC;IAClC,MAAM,CAAC,EAAE,SAAS,eAAe,EAAE,CAAC;IACpC,MAAM,CAAC,EAAE,SAAS,eAAe,EAAE,CAAC;IACpC,KAAK,CAAC,EAAE,SAAS,kBAAkB,EAAE,CAAC;IACtC,WAAW,CAAC,EAAE,kBAAkB,CAAC;CAClC;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,oEAAoE;IACpE,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,8CAA8C;IAC9C,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,6DAA6D;IAC7D,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,aAAa,EAAE,OAAO,CAAC;IACvB,IAAI,EAAE,kBAAkB,GAAG,SAAS,CAAC;CACtC;AAED,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;AAElE,MAAM,MAAM,gBAAgB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;AAO7F,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,gBAAgB,EACxB,QAAQ,EAAE,kBAAkB,GAC3B,eAAe,CAuBjB;AAED,mFAAmF;AACnF,wBAAgB,eAAe,CAC7B,KAAK,EAAE,OAAO,CAAC,eAAe,CAAC,EAC/B,QAAQ,EAAE,kBAAkB,GAC3B,gBAAgB,CAiBlB;AAED,8DAA8D;AAC9D,wBAAgB,cAAc,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAO9D;AAED,MAAM,WAAW,sBAAsB;IACrC,yDAAyD;IACzD,IAAI,CAAC,EAAE,SAAS,gBAAgB,EAAE,CAAC;IACnC,gDAAgD;IAChD,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,SAAS,gBAAgB,EAAE,CAAC;IACxD,yCAAyC;IACzC,SAAS,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;CACjC;AAED,gFAAgF;AAChF,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,eAAe,EACtB,QAAQ,EAAE,kBAAkB,EAC5B,OAAO,GAAE,sBAA2B,GACnC,gBAAgB,EAAE,GAAG,SAAS,CAiBhC;AAED,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,eAAe,EACtB,QAAQ,EAAE,kBAAkB,EAC5B,QAAQ,CAAC,EAAE,aAAa,CAAC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,KAAK,CAAA;CAAE,CAAC,GACxD,aAAa,CAAC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,KAAK,CAAA;CAAE,CAAC,GAAG,SAAS,CAG5D"}