ag-grid-url-sync 0.5.1 → 0.5.2

package/README.md

@@ -145,7 +145,7 @@ The library provides two main entry points:
 
 ```typescript
 // Core functionality - works with any framework
-import { createUrlSync } from 'ag-grid-url-sync'
+import { createGridUrlSync } from 'ag-grid-url-sync'
 
 // React hook - for React applications
 import { useAGGridUrlSync } from 'ag-grid-url-sync/react'
@@ -247,7 +247,55 @@ The config form (`getFilterModel({ ...DEFAULT_CONFIG, gridApi })`) still works,
 
 **💡 Pro Tip**: Use granular imports in libraries and applications where bundle size matters. All existing import patterns remain fully supported for backward compatibility.
 
-### Basic Example
+### Vanilla JS: `createGridUrlSync`
+
+One call gives full sync. `createGridUrlSync` applies the address bar's filters to the grid, follows the grid's filter changes, can write them to the address bar, and removes its listeners when the grid is destroyed.
+
+```typescript
+import { createGridUrlSync, individual, grouped } from 'ag-grid-url-sync'
+
+const sync = createGridUrlSync({
+  api: gridApi,
+  codec: individual({ prefix: 'f_' }), // or grouped({ param: 'gf', format: 'json' })
+  history: 'replace', // 'none' (default) | 'replace' | 'push' | (url) => router.replace(url)
+  onIssue: ({ issue, source }) => {
+    if (issue.severity === 'warning') showToast(issue.message)
+  }
+})
+
+// The current state: { status, url, hasFilters, issues, views, activeViewId }
+const { url, hasFilters } = sync.getSnapshot()
+
+// Called after each change of the snapshot. Returns an unsubscribe function.
+const unsubscribe = sync.subscribe(() => render(sync.getSnapshot()))
+
+sync.applyUrl('https://app.com/data?f_name_contains=jo') // { issues }
+sync.getUrl('https://app.com/share') // a share link for the grid's filters
+sync.applyFilters({
+  name: { filterType: 'text', type: 'contains', filter: 'jo' }
+}) // { issues }
+sync.destroy()
+```
+
+`applyFilters` writes filters to the grid as the app's own write. When they land, the sync writes the URL in the `history` mode, as it does for a user edit. `applyUrl` writes no history, because the URL already holds those filters.
+
+| Option             | Default                   | Meaning                                                                                                                                                                                                   |
+| ------------------ | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `api`              | (required)                | The AG Grid API                                                                                                                                                                                           |
+| `codec`            | `individual()`            | How the filters are written in the URL. `individual({ prefix })` writes one param for each filter; `grouped({ param, format })` writes all filters in one param                                           |
+| `maxValueLength`   | `200`                     | The longest text value that is kept                                                                                                                                                                       |
+| `history`          | `'none'`                  | How a filter change goes to the address bar. `'replace'` and `'push'` use `window.history`; a function gets the URL, for a router. The page's other params, the `#hash` and `history.state` stay          |
+| `popstate`         | `true` only with `'push'` | Apply the URL when the back or forward button changes it                                                                                                                                                  |
+| `applyUrlOnCreate` | `true`                    | Apply the address bar's filters on create. A URL with no filter params keeps the grid's filters (for example from `initialState`), and with `history` they are written to the URL with replace            |
+| `views`            | none                      | The saved views. Give `createViewStore(key)` from `ag-grid-url-sync/view-storage`. See [Saved Views](#saved-views)                                                                                        |
+| `throwOnError`     | `false`                   | Throw an issue instead of reporting it, in the methods that the app calls (`applyUrl`, `getUrl`, `applyFilters`, `saveView`, `loadView`, `deleteView`). `createGridUrlSync` and its listeners never throw |
+| `onIssue`          | none                      | Gets each issue one time, as `{ issue, source }`. `source` is `'url'` (the sync read the address bar), `'grid'` (it read the grid) or `'api'` (a method that the app called)                              |
+
+The snapshot `status` is `'active'` from create, and `'destroyed'` after `destroy()` or after the grid is destroyed. After that, `applyUrl`, `applyFilters`, `saveView` and `loadView` report `NOT_READY` to `onIssue`. `deleteView` needs only storage, so it still works. `IDLE_SNAPSHOT` (`status: 'idle'`) is the snapshot for a time when there is no sync yet. `getSnapshot()` returns the same object until something changes, so it works with React's `useSyncExternalStore`. The sync writes no history for an `applyUrl` apply, because the URL holds those filters already. `applyFilters` and `loadView` write the URL as a user edit does. Nothing reads `window` when the module loads, and a sync made with no `window` does nothing to the address bar.
+
+### Basic Example (deprecated `createUrlSync`)
+
+`createUrlSync` and `AGGridUrlSync` will be removed in 0.6.0. Use `createGridUrlSync`.
 
 ```typescript
 import { createUrlSync } from 'ag-grid-url-sync'
@@ -457,6 +505,9 @@ The library never writes to the console. Each problem goes to one callback, and
 | `NOT_READY`                                                   | A hook operation called before the grid is ready               | `onError` (React)                                                                                        |
 | `VIEW_NOT_FOUND`, `VIEW_NAME_REQUIRED`                        | A saved view operation that cannot run                         | `onError` (React)                                                                                        |
 | `STORAGE_UNAVAILABLE`, `STORAGE_FULL`, `STORAGE_WRITE_FAILED` | Browser storage for saved views failed                         | `onError` (React)                                                                                        |
+| `HISTORY_WRITE_FAILED`                                        | The sync could not write the address bar                       | `onIssue` in the core, `onError` in the React hook                                                       |
+
+Each error has a `severity`: `'warning'` for the first seven rows, `'error'` for the others. `createGridUrlSync` sends every issue to `onIssue`; the callbacks in the table are for the deprecated API and the React hook.
 
 The codes in the first seven rows are data issues: a filter that is dropped or is not valid. The library skips that filter and keeps the others. When the library knows the column, it is in `error.column`. `onParseError` is typed with `Error`, so check `instanceof URLSyncError` before you read `code` or `column`.
 
@@ -507,7 +558,7 @@ return issues.length > 0 ? (
 
 Like TanStack Query, the library can throw an issue instead of reporting it. Set `throwOnError: true` to throw every issue, or give a function that picks issues. In the core, a thrown issue does not go to `onParseError`, and the first one stops the call. In React, the hook keeps reporting each issue to `onParseError` one time, and then throws the picked issue during render, so an error boundary catches it. The default is `false`.
 
-The library does not change the address bar. Before an error boundary resets, remove the bad param from the URL (or the filter from the grid), or the same issue is thrown again.
+Only `createGridUrlSync` or the hook with `history` changes the address bar. Before an error boundary resets, remove the bad param from the URL (or the filter from the grid), or the same issue is thrown again.
 
 ```tsx
 useAGGridUrlSync(gridApi, {
@@ -533,7 +584,7 @@ Refer to the [package.json](./package.json) for the full export map.
 
 ## React Integration
 
-For React applications, use the dedicated `useAGGridUrlSync` hook that provides a complete solution with React-specific features and state management.
+For React applications, use the `useGridUrlSync` hook. It is a thin adapter on [`createGridUrlSync`](#vanilla-js-creategridurlsync): it takes the same options, and the grid behaves as with the vanilla sync. The older `useAGGridUrlSync` hook is deprecated and will be removed in 0.6.0 (see [Migrating from `useAGGridUrlSync`](#migrating-from-useaggridurlsync)).
 
 ### Installation for React
 
@@ -541,7 +592,90 @@ For React applications, use the dedicated `useAGGridUrlSync` hook that provides
 npm install ag-grid-url-sync
 ```
 
-### Basic React Usage
+The hook works with React 16.8 and later. It uses the `use-sync-external-store` package, which npm installs with the library. On React 18 and later, that package uses React's own `useSyncExternalStore`.
+
+### `useGridUrlSync({ api, ...options })`
+
+```tsx
+import { useState } from 'react'
+import { AgGridReact } from 'ag-grid-react'
+import type { GridApi } from 'ag-grid-community'
+import { useGridUrlSync } from 'ag-grid-url-sync/react'
+import { individual } from 'ag-grid-url-sync'
+
+function GridComponent() {
+  const [api, setApi] = useState<GridApi | null>(null)
+
+  const { status, hasFilters, issues, getUrl, applyFilters } = useGridUrlSync({
+    api,
+    codec: individual({ prefix: 'filter_' }),
+    history: 'push', // each filter change adds a history entry; back and forward apply the URL
+    onIssue: ({ issue, source }) => console.warn(source, issue.code)
+  })
+
+  return (
+    <div>
+      <button
+        disabled={status !== 'active'}
+        onClick={() => navigator.clipboard.writeText(getUrl())}
+      >
+        Share filters
+      </button>
+      <button disabled={!hasFilters} onClick={() => applyFilters({})}>
+        Clear filters
+      </button>
+      {issues.length > 0 && (
+        <p>The link leaves out {issues.length} filter(s)</p>
+      )}
+      <AgGridReact onGridReady={params => setApi(params.api)} {...gridProps} />
+    </div>
+  )
+}
+```
+
+The options are the [`createGridUrlSync` options](#vanilla-js-creategridurlsync) (`codec`, `maxValueLength`, `history`, `popstate`, `applyUrlOnCreate`, `throwOnError`, `onIssue`), with these changes:
+
+| Option         | Default | Description                                                                                                                                                                                                     |
+| -------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `api`          | none    | The AG Grid API, or `null` while the grid starts                                                                                                                                                                |
+| `storageKey`   | none    | Enables saved views, kept in `localStorage` under this key (in place of the core's `views` store). With no key, the view methods do nothing                                                                     |
+| `enabled`      | `true`  | With `false`, the hook makes no sync: `status` is `'idle'`, and a method reports `NOT_READY`. `views` still shows what is in storage. Back to `true` starts again, as a new sync does: the URL is applied again |
+| `throwOnError` | `false` | As in TanStack Query: the hook throws a picked issue during render, so an error boundary catches it. The methods do not throw                                                                                   |
+
+The hook returns the snapshot and the methods of the sync:
+
+| Property                             | Description                                                                      |
+| ------------------------------------ | -------------------------------------------------------------------------------- |
+| `status`                             | `'idle'` (no grid, no sync yet, or a server render), `'active'` or `'destroyed'` |
+| `url`, `hasFilters`, `issues`        | The URL with the grid's filters, whether there are filters, the latest issues    |
+| `views`, `activeViewId`              | The saved views and the active one                                               |
+| `applyUrl(url?)`, `applyFilters(f)`  | Apply a URL or filters. They return `{ issues }`                                 |
+| `getUrl(baseUrl?)`                   | The URL with the grid's filters, for example to share                            |
+| `saveView`, `loadView`, `deleteView` | The saved view methods of the sync                                               |
+
+- **The core's rules hold.** On mount, a URL with filters wins over the stored view, a URL with no filters keeps the grid's filters, and a URL apply writes no history.
+- **Options can change after mount.** A new codec, `maxValueLength`, history mode, `popstate` or `storageKey` makes a new sync on the same grid. It does not apply the URL again, and it keeps the active view. A new `storageKey` restores that store's view. A new codec object with the same settings, a new `onIssue` or a new `history` function makes no new sync.
+- **The result is stable.** It is the same object until a snapshot value changes, and the methods never change.
+- **A method with no sync** (no grid yet, `enabled: false`): `applyUrl` and `applyFilters` report `NOT_READY` to `onIssue`, and so do `saveView` and `loadView` with a `storageKey`. `getUrl` returns the base URL. `deleteView` still works with storage only.
+- **Issues stay across a new sync.** After an option change or a `StrictMode` remount, `issues` still shows the latest apply's issues until the next apply. `onIssue` gets each issue one time.
+- `StrictMode`, React's `<Activity>` and server rendering are supported.
+
+### Migrating from `useAGGridUrlSync`
+
+| `useAGGridUrlSync`                                              | `useGridUrlSync`                                                                      |
+| --------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
+| `useAGGridUrlSync(gridApi, options)`                            | `useGridUrlSync({ api: gridApi, ...options })`                                        |
+| `paramPrefix`, `serialization`, `groupedParam`, `format`        | `codec: individual({ prefix })` or `grouped({ param, format })`                       |
+| `autoApplyOnMount` (default `false`)                            | `applyUrlOnCreate` (default `true`). A URL with no filters keeps the grid's filters   |
+| `enabledWhenReady`                                              | `enabled`                                                                             |
+| `onParseError`, `onError(error, context)`                       | `onIssue({ issue, source })`                                                          |
+| `isReady`                                                       | `status === 'active'`                                                                 |
+| `currentUrl`, `shareUrl(baseUrl?)`                              | `url`, `getUrl(baseUrl?)`                                                             |
+| `applyUrlFilters(url?)`, `clearFilters()`                       | `applyUrl(url?)`, `applyFilters({})`                                                  |
+| `getQueryParams()`                                              | `new URL(getUrl()).search`, while `status` is `'active'`                              |
+| `parseUrlFilters`, `getFiltersAsFormat`, `getSerializationMode` | The module functions `parseUrlFilters` and `serializeGrouped` from `ag-grid-url-sync` |
+
+### Basic React Usage (deprecated `useAGGridUrlSync`)
 
 ```tsx
 import React, { useState } from 'react'
@@ -619,7 +753,7 @@ function GridComponent() {
 }
 ```
 
-### React Hook API
+### React Hook API (deprecated `useAGGridUrlSync`)
 
 #### `useAGGridUrlSync(gridApi, options?)`
 
@@ -638,10 +772,35 @@ const {
   parseUrlFilters,
   applyFilters,
   getFiltersAsFormat,
-  getCurrentFormat
+  getSerializationMode
 } = useAGGridUrlSync(gridApi, options)
 ```
 
+The hook runs on [`createGridUrlSync`](#vanilla-js-creategridurlsync) and reads its state with `useSyncExternalStore`:
+
+- **Options can change after mount.** A change to `paramPrefix`, `maxValueLength`, `serialization`, `groupedParam`, `format`, `history` (the mode) or `popstate` makes a new sync. The grid keeps its filters, and `currentUrl` uses the new format. The URL is not applied again. A new options object with the same values, or a new callback, makes no new sync.
+- **The returned object is stable.** It is the same object across renders until a value in it changes.
+- **A grid-read issue goes to `onParseError` one time** while it stays. It is reported again only after it goes away and comes back.
+- **After AG Grid destroys the grid**, `isReady` is `false` and `currentUrl` is `''`, as with no grid. `applyUrlFilters`, `clearFilters`, `applyFilters`, `saveView` and `loadView` then report `NOT_READY` to `onError`. `shareUrl`, `getQueryParams` and `getFiltersAsFormat` return their fallback values.
+- **The hook writes to the address bar only with `history`.** With the default `'none'`, use `currentUrl` or `shareUrl()` to update it.
+
+#### Address bar (`history` and `popstate`)
+
+The hook takes the `history` and `popstate` options of [`createGridUrlSync`](#vanilla-js-creategridurlsync), so a React app gets the same address-bar sync with one option:
+
+```tsx
+// Each filter change adds a history entry, and back and forward apply the URL
+useAGGridUrlSync(gridApi, { autoApplyOnMount: true, history: 'push' })
+
+// Or give the URL to a router. A new function on each render is fine.
+useAGGridUrlSync(gridApi, { history: url => router.replace(url) })
+```
+
+- A user edit, `applyFilters`, `clearFilters` and `loadView` write the URL. `'push'` adds one entry for each of them.
+- A URL apply writes nothing, because the URL holds those filters already: auto-apply on mount, `applyUrlFilters` and the back button.
+- The restore of a stored view on mount replaces the entry. A new sync for an option change, or a `StrictMode` remount, adds no entry.
+- `popstate` is `true` by default with `'push'`. On back or forward, the hook applies the new URL. The view is then no longer active, and the issues of that apply are in `issues`. A grid error goes to `onError` with the context `'popstate'`. A failed address-bar write is `HISTORY_WRITE_FAILED`, to `onError` with the context `'filter-change'`.
+
 #### Hook Options
 
 ```tsx
@@ -652,6 +811,10 @@ interface UseAGGridUrlSyncOptions {
   onParseError?: (error: Error) => void
   throwOnError?: boolean | ((issue: URLSyncError) => boolean) // Default: false
 
+  // Address bar (see Address bar above)
+  history?: 'none' | 'replace' | 'push' | ((url: string) => void) // Default: 'none'
+  popstate?: boolean // Default: true with 'push', else false
+
   // React-specific options
   autoApplyOnMount?: boolean // Default: false
   enabledWhenReady?: boolean // Default: true
@@ -664,20 +827,21 @@ interface UseAGGridUrlSyncOptions {
 
 #### Hook Return Values
 
-| Property             | Type                                                      | Description                                                                 |
-| -------------------- | --------------------------------------------------------- | --------------------------------------------------------------------------- |
-| `shareUrl`           | `(baseUrl?: string) => string`                            | Generate shareable URL with current filters                                 |
-| `getQueryParams`     | `() => string`                                            | Get filter state as query parameters                                        |
-| `applyUrlFilters`    | `(url?: string) => void`                                  | Apply filters from URL to grid                                              |
-| `clearFilters`       | `() => void`                                              | Clear all text filters                                                      |
-| `isReady`            | `boolean`                                                 | Whether grid API is available and hook is ready                             |
-| `currentUrl`         | `string`                                                  | Current URL with filters applied                                            |
-| `hasFilters`         | `boolean`                                                 | Whether the grid has supported filters                                      |
-| `issues`             | `readonly URLSyncError[]`                                 | Filters that the latest URL apply or URL write dropped (see Error Handling) |
-| `parseUrlFilters`    | `(url: string) => FilterState`                            | Parse filters from URL without applying                                     |
-| `applyFilters`       | `(filters: FilterState) => void`                          | Apply filter state object to grid                                           |
-| `getFiltersAsFormat` | `(format: 'querystring' \| 'json' \| 'base64') => string` | Serialize filters to any supported format (for sharing/export)              |
-| `getCurrentFormat`   | `() => 'individual' \| 'grouped'`                         | Get the current serialization mode (individual or grouped)                  |
+| Property               | Type                                                      | Description                                                                                       |
+| ---------------------- | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
+| `shareUrl`             | `(baseUrl?: string) => string`                            | Generate shareable URL with current filters                                                       |
+| `getQueryParams`       | `() => string`                                            | Get filter state as query parameters                                                              |
+| `applyUrlFilters`      | `(url?: string) => void`                                  | Apply filters from URL to grid                                                                    |
+| `clearFilters`         | `() => void`                                              | Clear all text filters                                                                            |
+| `isReady`              | `boolean`                                                 | Whether the grid API is available and the hook is ready. `false` after AG Grid destroys the grid. |
+| `currentUrl`           | `string`                                                  | Current URL with filters applied                                                                  |
+| `hasFilters`           | `boolean`                                                 | Whether the grid has supported filters                                                            |
+| `issues`               | `readonly URLSyncError[]`                                 | Filters that the latest URL apply or URL write dropped (see Error Handling)                       |
+| `parseUrlFilters`      | `(url: string) => FilterState`                            | Parse filters from URL without applying                                                           |
+| `applyFilters`         | `(filters: FilterState) => void`                          | Apply filter state object to grid                                                                 |
+| `getFiltersAsFormat`   | `(format: 'querystring' \| 'json' \| 'base64') => string` | Serialize filters to any supported format (for sharing/export)                                    |
+| `getSerializationMode` | `() => 'individual' \| 'grouped'`                         | Get the current serialization mode (individual or grouped)                                        |
+| `getCurrentFormat`     | `() => 'individual' \| 'grouped'`                         | **Deprecated** (removed in 0.6.0): use `getSerializationMode`                                     |
 
 Saved views (inert unless `storageKey` is set):
 
@@ -689,10 +853,58 @@ Saved views (inert unless `storageKey` is set):
 | `loadView`     | `(id: string \| null) => void`       | Apply a saved view, or pass `null` to reset to unfiltered               |
 | `deleteView`   | `(id: string) => void`               | Delete a saved view                                                     |
 
-> **Note:** `getFiltersAsFormat` and `getCurrentFormat` are especially useful for grouped serialization, format conversion, and advanced sharing scenarios.
+> **Note:** `getFiltersAsFormat` and `getSerializationMode` are especially useful for grouped serialization, format conversion, and advanced sharing scenarios.
 
 ### Saved Views
 
+The views are part of `createGridUrlSync`. The React hook uses the same code, so a vanilla app and a React app get the same rules.
+
+#### Saved views in vanilla JS
+
+Give the `views` option a view store. `createViewStore` is in its own entry, so an app with no saved views does not get the storage code.
+
+```ts
+import { createGridUrlSync } from 'ag-grid-url-sync'
+import { createViewStore } from 'ag-grid-url-sync/view-storage'
+
+const sync = createGridUrlSync({
+  api: gridApi,
+  history: 'push',
+  views: createViewStore('orders')
+})
+
+const { views, activeViewId } = sync.getSnapshot()
+
+const view = sync.saveView('Open orders') // GridView, or null if the save failed
+sync.loadView(view.id)
+sync.loadView(null) // clear the filters
+sync.deleteView(view.id)
+```
+
+You can also give your own `ViewStore`, for example one that talks to a server. With no `views` option, `views` is `[]`, `activeViewId` is `null`, and the three methods do nothing.
+
+Rules for the vanilla API:
+
+- **`activeViewId` is tracked.** `saveView`, `loadView` and the restore of the stored view set it. A load sets it before the grid write, so a snapshot never shows `null` while the write is still pending.
+- **Any other filter model clears it.** A user edit, `applyUrl`, `applyFilters` and a back-button apply all set `activeViewId` to `null` and clear the stored pointer. A view that AG Grid changes when it applies it stays active.
+- **A hand edit does not make a view active.** If the user types the filters of a view, `activeViewId` stays `null`. When two views have the same model, the active one is the one the user loaded.
+- **A view load writes the URL as a user edit does.** With `history: 'push'`, the back button goes back to the URL from before the load. If the URL does not change, the sync writes no entry. Set and multi filters are kept in a view, but the URL cannot hold them. A view that differs only in those filters adds no entry.
+- **A URL apply writes no history.** This holds for `applyUrl`, the apply on create and the back button.
+- **A failed grid write restores `activeViewId`.** The failure goes to `onIssue` as `GRID_ERROR`.
+- **Deleting is conservative.** If the deleted view is active and the grid still shows it, the grid is cleared. If the user edited the filters, they stay.
+- **Failures go to `onIssue`**, not to `snapshot.issues`. They are `NOT_READY`, `GRID_ERROR`, `VIEW_NOT_FOUND`, `VIEW_NAME_REQUIRED`, `STORAGE_FULL`, `STORAGE_UNAVAILABLE` and `STORAGE_WRITE_FAILED`. `loadView` with an unknown id reads the store again, then reports `VIEW_NOT_FOUND`. After `destroy`, `saveView` and `loadView` report `NOT_READY`, and `deleteView` still deletes from the store.
+
+On create (when `applyUrlOnCreate` is not `false`), the sync picks the starting filters in this order:
+
+1. The URL holds the filters of the stored view (compared in URL form). The sync restores the view with its full model, and keeps `activeViewId` and the pointer. This is how a reload keeps a view that was loaded with `history` on.
+2. The URL has at least one filter. The URL wins. `activeViewId` is `null` and the pointer is cleared. A URL with only bad params does not win.
+3. A stored view exists. The sync restores it. With `history` on, the URL is written with replace, so page load adds no back-button step.
+4. Else, the grid keeps its filters.
+
+A stored pointer that names a missing view is ignored.
+
+#### Saved views in React
+
 Pass a `storageKey` to let users name and revisit filter sets. The key both enables
 the feature and namespaces its storage, so two grids on the same origin must use
 different keys:
@@ -757,7 +969,7 @@ Behaviour worth knowing:
   `onError` with context `'save-view'`. Reads degrade to an empty list instead of
   throwing, so server rendering is safe.
 
-For non-React consumers the same store is available directly:
+The store is also available directly:
 
 ```ts
 import { createViewStore } from 'ag-grid-url-sync/view-storage'
@@ -936,9 +1148,13 @@ Parameter structure:
 
 ## API Reference
 
-### `createUrlSync(gridApi, config?)`
+### `createGridUrlSync(options)`
 
-Factory function to create a new AGGridUrlSync instance.
+See [Vanilla JS: `createGridUrlSync`](#vanilla-js-creategridurlsync) for the options. It returns `{ getSnapshot, subscribe, applyUrl, applyFilters, getUrl, saveView, loadView, deleteView, destroy }`. The snapshot is `{ status, url, hasFilters, issues, views, activeViewId }`. See [Saved Views](#saved-views) for the view methods.
+
+### `createUrlSync(gridApi, config?)` (deprecated)
+
+Factory function to create a new AGGridUrlSync instance. Deprecated: use `createGridUrlSync`. It will be removed in 0.6.0.
 
 ```typescript
 import { createUrlSync } from 'ag-grid-url-sync'
@@ -950,7 +1166,9 @@ const urlSync = createUrlSync(gridApi, {
 })
 ```
 
-### `AGGridUrlSync` Class
+### `AGGridUrlSync` Class (deprecated)
+
+Deprecated: use `createGridUrlSync`. It will be removed in 0.6.0.
 
 #### Constructor
 

package/dist/core/ag-grid-url-sync.d.ts

@@ -2,6 +2,10 @@ import type { GridApi } from 'ag-grid-community';
 import type { AGGridUrlSyncConfig, FilterState, ApplyResult, SerializationFormat, SerializationMode, UrlState } from './types.js';
 /**
  * AGGridUrlSync class for synchronizing AG Grid text filters with URL parameters
+ *
+ * @deprecated Use `createGridUrlSync({ api })`: it also listens to the grid
+ * and can write the address bar (#221). `AGGridUrlSync` and `createUrlSync`
+ * will be removed in 0.6.0.
  */
 export declare class AGGridUrlSync {
     private readonly gridApi;
@@ -75,5 +79,7 @@ export declare class AGGridUrlSync {
  * @param gridApi - AG Grid API instance
  * @param config - Optional configuration options
  * @returns AGGridUrlSync instance
+ * @deprecated Use `createGridUrlSync({ api })` (#221). This function will be
+ * removed in 0.6.0.
  */
 export declare function createUrlSync(gridApi: GridApi, config?: AGGridUrlSyncConfig): AGGridUrlSync;

package/dist/core/ag-grid-url-sync.js.map

@@ -1 +1 @@
-{"version":3,"file":"ag-grid-url-sync.js","sourceRoot":"","sources":["../../src/core/ag-grid-url-sync.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAChD,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACxE,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAA;AAK7D,MAAM,OAAO,aAAa;IACP,OAAO,CAAS;IAChB,OAAO,CAAiB;IAOzC,YAAY,OAAgB,EAAE,MAAM,GAAwB,EAAE;QAC5D,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QAGtB,IAAI,CAAC,OAAO,GAAG,cAAc,CAAC,MAAM,CAAC,CAAA;IACvC,CAAC;IAOD,WAAW,CAAC,OAAgB;QAC1B,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,GAAG,CAAA;IACtC,CAAC;IAWD,WAAW,CAAC,OAAgB;QAC1B,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACvD,MAAM,WAAW,GAAG,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QACzD,MAAM,GAAG,GAAG,OAAO,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAA;QAE3C,OAAO;YACL,GAAG,EAAE,WAAW,CAAC,GAAG,EAAE,WAAW,EAAE,OAAO,CAAC;YAC3C,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,GAAG,CAAC;YAC/C,MAAM;SACP,CAAA;IACH,CAAC;IAMD,cAAc;QACZ,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,EAAE,CAAA;QAC9B,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAA;QAE3B,OAAO,MAAM,CAAC,MAAM,CAAA;IACtB,CAAC;IAOD,YAAY,CAAC,GAAY;QACvB,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACvD,MAAM,UAAU,GAAG,GAAG,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAA;QAC9C,MAAM,WAAW,GAAG,eAAe,CAAC,UAAU,EAAE,OAAO,CAAC,CAAA;QAIxD,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,CAAA;QAE9C,OAAO,EAAE,MAAM,EAAE,CAAC,GAAG,MAAM,EAAE,GAAG,CAAC,OAAO,EAAE,MAAM,IAAI,EAAE,CAAC,CAAC,EAAE,CAAA;IAC5D,CAAC;IAOD,YAAY,CAAC,WAAwB;QACnC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACvD,gBAAgB,CAAC,WAAW,EAAE,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QAEpD,OAAO,EAAE,MAAM,EAAE,CAAA;IACnB,CAAC;IAMD,YAAY;QACV,OAAO,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAA;IAC9B,CAAC;IAKD,OAAO;IAEP,CAAC;IAMD,oBAAoB;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAA;IACnC,CAAC;IAMD,gBAAgB;QACd,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAA;IAC5B,CAAC;IAKD,kBAAkB,CAAC,MAA2B;QAC5C,MAAM,WAAW,GAAG,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;QAG9D,MAAM,UAAU,GAAG;YACjB,GAAG,IAAI,CAAC,OAAO;YACf,MAAM;YACN,aAAa,EAAE,SAAkB;SAClC,CAAA;QAGD,MAAM,MAAM,GAAG,gBAAgB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAA;QAExD,OAAO,MAAM,CAAC,KAAK,CAAA;IACrB,CAAC;CACF;AAQD,MAAM,UAAU,aAAa,CAC3B,OAAgB,EAChB,MAA4B;IAE5B,OAAO,IAAI,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;AAC3C,CAAC"}
+{"version":3,"file":"ag-grid-url-sync.js","sourceRoot":"","sources":["../../src/core/ag-grid-url-sync.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAChD,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACxE,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAA;AAS7D,MAAM,OAAO,aAAa;IACP,OAAO,CAAS;IAChB,OAAO,CAAiB;IAOzC,YAAY,OAAgB,EAAE,MAAM,GAAwB,EAAE;QAC5D,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QAGtB,IAAI,CAAC,OAAO,GAAG,cAAc,CAAC,MAAM,CAAC,CAAA;IACvC,CAAC;IAOD,WAAW,CAAC,OAAgB;QAC1B,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,GAAG,CAAA;IACtC,CAAC;IAWD,WAAW,CAAC,OAAgB;QAC1B,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACvD,MAAM,WAAW,GAAG,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QACzD,MAAM,GAAG,GAAG,OAAO,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAA;QAE3C,OAAO;YACL,GAAG,EAAE,WAAW,CAAC,GAAG,EAAE,WAAW,EAAE,OAAO,CAAC;YAC3C,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,GAAG,CAAC;YAC/C,MAAM;SACP,CAAA;IACH,CAAC;IAMD,cAAc;QACZ,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,EAAE,CAAA;QAC9B,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAA;QAE3B,OAAO,MAAM,CAAC,MAAM,CAAA;IACtB,CAAC;IAOD,YAAY,CAAC,GAAY;QACvB,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACvD,MAAM,UAAU,GAAG,GAAG,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAA;QAC9C,MAAM,WAAW,GAAG,eAAe,CAAC,UAAU,EAAE,OAAO,CAAC,CAAA;QAIxD,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,CAAA;QAE9C,OAAO,EAAE,MAAM,EAAE,CAAC,GAAG,MAAM,EAAE,GAAG,CAAC,OAAO,EAAE,MAAM,IAAI,EAAE,CAAC,CAAC,EAAE,CAAA;IAC5D,CAAC;IAOD,YAAY,CAAC,WAAwB;QACnC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACvD,gBAAgB,CAAC,WAAW,EAAE,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QAEpD,OAAO,EAAE,MAAM,EAAE,CAAA;IACnB,CAAC;IAMD,YAAY;QACV,OAAO,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAA;IAC9B,CAAC;IAKD,OAAO;IAEP,CAAC;IAMD,oBAAoB;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAA;IACnC,CAAC;IAMD,gBAAgB;QACd,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAA;IAC5B,CAAC;IAKD,kBAAkB,CAAC,MAA2B;QAC5C,MAAM,WAAW,GAAG,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;QAG9D,MAAM,UAAU,GAAG;YACjB,GAAG,IAAI,CAAC,OAAO;YACf,MAAM;YACN,aAAa,EAAE,SAAkB;SAClC,CAAA;QAGD,MAAM,MAAM,GAAG,gBAAgB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAA;QAExD,OAAO,MAAM,CAAC,KAAK,CAAA;IACrB,CAAC;CACF;AAUD,MAAM,UAAU,aAAa,CAC3B,OAAgB,EAChB,MAA4B;IAE5B,OAAO,IAAI,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;AAC3C,CAAC"}

package/dist/core/codecs.d.ts

@@ -0,0 +1,28 @@
+import type { Codec, ResolvedOptions, SerializationFormat } from './types.js';
+/** The options that a codec sets */
+export type CodecOptions = Pick<ResolvedOptions, 'serialization' | 'paramPrefix' | 'groupedParam' | 'format'>;
+/**
+ * One URL param for each filter, for example `?f_name_contains=jo`
+ * @param options.prefix - The start of each param name. Default `'f_'`.
+ */
+export declare function individual(options?: {
+    prefix?: string | undefined;
+}): Codec;
+/**
+ * All the filters in one URL param
+ * @param options.param - The param name. Default `'grid_filters'`.
+ * @param options.format - `'querystring'` (default), `'json'` or `'base64'`
+ */
+export declare function grouped(options?: {
+    param?: string | undefined;
+    format?: SerializationFormat | undefined;
+}): Codec;
+/** The options of a codec. Throws for an object that no factory made. */
+export declare function codecOptions(codec: Codec): CodecOptions;
+/**
+ * A codec with all four settings, for the React hook (#222). Internal: the
+ * hook's old options name the params of both modes, and the URL must strip
+ * the names that the app set, as the class does. Not exported from the
+ * package.
+ */
+export declare function codecFromOptions(options: CodecOptions): Codec;

package/dist/core/codecs.js

@@ -0,0 +1,39 @@
+import { DEFAULT_CONFIG } from './options.js';
+const settings = new WeakMap();
+function makeCodec(options) {
+    const codec = Object.freeze({});
+    settings.set(codec, options);
+    return codec;
+}
+export function individual(options = {}) {
+    return makeCodec({
+        serialization: 'individual',
+        paramPrefix: options.prefix ?? DEFAULT_CONFIG.paramPrefix,
+        groupedParam: DEFAULT_CONFIG.groupedParam,
+        format: DEFAULT_CONFIG.format
+    });
+}
+export function grouped(options = {}) {
+    return makeCodec({
+        serialization: 'grouped',
+        paramPrefix: DEFAULT_CONFIG.paramPrefix,
+        groupedParam: options.param ?? DEFAULT_CONFIG.groupedParam,
+        format: options.format ?? DEFAULT_CONFIG.format
+    });
+}
+export function codecOptions(codec) {
+    const options = settings.get(codec);
+    if (!options) {
+        throw new TypeError('codec must come from individual() or grouped()');
+    }
+    return options;
+}
+export function codecFromOptions(options) {
+    return makeCodec({
+        serialization: options.serialization,
+        paramPrefix: options.paramPrefix,
+        groupedParam: options.groupedParam,
+        format: options.format
+    });
+}
+//# sourceMappingURL=codecs.js.map

package/dist/core/codecs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"codecs.js","sourceRoot":"","sources":["../../src/core/codecs.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAY7C,MAAM,QAAQ,GAAG,IAAI,OAAO,EAAuB,CAAA;AAEnD,SAAS,SAAS,CAAC,OAAqB;IAGtC,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,CAAU,CAAA;IACxC,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;IAE5B,OAAO,KAAK,CAAA;AACd,CAAC;AAMD,MAAM,UAAU,UAAU,CACxB,OAAO,GAAoC,EAAE;IAE7C,OAAO,SAAS,CAAC;QACf,aAAa,EAAE,YAAY;QAC3B,WAAW,EAAE,OAAO,CAAC,MAAM,IAAI,cAAc,CAAC,WAAW;QACzD,YAAY,EAAE,cAAc,CAAC,YAAY;QACzC,MAAM,EAAE,cAAc,CAAC,MAAM;KAC9B,CAAC,CAAA;AACJ,CAAC;AAOD,MAAM,UAAU,OAAO,CACrB,OAAO,GAGH,EAAE;IAEN,OAAO,SAAS,CAAC;QACf,aAAa,EAAE,SAAS;QACxB,WAAW,EAAE,cAAc,CAAC,WAAW;QACvC,YAAY,EAAE,OAAO,CAAC,KAAK,IAAI,cAAc,CAAC,YAAY;QAC1D,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,cAAc,CAAC,MAAM;KAChD,CAAC,CAAA;AACJ,CAAC;AAGD,MAAM,UAAU,YAAY,CAAC,KAAY;IACvC,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;IAEnC,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,SAAS,CAAC,gDAAgD,CAAC,CAAA;IACvE,CAAC;IAED,OAAO,OAAO,CAAA;AAChB,CAAC;AAQD,MAAM,UAAU,gBAAgB,CAAC,OAAqB;IACpD,OAAO,SAAS,CAAC;QACf,aAAa,EAAE,OAAO,CAAC,aAAa;QACpC,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,YAAY,EAAE,OAAO,CAAC,YAAY;QAClC,MAAM,EAAE,OAAO,CAAC,MAAM;KACvB,CAAC,CAAA;AACJ,CAAC"}

package/dist/core/data-issue-codes.d.ts

@@ -0,0 +1,3 @@
+import type { IssueCode } from './types.js';
+/** The codes for a filter that is dropped or not valid */
+export declare const DATA_ISSUE_CODES: ReadonlySet<IssueCode>;

package/dist/core/data-issue-codes.js

@@ -0,0 +1,10 @@
+export const DATA_ISSUE_CODES = new Set([
+    'INVALID_PARAM',
+    'INVALID_NUMBER',
+    'INVALID_DATE',
+    'VALUE_TOO_LONG',
+    'INVALID_GROUPED',
+    'TYPE_MISMATCH',
+    'INVALID_URL'
+]);
+//# sourceMappingURL=data-issue-codes.js.map

package/dist/core/data-issue-codes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-issue-codes.js","sourceRoot":"","sources":["../../src/core/data-issue-codes.ts"],"names":[],"mappings":"AAMA,MAAM,CAAC,MAAM,gBAAgB,GAA2B,IAAI,GAAG,CAAY;IACzE,eAAe;IACf,gBAAgB;IAChB,cAAc;IACd,gBAAgB;IAChB,iBAAiB;IACjB,eAAe;IACf,aAAa;CACd,CAAC,CAAA"}

package/dist/core/grid-integration.d.ts

@@ -1,5 +1,5 @@
 import type { AGGridUrlSyncConfig, FilterState, InternalConfig } from './types.js';
-import type { GridApi } from 'ag-grid-community';
+import type { FilterModel, GridApi } from 'ag-grid-community';
 /**
  * Detects the expected filter type for a column based on AG Grid configuration
  */
@@ -20,6 +20,11 @@ export declare function getFilterModel(gridApi: GridApi, options?: AGGridUrlSync
  * `getFilterModel(gridApi, options)`. This form will be removed in 0.6.0.
  */
 export declare function getFilterModel(config: InternalConfig): FilterState;
+/**
+ * Converts an AG Grid filter model to URL filters. It does not call the grid.
+ * Filter types that the library does not support (set, multi) are skipped.
+ */
+export declare function fromGridModel(model: FilterModel | null | undefined, options?: AGGridUrlSyncConfig): FilterState;
 /**
  * Applies a filter state to AG Grid. A filter whose type does not match the
  * column is skipped with a warning. An error from the grid is reported
@@ -38,3 +43,8 @@ export declare function applyFilterModel(filterState: FilterState, gridApi: Grid
  * removed in 0.6.0.
  */
 export declare function applyFilterModel(filterState: FilterState, config: InternalConfig): void;
+/**
+ * Converts URL filters to the AG Grid filter model that `applyFilterModel`
+ * would write. It does not call `setFilterModel`.
+ */
+export declare function toGridModel(filterState: FilterState, gridApi: GridApi, options?: AGGridUrlSyncConfig): FilterModel;

package/dist/core/grid-integration.js

@@ -67,6 +67,10 @@ function readGridFilters(gridApi, options) {
         reportIssue(options, toIssue(error, 'GRID_ERROR'));
         return {};
     }
+    return fromGridModel(model, options);
+}
+export function fromGridModel(model, options) {
+    const resolved = resolveOptions(options);
     const filters = new Map();
     if (!v.is(JsonObjectSchema, model)) {
         return {};
@@ -92,7 +96,7 @@ function readGridFilters(gridApi, options) {
             if (!operator ||
                 !internalOperation ||
                 !isNumberFilterOperation(internalOperation)) {
-                reportIssue(options, new InvalidFilterError(`Unknown number filter operation '${filter.type}' for column '${column}'. ` +
+                reportIssue(resolved, new InvalidFilterError(`Unknown number filter operation '${filter.type}' for column '${column}'. ` +
                     `Supported operations: ${NUMBER_FILTER_OPERATIONS.map(toAgGridOperation).join(', ')}`, undefined, { code: 'INVALID_PARAM', column }));
                 continue;
             }
@@ -113,11 +117,11 @@ function readGridFilters(gridApi, options) {
                 ? gridNumber(filter.filterTo, column)
                 : undefined;
             if (numericValue instanceof InvalidFilterError) {
-                reportIssue(options, numericValue);
+                reportIssue(resolved, numericValue);
                 continue;
             }
             if (numericTo instanceof InvalidFilterError) {
-                reportIssue(options, numericTo);
+                reportIssue(resolved, numericTo);
                 continue;
             }
             if (isNaN(numericValue)) {
@@ -230,17 +234,27 @@ export function applyFilterModel(filterState, target, options) {
     writeGridFilters(filterState, target, resolveOptions(options));
 }
 function writeGridFilters(filterState, gridApi, options) {
+    const model = toGridModel(filterState, gridApi, options);
+    try {
+        gridApi.setFilterModel(model);
+    }
+    catch (error) {
+        reportIssue(options, toIssue(error, 'GRID_ERROR'));
+    }
+}
+export function toGridModel(filterState, gridApi, options) {
+    const resolved = resolveOptions(options);
     const model = new Map();
     for (const [column, filter] of Object.entries(filterState)) {
         if (!v.is(JsonObjectSchema, filter))
             continue;
         const expectedType = detectColumnFilterType(gridApi, column);
         if (filter.filterType === 'date' && expectedType !== 'date') {
-            reportIssue(options, new InvalidFilterError(`Column '${column}' expects a ${expectedType} filter but received a date filter. This may indicate a configuration mismatch in the column definition or filter application.`, undefined, { code: 'TYPE_MISMATCH', column }));
+            reportIssue(resolved, new InvalidFilterError(`Column '${column}' expects a ${expectedType} filter but received a date filter. This may indicate a configuration mismatch in the column definition or filter application.`, undefined, { code: 'TYPE_MISMATCH', column }));
             continue;
         }
         if (filter.filterType === 'number' && expectedType !== 'number') {
-            reportIssue(options, new InvalidFilterError(`Column '${column}' expects a ${expectedType} filter but received a number filter. This may indicate a configuration mismatch in the column definition or filter application.`, undefined, { code: 'TYPE_MISMATCH', column }));
+            reportIssue(resolved, new InvalidFilterError(`Column '${column}' expects a ${expectedType} filter but received a number filter. This may indicate a configuration mismatch in the column definition or filter application.`, undefined, { code: 'TYPE_MISMATCH', column }));
             continue;
         }
         const agGridFilter = convertToAGGridFilter(filter);
@@ -248,11 +262,6 @@ function writeGridFilters(filterState, gridApi, options) {
             model.set(column, agGridFilter);
         }
     }
-    try {
-        gridApi.setFilterModel(Object.fromEntries(model));
-    }
-    catch (error) {
-        reportIssue(options, toIssue(error, 'GRID_ERROR'));
-    }
+    return Object.fromEntries(model);
 }
 //# sourceMappingURL=grid-integration.js.map