@svgrid/grid 3.0.4 → 3.0.5

package/src/grid-messages.ts

@@ -106,9 +106,16 @@ export type GridChromeMessages = {
   bulkEditCancel: string
   bulkEditNoFields: string
   chartRange: string
+  // Rows whose data has not arrived (server-side / infinite loading)
+  rowLoadFailed: string
+  rowLoadRetry: string
   // Upsell notes (enterprise views not installed)
   pivotUpsellTitle: string
   pivotUpsellBody: string
+  ganttUpsellTitle: string
+  ganttUpsellBody: string
+  /** Placeholder in the Gantt view's search box. */
+  ganttSearchPlaceholder: string
   /** Shared licensing line under every Enterprise upsell note. */
   upsellLicense: string
   upsellLicenseLink: string
@@ -185,8 +192,13 @@ export const defaultGridMessages: GridChromeMessages = {
   opBefore: 'Before',
   opAfter: 'After',
   chartRange: 'Chart selected range',
+  rowLoadFailed: 'Could not load these rows.',
+  rowLoadRetry: 'Retry',
   pivotUpsellTitle: 'Pivot mode',
   pivotUpsellBody: 'Pivot mode is an Enterprise feature. Install @svgrid/enterprise and call enablePivot() to use it.',
+  ganttUpsellTitle: 'Gantt view',
+  ganttUpsellBody: 'The Gantt view is an Enterprise feature. Install @svgrid/enterprise and call enableGanttView() to render it.',
+  ganttSearchPlaceholder: 'Search tasks...',
   upsellLicense:
     'A license key is required for production use. Without one the feature still works, but the grid renders an unlicensed watermark.',
   upsellLicenseLink: 'View licensing',

package/src/icon-seam.test.ts

@@ -20,18 +20,16 @@ const SRC = join(process.cwd(), 'src')
 const read = (f: string) => readFileSync(join(SRC, f), 'utf8')
 
 /** Files that render grid chrome and therefore must go through the seam. */
-const CHROME = ['SvGrid.svelte', 'GridMenus.svelte', 'GridFooter.svelte', 'SvRowGroupPanel.svelte']
+const CHROME = ['SvGrid.svelte', 'GridMenus.svelte', 'GridFooter.svelte']
 
 /**
  * Drop the regions allowed to contain raw icon markup: the `icon` snippet's own
- * body (which IS the built-in set), the `ic` snippet in SvRowGroupPanel, and
- * every `<script>` block.
+ * body (which IS the built-in set) and every `<script>` block.
  */
 function stripAllowedRegions(src: string): string {
   let out = src.replace(/<script[\s\S]*?<\/script>/g, '')
   // The built-in catalogue: from the snippet header to its closing tag.
   out = out.replace(/\{#snippet icon\(name: GridIconName\)\}[\s\S]*?\n\{\/snippet\}/g, '')
-  out = out.replace(/\{#snippet ic\(name: GridIconName\)\}[\s\S]*?\{\/snippet\}/g, '')
   return out
 }
 

package/src/index.ts

@@ -121,6 +121,23 @@ export type {
   SchedulerOccurrenceChangeEvent,
 } from './SvGrid.types'
 export { registerSchedulerView, getSchedulerView, hasSchedulerView } from './scheduler-view.svelte'
+// Gantt view. Same split as the scheduler: the `gantt` prop and its config
+// types live in the free grid, the RENDERER ships in @svgrid/enterprise and
+// registers itself through this seam (see gantt-view.svelte.ts). Unlike the
+// scheduler, the Gantt's layout model lives in enterprise too - only the
+// renderer reads it.
+export type {
+  GanttConfig,
+  GanttDrawerConfig,
+  GanttTaskMoveEvent,
+  GanttTaskResizeEvent,
+  GanttProgressChangeEvent,
+  GanttTaskCommitEvent,
+  GanttDependency,
+  GanttDependencyType,
+  GanttZoom,
+} from './SvGrid.types'
+export { registerGanttView, getGanttView, hasGanttView } from './gantt-view.svelte'
 // Bulk-action bar over the row selection. Prop + types free, renderer Pro.
 export { registerSelectionBarView, getSelectionBarView, hasSelectionBarView } from './selection-bar-view.svelte'
 // Chart view. The `chart` prop + its config live in the free grid AND so does the
@@ -754,9 +771,11 @@ export {
 export {
   createServerDataSource,
   type ServerDataSource,
+  type ServerSelectionRule,
   type ServerRequest,
   type ServerResult,
   type ServerController,
+  type ServerControllerOptions,
   type ServerState,
   type ServerSortModel,
   type ServerFilterModel,
@@ -766,19 +785,26 @@ export {
   type ServerMoreRow,
   type ServerFooterRow,
   type ServerSkeletonRow,
+  type ServerGrandTotalRow,
+  type ServerPlaceholderRow,
   type ServerDisplayRow,
 } from './server-data-source'
 export {
-  createServerGroupModel,
-  serverGroupRows,
-  serverGroupNav,
-  type ServerGroupController,
-  type ServerGroupControllerOptions,
-  type ServerGroupState,
-  type ServerGroupGridRow,
-} from './server-group-model'
-export { default as SvGroupCell } from './SvGroupCell.svelte'
-export { default as SvRowGroupPanel } from './SvRowGroupPanel.svelte'
+  createBlockCache,
+  createRowPlaceholder,
+  rowPlaceholderState,
+  type BlockCache,
+  type BlockCacheOptions,
+  type BlockCacheState,
+  type BlockFetchResult,
+  type BlockState,
+} from './server-block-cache'
+export {
+  toServerFilterColumns,
+  type GridRowModel,
+  type GridFilterState,
+  type GridRowModelSort,
+} from './row-model'
 export {
   createNamedViews,
   memoryViews,

package/src/row-model.ts

@@ -0,0 +1,146 @@
+/**
+ * `GridRowModel` - one prop instead of eleven.
+ *
+ * A grid backed by a server needs the same wiring every time: hand it the
+ * rows, tell it not to sort or filter locally, forward the sort and the filter
+ * to the backend, report which rows are on screen, say which rows have not
+ * loaded, and delegate selection. Written out by hand that is a dozen props
+ * and a filter-shape conversion that every app gets slightly differently:
+ *
+ * ```svelte
+ * <SvGrid data={s.rows} externalSort externalFilter loading={s.loading}
+ *   onSortingChange={(x) => ctl.setSort(x)}
+ *   onFiltersChange={(f) => ctl.setFilter({ global: f.global,
+ *     columns: Object.fromEntries(f.columns.map((c) => [c.id, { ... }])) })}
+ *   onVisibleRangeChange={(r) => ctl.setViewport(r.startIndex, r.endIndex)}
+ *   ... />
+ * ```
+ *
+ * An object that implements this interface carries all of it, so the same grid
+ * becomes:
+ *
+ * ```svelte
+ * <SvGrid rowModel={ctl} {columns} />
+ * ```
+ *
+ * `createServerDataSource` returns one, and so does the Enterprise server row
+ * model - which is the point of the interface rather than a concrete type: the
+ * grid depends on the SHAPE, never on either implementation, and an app with
+ * its own fetching can satisfy it too.
+ *
+ * Every member except `subscribe` / `getRows` / `isLoading` is optional, and a
+ * prop written explicitly on `<SvGrid>` always wins over the model's answer -
+ * so adopting this is never all-or-nothing.
+ */
+import type { FilterOperator } from './SvGrid.types'
+
+/** The filter state as the grid reports it, straight from `onFiltersChange`. */
+export type GridFilterState = {
+  global: string
+  columns: Array<{
+    id: string
+    operator: FilterOperator
+    value: string
+    valueTo?: string
+    selectedValues?: Array<string>
+  }>
+}
+
+/** The sort the grid hands a row model: column id and direction, in priority order. */
+export type GridRowModelSort = Array<{ id: string; desc: boolean }>
+
+/**
+ * What `<SvGrid rowModel>` consumes: rows, a loading flag, a change
+ * subscription, and whichever optional parts the model implements - sort,
+ * filter, viewport, placeholders, group accessors, selection, filter
+ * values, paging, pinned rows and pivot columns. `createServerDataSource`
+ * and the Enterprise `createServerRowModel` both satisfy it.
+ */
+export type GridRowModel<TData> = {
+  /**
+   * Register a callback for "something changed, re-read me". Returns an
+   * unsubscribe function, which the grid calls on unmount.
+   */
+  subscribe(onChange: () => void): () => void
+  /** The rows to render, including any placeholders for unloaded ones. */
+  getRows(): ReadonlyArray<TData>
+  /** True while a fetch is in flight, for the loading overlay. */
+  isLoading(): boolean
+  /** Stable row id. Required once selection or editing is involved. */
+  getRowId?(row: TData, index: number): string
+  /** Sort on the server. Present means "do not sort locally". */
+  setSort?(sort: GridRowModelSort): void
+  /** Filter on the server. Present means "do not filter locally". */
+  setFilter?(filters: GridFilterState): void
+  /** Which rows are on screen, so a block-loading model knows what to fetch. */
+  setViewport?(startIndex: number, endIndex: number): void
+  /** Why a row has no data yet, or null when it does. */
+  rowPlaceholder?(row: TData, rowIndex: number): 'loading' | 'failed' | null
+  /** Retry the failed block a placeholder row belongs to. */
+  retryRow?(row: TData, rowIndex: number): void
+  /** Group / tree accessors, for the grid's treegrid keyboard and ARIA. */
+  group?: {
+    isGroup: (row: TData) => boolean
+    level: (row: TData) => number
+    expanded?: (row: TData) => boolean
+    onToggle: (row: TData) => void
+  }
+  /** Selection the grid does not own - see the `rowSelectionModel` prop. */
+  selection?: {
+    isSelected: (rowId: string, row: TData) => boolean
+    headerState: () => 'none' | 'some' | 'all'
+    toggle: (rowId: string, row: TData, next: boolean) => void
+    toggleAll: (next: boolean) => void
+    selectedCount?: () => number | null
+    bulkUpdate?: (patch: Record<string, unknown>) => Promise<number>
+  }
+  /** Distinct values for a column's set filter, fetched from the server. */
+  filterValues?(columnId: string): Promise<Array<string>>
+  /** Server-side paging. Omit it for infinite scrolling. */
+  pagination?: {
+    pageIndex: number
+    pageSize: number
+    rowCount: number
+    setPage(pageIndex: number): void
+    setPageSize(pageSize: number): void
+    /** Choices for the footer's page-size selector. */
+    pageSizes?: number[]
+    /**
+     * Ask the grid for as many rows as its body fits: it measures and calls
+     * `setPageSize` whenever the fit changes.
+     */
+    autoPageSize?: boolean
+  }
+  /** Rows to pin above / below the scrolling body - a grand total, say. */
+  readonly pinnedTopRows?: ReadonlyArray<TData>
+  readonly pinnedBottomRows?: ReadonlyArray<TData>
+  /**
+   * Columns that replace the grid's `columns` while the model is in pivot
+   * mode, or null. Read after every change notification.
+   */
+  readonly pivotResultColumns?: ReadonlyArray<unknown> | null
+}
+
+/**
+ * Turn the grid's filter payload into the column-keyed map a `ServerRequest`
+ * carries. Exported because a hand-written `GridRowModel` needs exactly this
+ * conversion, and copying it is how the two shapes drift apart.
+ */
+export function toServerFilterColumns(
+  filters: GridFilterState,
+): Record<
+  string,
+  { operator: string; value: string; valueTo?: string; selectedValues?: Array<string> }
+> {
+  return Object.fromEntries(
+    filters.columns.map((c) => [
+      c.id,
+      {
+        operator: c.operator,
+        value: c.value,
+        ...(c.valueTo !== undefined ? { valueTo: c.valueTo } : {}),
+        ...(c.selectedValues !== undefined ? { selectedValues: c.selectedValues } : {}),
+      },
+    ]),
+  )
+}

package/src/selection.test.ts

@@ -39,6 +39,9 @@ function makeCtx(overrides: any = {}) {
     allRows: [],
     allColumns: [],
     headerSelectionState: 'none',
+    // The real controller always supplies this; a fake that omits it would
+    // make every select-all path throw rather than assert.
+    placeholderStateOf: () => null,
     userHasActivatedCell: false,
     enableCellSelectionEffective: true,
     selectionRange: { anchor: null, focus: null },

package/src/selection.ts

@@ -21,16 +21,45 @@ export function createSelection<
   TData extends RowData = RowData,
 >(ctx: any) {
   function isRowSelected(rowId: string) {
+    const model = ctx.props.rowSelectionModel;
+    if (model) {
+      const row = ctx.allRows.find((r: any) => r.id === rowId);
+      return row ? model.isSelected(rowId, row.original) : false;
+    }
     return Boolean(ctx.rowSelectionState[rowId]);
   }
 
   function toggleRowSelectionById(rowId: string) {
+    const model = ctx.props.rowSelectionModel;
+    if (model) {
+      const row = ctx.allRows.find((r: any) => r.id === rowId);
+      if (!row) return;
+      model.toggle(rowId, row.original, !model.isSelected(rowId, row.original));
+      return;
+    }
     ctx.grid.setRowSelection((prev: any) => ({ ...prev, [rowId]: !prev[rowId] }));
   }
 
   function toggleSelectAllRows() {
-    const selectable = ctx.allRows.filter((row: any) => !isGroupRow(row));
-    const select = ctx.headerSelectionState !== "all";
+    setSelectAllRows(ctx.headerSelectionState !== "all");
+  }
+
+  /**
+   * Select or clear every row, for the header checkbox and for
+   * `api.selectAllRows()`.
+   */
+  function setSelectAllRows(select: boolean) {
+    // An external model decides what "all" means - possibly a million rows
+    // the grid has never seen - so it gets the intent, not a row list.
+    if (ctx.props.rowSelectionModel) {
+      ctx.props.rowSelectionModel.toggleAll(select);
+      return;
+    }
+    // Placeholder rows are excluded: there is no row there to select yet,
+    // and ticking one would leave a selected id that never resolves.
+    const selectable = ctx.allRows.filter(
+      (row: any) => !isGroupRow(row) && !ctx.placeholderStateOf(row),
+    );
     ctx.grid.setRowSelection((prev: any) => {
       const next = { ...prev };
       for (const row of selectable) {
@@ -687,6 +716,7 @@ export function createSelection<
     isRowSelected,
     toggleRowSelectionById,
     toggleSelectAllRows,
+    setSelectAllRows,
     setActiveCell,
     scrollActiveCellIntoView,
     setSelection,