ag-grid-ssr-to-query

Adapter that converts ag-Grid Server-Side Row Model requests into type-safe QueryOptions<T> from @comradeweb/db-query-dsl. Use it to bridge ag-Grid filters/sorting/pagination to your DB/ORM adapter that already understands the Query DSL.

Installation

pnpm add @comradeweb/ag-grid-ssr-to-query
# or
npm i @comradeweb/ag-grid-ssr-to-query
# or
yarn add @comradeweb/ag-grid-ssr-to-query

Quick start

import {
  AgGridRequestToQueryDSL,
  ServerSideGetRowsRequest,
} from '@comradeweb/ag-grid-ssr-to-query';
import type { QueryOptions } from '@comradeweb/db-query-dsl';

type User = {
  id: string;
  email: string;
  name: string;
  age: number;
  createdAt: Date;
};

declare const request: ServerSideGetRowsRequest;

const queryOptions: QueryOptions<User> = AgGridRequestToQueryDSL.convert<User>(
  request,
  {
    // optional: override quick filter fields (dot-notation supported)
    quickFilterFields: ['name', 'email'],
  },
);

// pass QueryOptions<User> to your @comradeweb/db-query-dsl adapter

What it does

• Converts ag-Grid filterModel (including compound filters) to Where<T>.
• Converts sortModel to SortOptions<T>.
• Derives pagination (offset/limit) from startRow/endRow.
• Builds quick filter OR-query across configurable fields.

Date filter semantics

• date + equals is treated as a calendar day match, not timestamp equality.
• Internally it is converted to a half-open range:
  • gte = startOfDayUTC(dateFrom)
  • lt = startOfNextDayUTC(dateFrom)
• This avoids millisecond edge cases and correctly matches any timestamp within that day.

API

• AgGridRequestToQueryDSL.convert<T>(request, options?) => QueryOptions<T>
  • options.quickFilterFields?: QuickFilterFields<T> — override fields used for quick filter. Defaults to ['name', 'email', 'title', 'description'].
• Types:
  • QuickFilterFields<T> — readonly array of field paths (dot-notation allowed) from your domain type T.
  • ConvertOptions<T> — options bag for convert.

Development

• Install deps: pnpm install
• Scripts:
  • pnpm run type:check
  • pnpm run type:test (tsd)
  • pnpm run build

License

MIT © Vyacheslav D.

Contributing

See CONTRIBUTING.md for workflow, scripts, and release process.