@gemologic/sheen-table 0.3.0 → 0.4.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.
Files changed (43) hide show
  1. package/dist/DataTable.d.ts +57 -13
  2. package/dist/DataTable.js +963 -820
  3. package/dist/FilterBar.d.ts +3 -3
  4. package/dist/FilterBar.js +5 -1
  5. package/dist/client-state.d.ts +9 -3
  6. package/dist/client-state.js +38 -32
  7. package/dist/core.d.ts +5 -5
  8. package/dist/core.js +28 -28
  9. package/dist/data-table-features.d.ts +18 -13
  10. package/dist/data-table-features.js +11 -1
  11. package/dist/index.d.ts +5 -3
  12. package/dist/index.js +32 -31
  13. package/dist/messages.d.ts +3 -0
  14. package/dist/messages.js +3 -0
  15. package/dist/pagination.d.ts +43 -1
  16. package/dist/pagination.js +109 -54
  17. package/dist/requests.d.ts +3 -3
  18. package/dist/requests.js +38 -28
  19. package/dist/saved-views.d.ts +17 -14
  20. package/dist/saved-views.js +71 -68
  21. package/dist/server-export.d.ts +16 -7
  22. package/dist/server-export.js +57 -53
  23. package/dist/table-state-changes.d.ts +6 -3
  24. package/dist/table-state-changes.js +44 -40
  25. package/dist/table-state.d.ts +20 -4
  26. package/dist/table-state.js +66 -40
  27. package/dist/url-state.d.ts +12 -9
  28. package/dist/url-state.js +33 -30
  29. package/package.json +3 -3
  30. package/src/DataTable.tsx +221 -61
  31. package/src/FilterBar.tsx +5 -3
  32. package/src/client-state.ts +31 -17
  33. package/src/core.ts +5 -5
  34. package/src/data-table-features.tsx +23 -10
  35. package/src/index.ts +5 -3
  36. package/src/messages.ts +1 -1
  37. package/src/pagination.ts +83 -14
  38. package/src/requests.ts +22 -8
  39. package/src/saved-views.ts +33 -11
  40. package/src/server-export.ts +17 -11
  41. package/src/table-state-changes.ts +22 -12
  42. package/src/table-state.ts +53 -11
  43. package/src/url-state.ts +27 -10
@@ -1,7 +1,7 @@
1
1
  import type { JSX } from "solid-js";
2
2
  import type { SheenColumns } from "./columns.ts";
3
3
  import type { FilterNode } from "./filter.ts";
4
- import type { DataTableFeatureContext, DataTableFeatureInstance } from "./data-table-features.tsx";
4
+ import type { DataTableFeature } from "./data-table-features.tsx";
5
5
  export interface FilterBarProps<Row extends object> {
6
6
  readonly columns: SheenColumns<Row>;
7
7
  readonly value: FilterNode;
@@ -23,5 +23,5 @@ export interface FilterDateEditorProps {
23
23
  }
24
24
  export type FilterDateEditor = (props: FilterDateEditorProps) => JSX.Element;
25
25
  export declare function FilterBar<Row extends object>(props: FilterBarProps<Row>): JSX.Element;
26
- /** DataTable toolbar integration for the filters declared by its column definitions. */
27
- export declare function filterBarFeature<Row extends object>(context: DataTableFeatureContext<Row>): DataTableFeatureInstance<Row> | undefined;
26
+ /** DataTable toolbar integration for the filters declared by its column definitions, through the `filterBar` prop. */
27
+ export declare const filterBarFeature: DataTableFeature<"filterBar">;
package/dist/FilterBar.js CHANGED
@@ -696,5 +696,9 @@ function Q(e) {
696
696
  }, () => typeof t.filterBar == "object" && t.filterBar.dateEditor ? { dateEditor: t.filterBar.dateEditor } : {}))
697
697
  } };
698
698
  }
699
+ var oe = {
700
+ id: "filterBar",
701
+ create: Q
702
+ };
699
703
  u(["click"]);
700
- export { Z as FilterBar, Q as filterBarFeature };
704
+ export { Z as FilterBar, oe as filterBarFeature };
@@ -1,12 +1,12 @@
1
1
  import type { ClientViewState } from "./client-view.ts";
2
2
  import type { FilterColumn, FilterNode } from "./filter.ts";
3
- import type { TablePagination } from "./pagination.ts";
3
+ import type { ServerPagination, TablePagination } from "./pagination.ts";
4
4
  import type { SortColumn, SortState } from "./sorting.ts";
5
5
  export interface ClientStateSchema {
6
6
  readonly filterColumns: readonly FilterColumn[];
7
7
  readonly sortColumns: readonly SortColumn[];
8
8
  }
9
- export type ClientStateChange = {
9
+ export type ClientStateChange<Pagination extends ServerPagination = TablePagination> = {
10
10
  readonly kind: "search";
11
11
  readonly value: string;
12
12
  } | {
@@ -17,12 +17,18 @@ export type ClientStateChange = {
17
17
  readonly value: SortState;
18
18
  } | {
19
19
  readonly kind: "pagination";
20
- readonly value: TablePagination;
20
+ readonly value: Pagination;
21
21
  } | {
22
22
  readonly kind: "pageSize";
23
23
  readonly value: number;
24
24
  };
25
+ /** Query state whose pagination kind is fixed by the parser that validated it. */
26
+ export interface QueryState<Pagination extends ServerPagination = TablePagination> extends Omit<ClientViewState, "pagination"> {
27
+ readonly pagination: Pagination;
28
+ }
29
+ export declare function parseQueryState<Pagination extends ServerPagination>(value: unknown, schema: ClientStateSchema, readPagination: (value: unknown) => Pagination): QueryState<Pagination>;
25
30
  /** Query-state fragment only; column layout, selection, and saved-view envelopes are separate. */
26
31
  export declare function parseClientViewState(value: unknown, schema: ClientStateSchema): ClientViewState;
32
+ export declare function changeQueryState<Pagination extends ServerPagination>(state: QueryState<Pagination>, change: ClientStateChange<Pagination>, schema: ClientStateSchema, readPagination: (value: unknown) => Pagination): QueryState<Pagination>;
27
33
  /** Changes requested state only. Accepted rows/state remain owned by the result controller. */
28
34
  export declare function changeClientViewState(state: ClientViewState, change: ClientStateChange, schema: ClientStateSchema): ClientViewState;
@@ -2,55 +2,61 @@ import { parseFilter as e } from "./filter.js";
2
2
  import { parsePagination as t, resetPagination as n, resizePagination as r } from "./pagination.js";
3
3
  import { parseSorting as i } from "./sorting.js";
4
4
  // src/client-state.ts
5
- function a(n, r) {
6
- if (typeof n != "object" || !n || Array.isArray(n)) throw Error("Invalid client state: expected an object");
7
- if (Object.keys(n).some((e) => ![
5
+ function a(t, n, r) {
6
+ if (typeof t != "object" || !t || Array.isArray(t)) throw Error("Invalid client state: expected an object");
7
+ if (Object.keys(t).some((e) => ![
8
8
  "search",
9
9
  "filter",
10
10
  "sorting",
11
11
  "pagination"
12
12
  ].includes(e))) throw Error("Invalid client state: unknown field");
13
- if (!("search" in n) || typeof n.search != "string") throw Error("Invalid client state: search must be a string");
14
- if (!("filter" in n) || !("sorting" in n) || !("pagination" in n)) throw Error("Invalid client state: missing query field");
13
+ if (!("search" in t) || typeof t.search != "string") throw Error("Invalid client state: search must be a string");
14
+ if (!("filter" in t) || !("sorting" in t) || !("pagination" in t)) throw Error("Invalid client state: missing query field");
15
15
  return Object.freeze({
16
- search: n.search,
17
- filter: e(n.filter, r.filterColumns),
18
- sorting: i(n.sorting, r.sortColumns),
19
- pagination: t(n.pagination)
16
+ search: t.search,
17
+ filter: e(t.filter, n.filterColumns),
18
+ sorting: i(t.sorting, n.sortColumns),
19
+ pagination: r(t.pagination)
20
20
  });
21
21
  }
22
- function o(e, i, o) {
23
- let s = a(e, o);
24
- switch (i.kind) {
25
- case "search": return a({
22
+ function o(e, n) {
23
+ return a(e, n, t);
24
+ }
25
+ function s(e, t, i, o) {
26
+ let s = a(e, i, o), c = s.pagination, l = (e) => a(e, i, o);
27
+ switch (t.kind) {
28
+ case "search": return l({
26
29
  ...s,
27
- search: i.value,
28
- pagination: n(s.pagination)
29
- }, o);
30
- case "filter": return a({
30
+ search: t.value,
31
+ pagination: n(c)
32
+ });
33
+ case "filter": return l({
31
34
  ...s,
32
- filter: i.value,
33
- pagination: n(s.pagination)
34
- }, o);
35
- case "sorting": return a({
35
+ filter: t.value,
36
+ pagination: n(c)
37
+ });
38
+ case "sorting": return l({
36
39
  ...s,
37
- sorting: i.value,
38
- pagination: n(s.pagination)
39
- }, o);
40
+ sorting: t.value,
41
+ pagination: n(c)
42
+ });
40
43
  case "pagination": {
41
- let e = t(i.value), r = e !== !1 && s.pagination !== !1 && e.pageSize !== s.pagination.pageSize;
42
- return a({
44
+ let e = o(t.value), r = e !== !1 && c !== !1 && e.pageSize !== c.pageSize;
45
+ return l({
43
46
  ...s,
44
47
  pagination: r ? n(e) : e
45
- }, o);
48
+ });
46
49
  }
47
50
  case "pageSize":
48
- if (s.pagination === !1) throw Error("Page-size changes require pagination to be enabled");
49
- return a({
51
+ if (c === !1) throw Error("Page-size changes require pagination to be enabled");
52
+ return l({
50
53
  ...s,
51
- pagination: r(s.pagination, i.value)
52
- }, o);
54
+ pagination: r(c, t.value)
55
+ });
53
56
  default: throw Error("Unknown client state change");
54
57
  }
55
58
  }
56
- export { o as changeClientViewState, a as parseClientViewState };
59
+ function c(e, n, r) {
60
+ return s(e, n, r, t);
61
+ }
62
+ export { c as changeClientViewState, s as changeQueryState, o as parseClientViewState, a as parseQueryState };
package/dist/core.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- export { parsePagination, resolvePagination, resetPagination, resizePagination, getPageRange, paginateClientRows, assessServerPage } from "./pagination.ts";
2
- export type { PageState, TablePagination, PageRange, PageResult, ServerPageAssessment } from "./pagination.ts";
1
+ export { parsePagination, parseCursorPagination, parseServerPagination, resolvePagination, resetPagination, resizePagination, getPageRange, paginateClientRows, assessServerPage, assessCursorPage } from "./pagination.ts";
2
+ export type { PageState, TablePagination, CursorPosition, CursorPagination, ServerPagination, CursorTotal, CursorPageResult, CursorPageAssessment, PageRange, PageResult, ServerPageAssessment } from "./pagination.ts";
3
3
  export { createTableRequests } from "./requests.ts";
4
4
  export type { TableRequestState, TableRequestSnapshot, TableRequestOutcome, InitialTableResult } from "./requests.ts";
5
5
  export { parseFilter, serializeFilter, deserializeFilter } from "./filter.ts";
@@ -23,7 +23,7 @@ export type { ClientView, ClientViewState, ClientViewOptions } from "./client-vi
23
23
  export { parseClientViewState, changeClientViewState } from "./client-state.ts";
24
24
  export type { ClientStateSchema, ClientStateChange } from "./client-state.ts";
25
25
  export { parseTableState, serializeState, deserializeState } from "./table-state.ts";
26
- export type { ColumnState, TableState, TableStateSchema } from "./table-state.ts";
26
+ export type { ColumnState, TableState, TableStateSchema, CursorTableStateSchema } from "./table-state.ts";
27
27
  export { changeTableState } from "./table-state-changes.ts";
28
28
  export type { TableStateChange } from "./table-state-changes.ts";
29
29
  export { orderColumnStates, placeColumn, moveColumn, canMoveColumn } from "./column-layout.ts";
@@ -47,8 +47,8 @@ export type { GroupAggregateColumn, GroupAggregateValue, ClientRowGroup, ServerR
47
47
  export { createRowHierarchy } from "./row-hierarchy.ts";
48
48
  export type { HierarchyLoadOutcome, RowHierarchyOptions, HierarchyRow } from "./row-hierarchy.ts";
49
49
  export { createTableUrlState } from "./url-state.ts";
50
- export type { TableUrlLocation, TableUrlRouter, TableUrlRead, TableUrlWrite } from "./url-state.ts";
50
+ export type { TableUrlLocation, TableUrlRouter, TableUrlRead, TableUrlWrite, TableUrlState } from "./url-state.ts";
51
51
  export { createSavedViews } from "./saved-views.ts";
52
- export type { SavedViewRecord, SavedViewSave, SavedViewsAdapter, SavedViewOperation, SavedViewsSnapshot, SavedViewOutcome, SavedViewRestore } from "./saved-views.ts";
52
+ export type { SavedViews, SavedViewRecord, SavedViewSave, SavedViewsAdapter, SavedViewOperation, SavedViewsSnapshot, SavedViewOutcome, SavedViewRestore } from "./saved-views.ts";
53
53
  export { englishTableMessages, resolveTableMessages } from "./messages.ts";
54
54
  export type { TableMessages } from "./messages.ts";
package/dist/core.js CHANGED
@@ -1,28 +1,28 @@
1
- import { assessServerPage as e, getPageRange as t, paginateClientRows as n, parsePagination as r, resetPagination as i, resizePagination as a, resolvePagination as o } from "./pagination.js";
2
- import { createTableRequests as s } from "./requests.js";
3
- import { deserializeFilter as c, parseFilter as l, serializeFilter as u } from "./filter.js";
4
- import { appendQueryChild as d, defaultQueryRule as f, moveQueryNode as p, queryBuilderFilterColumns as m, queryNodeAt as h, removeQueryNode as g, replaceQueryNode as _, toggleQueryNegation as v } from "./query-builder-state.js";
5
- import { appendFilterCondition as y, listFilterConditions as b, removeFilterColumnConditions as x, removeFilterCondition as S, replaceFilterCondition as C } from "./filter-bar-state.js";
6
- import { compileFilter as w, filterClientRows as T } from "./filter-client.js";
7
- import { parseSorting as E, sortClientRows as D } from "./sorting.js";
8
- import { countClientFacets as O } from "./facets.js";
9
- import { formatSearchQuery as k, parseSearchQuery as A, searchClientRows as j } from "./search.js";
10
- import { createDebouncedSearch as M } from "./search-controller.js";
11
- import { createClientView as N } from "./client-view.js";
12
- import { changeClientViewState as P, parseClientViewState as F } from "./client-state.js";
13
- import { deserializeState as I, parseTableState as L, serializeState as R } from "./table-state.js";
14
- import { changeTableState as z } from "./table-state-changes.js";
15
- import { canMoveColumn as B, moveColumn as V, orderColumnStates as H, placeColumn as U } from "./column-layout.js";
16
- import { createTableSelection as W } from "./selection.js";
17
- import { createClientExport as G } from "./export.js";
18
- import { selectClientRows as K } from "./selection-client.js";
19
- import { createServerExport as q } from "./server-export.js";
20
- import { createCellEdit as J } from "./cell-edit.js";
21
- import { defineColumns as Y } from "./columns.js";
22
- import { createRowIdentity as X } from "./row-identity.js";
23
- import { groupClientRows as Z, normalizeServerGroups as Q } from "./grouping.js";
24
- import { createRowHierarchy as $ } from "./row-hierarchy.js";
25
- import { createTableUrlState as ee } from "./url-state.js";
26
- import { createSavedViews as te } from "./saved-views.js";
27
- import { englishTableMessages as ne, resolveTableMessages as re } from "./messages.js";
28
- export { y as appendFilterCondition, d as appendQueryChild, e as assessServerPage, B as canMoveColumn, P as changeClientViewState, z as changeTableState, w as compileFilter, O as countClientFacets, J as createCellEdit, G as createClientExport, N as createClientView, M as createDebouncedSearch, $ as createRowHierarchy, X as createRowIdentity, te as createSavedViews, q as createServerExport, s as createTableRequests, W as createTableSelection, ee as createTableUrlState, f as defaultQueryRule, Y as defineColumns, c as deserializeFilter, I as deserializeState, ne as englishTableMessages, T as filterClientRows, k as formatSearchQuery, t as getPageRange, Z as groupClientRows, b as listFilterConditions, V as moveColumn, p as moveQueryNode, Q as normalizeServerGroups, H as orderColumnStates, n as paginateClientRows, F as parseClientViewState, l as parseFilter, r as parsePagination, A as parseSearchQuery, E as parseSorting, L as parseTableState, U as placeColumn, m as queryBuilderFilterColumns, h as queryNodeAt, x as removeFilterColumnConditions, S as removeFilterCondition, g as removeQueryNode, C as replaceFilterCondition, _ as replaceQueryNode, i as resetPagination, a as resizePagination, o as resolvePagination, re as resolveTableMessages, j as searchClientRows, K as selectClientRows, u as serializeFilter, R as serializeState, D as sortClientRows, v as toggleQueryNegation };
1
+ import { assessCursorPage as e, assessServerPage as t, getPageRange as n, paginateClientRows as r, parseCursorPagination as i, parsePagination as a, parseServerPagination as o, resetPagination as s, resizePagination as c, resolvePagination as l } from "./pagination.js";
2
+ import { createTableRequests as u } from "./requests.js";
3
+ import { deserializeFilter as d, parseFilter as f, serializeFilter as p } from "./filter.js";
4
+ import { appendQueryChild as m, defaultQueryRule as h, moveQueryNode as g, queryBuilderFilterColumns as _, queryNodeAt as v, removeQueryNode as y, replaceQueryNode as b, toggleQueryNegation as x } from "./query-builder-state.js";
5
+ import { appendFilterCondition as S, listFilterConditions as C, removeFilterColumnConditions as w, removeFilterCondition as T, replaceFilterCondition as E } from "./filter-bar-state.js";
6
+ import { compileFilter as D, filterClientRows as O } from "./filter-client.js";
7
+ import { parseSorting as k, sortClientRows as A } from "./sorting.js";
8
+ import { countClientFacets as j } from "./facets.js";
9
+ import { formatSearchQuery as M, parseSearchQuery as N, searchClientRows as P } from "./search.js";
10
+ import { createDebouncedSearch as F } from "./search-controller.js";
11
+ import { createClientView as I } from "./client-view.js";
12
+ import { changeClientViewState as L, parseClientViewState as R } from "./client-state.js";
13
+ import { deserializeState as z, parseTableState as B, serializeState as V } from "./table-state.js";
14
+ import { changeTableState as H } from "./table-state-changes.js";
15
+ import { canMoveColumn as U, moveColumn as W, orderColumnStates as G, placeColumn as K } from "./column-layout.js";
16
+ import { createTableSelection as q } from "./selection.js";
17
+ import { createClientExport as J } from "./export.js";
18
+ import { selectClientRows as Y } from "./selection-client.js";
19
+ import { createServerExport as X } from "./server-export.js";
20
+ import { createCellEdit as Z } from "./cell-edit.js";
21
+ import { defineColumns as Q } from "./columns.js";
22
+ import { createRowIdentity as $ } from "./row-identity.js";
23
+ import { groupClientRows as ee, normalizeServerGroups as te } from "./grouping.js";
24
+ import { createRowHierarchy as ne } from "./row-hierarchy.js";
25
+ import { createTableUrlState as re } from "./url-state.js";
26
+ import { createSavedViews as ie } from "./saved-views.js";
27
+ import { englishTableMessages as ae, resolveTableMessages as oe } from "./messages.js";
28
+ export { S as appendFilterCondition, m as appendQueryChild, e as assessCursorPage, t as assessServerPage, U as canMoveColumn, L as changeClientViewState, H as changeTableState, D as compileFilter, j as countClientFacets, Z as createCellEdit, J as createClientExport, I as createClientView, F as createDebouncedSearch, ne as createRowHierarchy, $ as createRowIdentity, ie as createSavedViews, X as createServerExport, u as createTableRequests, q as createTableSelection, re as createTableUrlState, h as defaultQueryRule, Q as defineColumns, d as deserializeFilter, z as deserializeState, ae as englishTableMessages, O as filterClientRows, M as formatSearchQuery, n as getPageRange, ee as groupClientRows, C as listFilterConditions, W as moveColumn, g as moveQueryNode, te as normalizeServerGroups, G as orderColumnStates, r as paginateClientRows, R as parseClientViewState, i as parseCursorPagination, f as parseFilter, a as parsePagination, N as parseSearchQuery, o as parseServerPagination, k as parseSorting, B as parseTableState, K as placeColumn, _ as queryBuilderFilterColumns, v as queryNodeAt, w as removeFilterColumnConditions, T as removeFilterCondition, y as removeQueryNode, E as replaceFilterCondition, b as replaceQueryNode, s as resetPagination, c as resizePagination, l as resolvePagination, oe as resolveTableMessages, P as searchClientRows, Y as selectClientRows, p as serializeFilter, V as serializeState, A as sortClientRows, x as toggleQueryNegation };
@@ -1,6 +1,6 @@
1
1
  import type { Accessor, JSX } from "solid-js";
2
2
  import type { ColumnValue, ResolvedColumn } from "./columns.ts";
3
- import type { DataTableProps, DataTableResult } from "./DataTable.tsx";
3
+ import type { DataTableInternalProps, DataTableResult } from "./DataTable.tsx";
4
4
  import type { FilterColumn, FilterNode } from "./filter.ts";
5
5
  import type { ClientRowGroup } from "./grouping.ts";
6
6
  import type { TableMessages } from "./messages.ts";
@@ -38,15 +38,15 @@ export interface DisplayGroupRow<Row extends object> {
38
38
  export type DisplayRow<Row extends object> = DisplayDataRow<Row> | DisplayGroupRow<Row>;
39
39
  /** What a feature may read from, and ask of, the table that composes it. */
40
40
  export interface DataTableFeatureContext<Row extends object> {
41
- readonly props: DataTableProps<Row>;
41
+ readonly props: DataTableInternalProps<Row>;
42
42
  readonly definitions: readonly ResolvedColumn<Row>[];
43
43
  readonly filterColumns: readonly FilterColumn[];
44
44
  readonly messages: Accessor<TableMessages>;
45
45
  readonly locale: Accessor<string>;
46
46
  /** A query is unsettled. Structural changes wait for accepted state. */
47
47
  readonly pending: Accessor<boolean>;
48
- /** Accepted rows, total, facets, and server groups. */
49
- readonly result: Accessor<DataTableResult<Row>>;
48
+ /** Accepted rows, facets, and server groups. Totals stay with the table because cursor pages may not know them. */
49
+ readonly result: Accessor<Pick<DataTableResult<Row>, "rows" | "facets" | "groups">>;
50
50
  readonly accepted: Accessor<boolean>;
51
51
  readonly acceptedFilter: Accessor<FilterNode>;
52
52
  readonly requestFilter: (filter: FilterNode) => void;
@@ -101,11 +101,16 @@ export interface DataTableFeatureInstance<Row extends object> {
101
101
  /** Rendered once at the end of the table section. */
102
102
  readonly overlay?: () => JSX.Element;
103
103
  }
104
+ export type DataTableFeatureId = "filterBar" | "grouping" | "hierarchy" | "cellEditing";
104
105
  /**
105
- * Internal composition contract. A feature validates the props it owns and returns undefined when inactive.
106
- * Features are row-agnostic so a later public `features` list can type-check against any DataTable.
106
+ * An opt-in DataTable capability for `createDataTable`. Only Sheen's exported features are supported; the
107
+ * context contract is internal. A feature validates the props it owns and returns undefined when inactive.
108
+ * Features are row-agnostic so one list type-checks against any DataTable.
107
109
  */
108
- export type DataTableFeature = <Row extends object>(context: DataTableFeatureContext<Row>) => DataTableFeatureInstance<Row> | undefined;
110
+ export interface DataTableFeature<Id extends DataTableFeatureId = DataTableFeatureId> {
111
+ readonly id: Id;
112
+ readonly create: <Row extends object>(context: DataTableFeatureContext<Row>) => DataTableFeatureInstance<Row> | undefined;
113
+ }
109
114
  export declare function defaultCell(value: ColumnValue): JSX.Element;
110
115
  /**
111
116
  * Holds a framework-neutral store's immutable snapshot in a signal. Stores publish by replacing their
@@ -121,9 +126,9 @@ export declare function createSnapshotSignal<Snapshot>(read: () => Snapshot): {
121
126
  * object reaches only the readers of that record without writing reactive state while deriving rows.
122
127
  */
123
128
  export declare function createStableRows<Row extends object>(getRowId: (row: Row) => string, source: Accessor<readonly Row[]>): StableRows<Row>;
124
- /** First-seen groups over complete client data or delegated server groups for the accepted page. */
125
- export declare function groupingFeature<Row extends object>(context: DataTableFeatureContext<Row>): DataTableFeatureInstance<Row> | undefined;
126
- /** Expandable parent rows with synchronous children or independently loaded subtrees. */
127
- export declare function hierarchyFeature<Row extends object>(context: DataTableFeatureContext<Row>): DataTableFeatureInstance<Row> | undefined;
128
- /** Inline editing for columns that declare an editor. Drafts survive virtualization until the reset boundary changes. */
129
- export declare function cellEditingFeature<Row extends object>(context: DataTableFeatureContext<Row>): DataTableFeatureInstance<Row> | undefined;
129
+ /** Client or delegated server grouping through the `grouping` prop. */
130
+ export declare const groupingFeature: DataTableFeature<"grouping">;
131
+ /** Expandable row trees through the `hierarchy` prop. */
132
+ export declare const hierarchyFeature: DataTableFeature<"hierarchy">;
133
+ /** Inline editing for columns that declare an editor, through `onCellCommit` and `editResetKey`. */
134
+ export declare const cellEditingFeature: DataTableFeature<"cellEditing">;
@@ -542,9 +542,19 @@ function Y(t) {
542
542
  overlay: () => a(p, { controller: o })
543
543
  };
544
544
  }
545
+ var X = {
546
+ id: "grouping",
547
+ create: K
548
+ }, Z = {
549
+ id: "hierarchy",
550
+ create: q
551
+ }, Q = {
552
+ id: "cellEditing",
553
+ create: Y
554
+ };
545
555
  o([
546
556
  "click",
547
557
  "keydown",
548
558
  "input"
549
559
  ]);
550
- export { Y as cellEditingFeature, H as createSnapshotSignal, U as createStableRows, V as defaultCell, K as groupingFeature, q as hierarchyFeature };
560
+ export { Q as cellEditingFeature, H as createSnapshotSignal, U as createStableRows, V as defaultCell, X as groupingFeature, Z as hierarchyFeature };
package/dist/index.d.ts CHANGED
@@ -1,7 +1,9 @@
1
1
  export * from "./core.ts";
2
- export { DataTable } from "./DataTable.tsx";
3
- export type { DataTableProps, DataTableResult, DataTableInitialState, DataTableSelectionOptions, DataTableGroupingOptions, DataTableHierarchyOptions, DataTableExportFormat, DataTableExportOptions, DataTableCellCommitRequest, DataTableAction, DataTableActionContext, DataTableMobileLayoutOptions, DataTableVariant, DataTableDensity, DataTableSearchOptions, DataTableFilterBarOptions, ClientDataTableProps, ServerDataTableProps } from "./DataTable.tsx";
4
- export { FilterBar } from "./FilterBar.tsx";
2
+ export { DataTable, createDataTable } from "./DataTable.tsx";
3
+ export { groupingFeature, hierarchyFeature, cellEditingFeature } from "./data-table-features.tsx";
4
+ export type { DataTableFeature, DataTableFeatureId } from "./data-table-features.tsx";
5
+ export type { ComposedDataTable, ComposedDataTableProps, DataTableProps, DataTableResult, DataTableCursorResult, DataTableInitialState, DataTableSelectionOptions, DataTableGroupingOptions, DataTableHierarchyOptions, DataTableExportFormat, DataTableExportOptions, DataTableCellCommitRequest, DataTableAction, DataTableActionContext, DataTableMobileLayoutOptions, DataTableVariant, DataTableDensity, DataTableSearchOptions, DataTableFilterBarOptions, ClientDataTableProps, ServerDataTableProps } from "./DataTable.tsx";
6
+ export { FilterBar, filterBarFeature } from "./FilterBar.tsx";
5
7
  export type { FilterBarProps, FilterDateEditor, FilterDateEditorProps } from "./FilterBar.tsx";
6
8
  export { QueryBuilder } from "./QueryBuilder.tsx";
7
9
  export type { QueryBuilderProps } from "./QueryBuilder.tsx";
package/dist/index.js CHANGED
@@ -1,31 +1,32 @@
1
- import { assessServerPage as e, getPageRange as t, paginateClientRows as n, parsePagination as r, resetPagination as i, resizePagination as a, resolvePagination as o } from "./pagination.js";
2
- import { createTableRequests as s } from "./requests.js";
3
- import { deserializeFilter as c, parseFilter as l, serializeFilter as u } from "./filter.js";
4
- import { appendQueryChild as d, defaultQueryRule as f, moveQueryNode as p, queryBuilderFilterColumns as m, queryNodeAt as h, removeQueryNode as g, replaceQueryNode as _, toggleQueryNegation as v } from "./query-builder-state.js";
5
- import { appendFilterCondition as y, listFilterConditions as b, removeFilterColumnConditions as x, removeFilterCondition as S, replaceFilterCondition as C } from "./filter-bar-state.js";
6
- import { compileFilter as w, filterClientRows as T } from "./filter-client.js";
7
- import { parseSorting as E, sortClientRows as D } from "./sorting.js";
8
- import { countClientFacets as O } from "./facets.js";
9
- import { formatSearchQuery as k, parseSearchQuery as A, searchClientRows as j } from "./search.js";
10
- import { createDebouncedSearch as M } from "./search-controller.js";
11
- import { createClientView as N } from "./client-view.js";
12
- import { changeClientViewState as P, parseClientViewState as F } from "./client-state.js";
13
- import { deserializeState as I, parseTableState as L, serializeState as R } from "./table-state.js";
14
- import { changeTableState as z } from "./table-state-changes.js";
15
- import { canMoveColumn as B, moveColumn as V, orderColumnStates as H, placeColumn as U } from "./column-layout.js";
16
- import { createTableSelection as W } from "./selection.js";
17
- import { createClientExport as G } from "./export.js";
18
- import { selectClientRows as K } from "./selection-client.js";
19
- import { createServerExport as q } from "./server-export.js";
20
- import { createCellEdit as J } from "./cell-edit.js";
21
- import { defineColumns as Y } from "./columns.js";
22
- import { createRowIdentity as X } from "./row-identity.js";
23
- import { groupClientRows as Z, normalizeServerGroups as Q } from "./grouping.js";
24
- import { createRowHierarchy as $ } from "./row-hierarchy.js";
25
- import { createTableUrlState as ee } from "./url-state.js";
26
- import { createSavedViews as te } from "./saved-views.js";
27
- import { englishTableMessages as ne, resolveTableMessages as re } from "./messages.js";
28
- import { DataTable as ie } from "./DataTable.js";
29
- import { FilterBar as ae } from "./FilterBar.js";
30
- import { QueryBuilder as oe } from "./QueryBuilder.js";
31
- export { ie as DataTable, ae as FilterBar, oe as QueryBuilder, y as appendFilterCondition, d as appendQueryChild, e as assessServerPage, B as canMoveColumn, P as changeClientViewState, z as changeTableState, w as compileFilter, O as countClientFacets, J as createCellEdit, G as createClientExport, N as createClientView, M as createDebouncedSearch, $ as createRowHierarchy, X as createRowIdentity, te as createSavedViews, q as createServerExport, s as createTableRequests, W as createTableSelection, ee as createTableUrlState, f as defaultQueryRule, Y as defineColumns, c as deserializeFilter, I as deserializeState, ne as englishTableMessages, T as filterClientRows, k as formatSearchQuery, t as getPageRange, Z as groupClientRows, b as listFilterConditions, V as moveColumn, p as moveQueryNode, Q as normalizeServerGroups, H as orderColumnStates, n as paginateClientRows, F as parseClientViewState, l as parseFilter, r as parsePagination, A as parseSearchQuery, E as parseSorting, L as parseTableState, U as placeColumn, m as queryBuilderFilterColumns, h as queryNodeAt, x as removeFilterColumnConditions, S as removeFilterCondition, g as removeQueryNode, C as replaceFilterCondition, _ as replaceQueryNode, i as resetPagination, a as resizePagination, o as resolvePagination, re as resolveTableMessages, j as searchClientRows, K as selectClientRows, u as serializeFilter, R as serializeState, D as sortClientRows, v as toggleQueryNegation };
1
+ import { assessCursorPage as e, assessServerPage as t, getPageRange as n, paginateClientRows as r, parseCursorPagination as i, parsePagination as a, parseServerPagination as o, resetPagination as s, resizePagination as c, resolvePagination as l } from "./pagination.js";
2
+ import { createTableRequests as u } from "./requests.js";
3
+ import { deserializeFilter as d, parseFilter as f, serializeFilter as p } from "./filter.js";
4
+ import { appendQueryChild as m, defaultQueryRule as h, moveQueryNode as g, queryBuilderFilterColumns as _, queryNodeAt as v, removeQueryNode as y, replaceQueryNode as b, toggleQueryNegation as x } from "./query-builder-state.js";
5
+ import { appendFilterCondition as S, listFilterConditions as C, removeFilterColumnConditions as w, removeFilterCondition as T, replaceFilterCondition as E } from "./filter-bar-state.js";
6
+ import { compileFilter as D, filterClientRows as O } from "./filter-client.js";
7
+ import { parseSorting as k, sortClientRows as A } from "./sorting.js";
8
+ import { countClientFacets as j } from "./facets.js";
9
+ import { formatSearchQuery as M, parseSearchQuery as N, searchClientRows as P } from "./search.js";
10
+ import { createDebouncedSearch as F } from "./search-controller.js";
11
+ import { createClientView as I } from "./client-view.js";
12
+ import { changeClientViewState as L, parseClientViewState as R } from "./client-state.js";
13
+ import { deserializeState as z, parseTableState as B, serializeState as V } from "./table-state.js";
14
+ import { changeTableState as H } from "./table-state-changes.js";
15
+ import { canMoveColumn as U, moveColumn as W, orderColumnStates as G, placeColumn as K } from "./column-layout.js";
16
+ import { createTableSelection as q } from "./selection.js";
17
+ import { createClientExport as J } from "./export.js";
18
+ import { selectClientRows as Y } from "./selection-client.js";
19
+ import { createServerExport as X } from "./server-export.js";
20
+ import { createCellEdit as Z } from "./cell-edit.js";
21
+ import { defineColumns as Q } from "./columns.js";
22
+ import { createRowIdentity as $ } from "./row-identity.js";
23
+ import { groupClientRows as ee, normalizeServerGroups as te } from "./grouping.js";
24
+ import { createRowHierarchy as ne } from "./row-hierarchy.js";
25
+ import { createTableUrlState as re } from "./url-state.js";
26
+ import { createSavedViews as ie } from "./saved-views.js";
27
+ import { englishTableMessages as ae, resolveTableMessages as oe } from "./messages.js";
28
+ import { DataTable as se, createDataTable as ce } from "./DataTable.js";
29
+ import { cellEditingFeature as le, groupingFeature as ue, hierarchyFeature as de } from "./data-table-features.js";
30
+ import { FilterBar as fe, filterBarFeature as pe } from "./FilterBar.js";
31
+ import { QueryBuilder as me } from "./QueryBuilder.js";
32
+ export { se as DataTable, fe as FilterBar, me as QueryBuilder, S as appendFilterCondition, m as appendQueryChild, e as assessCursorPage, t as assessServerPage, U as canMoveColumn, le as cellEditingFeature, L as changeClientViewState, H as changeTableState, D as compileFilter, j as countClientFacets, Z as createCellEdit, J as createClientExport, I as createClientView, ce as createDataTable, F as createDebouncedSearch, ne as createRowHierarchy, $ as createRowIdentity, ie as createSavedViews, X as createServerExport, u as createTableRequests, q as createTableSelection, re as createTableUrlState, h as defaultQueryRule, Q as defineColumns, d as deserializeFilter, z as deserializeState, ae as englishTableMessages, pe as filterBarFeature, O as filterClientRows, M as formatSearchQuery, n as getPageRange, ee as groupClientRows, ue as groupingFeature, de as hierarchyFeature, C as listFilterConditions, W as moveColumn, g as moveQueryNode, te as normalizeServerGroups, G as orderColumnStates, r as paginateClientRows, R as parseClientViewState, i as parseCursorPagination, f as parseFilter, a as parsePagination, N as parseSearchQuery, o as parseServerPagination, k as parseSorting, B as parseTableState, K as placeColumn, _ as queryBuilderFilterColumns, v as queryNodeAt, w as removeFilterColumnConditions, T as removeFilterCondition, y as removeQueryNode, E as replaceFilterCondition, b as replaceQueryNode, s as resetPagination, c as resizePagination, l as resolvePagination, oe as resolveTableMessages, P as searchClientRows, Y as selectClientRows, p as serializeFilter, V as serializeState, A as sortClientRows, x as toggleQueryNegation };
@@ -13,6 +13,9 @@ export declare const englishTableMessages: Readonly<{
13
13
  tableControls: "{caption} table controls";
14
14
  resultCountOne: "{count} result";
15
15
  resultCount: "{count} results";
16
+ resultCountEstimate: "About {count} results";
17
+ resultCountAtLeast: "{count}+ results";
18
+ cursorPageRows: "Rows on this page: {count}";
16
19
  previousResults: "Previous results";
17
20
  clearFilters: "Clear filters";
18
21
  clearSearchAndFilters: "Clear search and filters";
package/dist/messages.js CHANGED
@@ -14,6 +14,9 @@ var e = Object.freeze({
14
14
  tableControls: "{caption} table controls",
15
15
  resultCountOne: "{count} result",
16
16
  resultCount: "{count} results",
17
+ resultCountEstimate: "About {count} results",
18
+ resultCountAtLeast: "{count}+ results",
19
+ cursorPageRows: "Rows on this page: {count}",
17
20
  previousResults: "Previous results",
18
21
  clearFilters: "Clear filters",
19
22
  clearSearchAndFilters: "Clear search and filters",
@@ -21,11 +21,51 @@ export type ServerPageAssessment<Row> = {
21
21
  readonly pagination: PageState;
22
22
  readonly total: number;
23
23
  };
24
+ /** Opaque server cursor plus the side of it to read. Null requests the first page. */
25
+ export interface CursorPosition {
26
+ readonly direction: "after" | "before";
27
+ readonly value: string;
28
+ }
29
+ export interface CursorPagination {
30
+ readonly kind: "cursor";
31
+ readonly pageSize: number;
32
+ readonly cursor: CursorPosition | null;
33
+ }
34
+ /** Every server pagination choice: complete (false), numbered, or cursor. */
35
+ export type ServerPagination = TablePagination | CursorPagination;
36
+ /** Optional full-query count. Estimates and lower bounds are announced as such, never as exact counts. */
37
+ export interface CursorTotal {
38
+ readonly kind: "exact" | "estimate" | "atLeast";
39
+ readonly value: number;
40
+ }
41
+ export interface CursorPageResult<Row> {
42
+ readonly rows: readonly Row[];
43
+ /** Null when no later page exists. */
44
+ readonly nextCursor: string | null;
45
+ /** Null when no earlier page exists. */
46
+ readonly previousCursor: string | null;
47
+ readonly total?: CursorTotal;
48
+ }
49
+ export type CursorPageAssessment<Row> = {
50
+ readonly kind: "accepted";
51
+ readonly pagination: CursorPagination;
52
+ readonly result: CursorPageResult<Row>;
53
+ } | {
54
+ readonly kind: "refetch";
55
+ readonly pagination: CursorPagination;
56
+ };
24
57
  export declare function parsePagination(value: unknown): TablePagination;
25
58
  export declare function resolvePagination(mode: "client" | "server", value?: TablePagination): TablePagination;
26
- /** Filter and sort changes reset the requested page, not accepted rows. */
59
+ export declare function parseCursorPagination(value: unknown): CursorPagination;
60
+ /** Validates any server choice. Cursor state is distinguished by its kind field. */
61
+ export declare function parseServerPagination(value: unknown): ServerPagination;
62
+ /** Filter and sort changes reset the requested page, not accepted rows. Cursor state returns to the first page. */
27
63
  export declare function resetPagination(value: TablePagination): TablePagination;
64
+ export declare function resetPagination(value: CursorPagination): CursorPagination;
65
+ export declare function resetPagination(value: ServerPagination): ServerPagination;
28
66
  export declare function resizePagination(value: PageState, pageSize: number): PageState;
67
+ export declare function resizePagination(value: CursorPagination, pageSize: number): CursorPagination;
68
+ export declare function resizePagination(value: PageState | CursorPagination, pageSize: number): PageState | CursorPagination;
29
69
  /** Clamp before multiplying so even extreme valid requested indices cannot overflow the offset. */
30
70
  export declare function getPageRange(value: PageState, total: number): PageRange;
31
71
  /** Call after transforming the complete client dataset, never on an individual server page. */
@@ -34,3 +74,5 @@ export declare function paginateClientRows<Row>(rows: readonly Row[], value?: Ta
34
74
  };
35
75
  /** Validate a single response; never fetch, concatenate pages, or publish an invalid result. */
36
76
  export declare function assessServerPage<Row>(value: TablePagination, result: PageResult<Row>): ServerPageAssessment<Row>;
77
+ /** Validate a single cursor response. An empty later page (for example after deletions) refetches the first page. */
78
+ export declare function assessCursorPage<Row>(value: CursorPagination, result: CursorPageResult<Row>): CursorPageAssessment<Row>;