ag-grid-url-sync 0.4.1 → 0.5.1

package/dist/core/types.d.ts

@@ -1,4 +1,5 @@
 import type { GridApi as AGGridApi, TextFilterModel, NumberFilterModel, DateFilterModel } from 'ag-grid-community';
+import { type Operator, type OperationsFor } from './operators.js';
 /**
  * Serialization modes for URL parameters
  */
@@ -29,64 +30,124 @@ export type SerializationFormat = 'querystring' | 'json' | 'base64';
  */
 export interface AGGridUrlSyncConfig {
     /**
-     * Prefix for URL parameters (only used in individual mode)
+     * Prefix for URL parameters (only used in individual mode).
+     * A prefix without a trailing `_` gets one, so 'filter' and 'filter_' both
+     * give `?filter_name_contains=john`. An empty prefix means the default.
      * @default 'f_'
      * @example 'filter_' results in URLs like '?filter_name_contains=john'
      */
-    paramPrefix?: string;
+    paramPrefix?: string | undefined;
     /**
      * Maximum length for filter values to prevent URL length issues
      * @default 200
      */
-    maxValueLength?: number;
+    maxValueLength?: number | undefined;
     /**
-     * Optional error handler for parsing errors.
-     * Allows graceful error handling without breaking the application.
+     * Optional handler for issues: a filter that is dropped or not valid, in a
+     * URL, a value, or the grid model. The filter is skipped and the others are
+     * kept. Each error is a `URLSyncError` with a `code` (for example
+     * `VALUE_TOO_LONG`) and, when it is known, a `column`. In the core, an error
+     * from the grid API also comes here, as `GRID_ERROR` (the React hook sends it
+     * to `onError`). A URL that cannot be read is thrown as `INVALID_URL`, not
+     * sent here. The library never writes to the console, so an issue with no
+     * handler is silent (#220).
+     *
+     * In grouped mode, an error that comes from the grouped URL value is an
+     * `InvalidSerializationError`, and the original error is in `error.cause`.
+     * The wrapper has the code and the column of the original issue, so a check
+     * on `error.code` works the same in both modes.
      */
-    onParseError?: (error: Error) => void;
+    onParseError?: ((error: Error) => void) | undefined;
     /**
      * Serialization mode for URL parameters
      * @default 'individual'
      */
-    serialization?: SerializationMode;
+    serialization?: SerializationMode | undefined;
     /**
      * Parameter name for grouped serialization
      * @default 'grid_filters'
      */
-    groupedParam?: string;
+    groupedParam?: string | undefined;
     /**
      * Serialization format for grouped mode
      * @default 'querystring'
      */
-    format?: SerializationFormat;
+    format?: SerializationFormat | undefined;
+    /**
+     * Throw an issue instead of reporting it (#229), like TanStack Query's
+     * `throwOnError`. `true` throws every issue, and a function throws the
+     * issues for which it gives `true`. In the core, a thrown issue is not sent
+     * to `onParseError`, and the first one stops the call. In the React hook,
+     * each issue is still sent to `onParseError` one time, and the picked issue
+     * is thrown during render, so an error boundary catches it. The library does
+     * not change the address bar, so remove the bad param before the boundary
+     * resets, or the same issue is thrown again.
+     *
+     * A function that throws makes the library throw that error.
+     * @default false
+     */
+    throwOnError?: boolean | ((issue: URLSyncError) => boolean) | undefined;
+}
+/**
+ * The options with a value for each one: the config after the defaults are
+ * filled in. It has no `gridApi`: the grid is an argument of the functions
+ * that read it (#219).
+ *
+ * A caller can set an option to undefined (#258), so `Required` is not enough:
+ * it keeps the undefined.
+ */
+export type ResolvedOptions = {
+    [K in Exclude<keyof AGGridUrlSyncConfig, 'throwOnError'>]-?: Exclude<AGGridUrlSyncConfig[K], undefined>;
+} & {
+    /**
+     * Optional, so that ParseConfig and InternalConfig, which extend this type,
+     * get no new required key (#229). resolveOptions always sets it.
+     */
+    throwOnError?: Exclude<AGGridUrlSyncConfig['throwOnError'], undefined>;
+};
+/**
+ * Configuration for URL parsing and serialization operations that don't require GridApi.
+ *
+ * @deprecated The parse and serialize functions take a partial
+ * `AGGridUrlSyncConfig` and fill in the defaults, so you do not need this
+ * type. Use `ResolvedOptions` for a config with every option set. This type
+ * will be removed in 0.6.0.
+ */
+export interface ParseConfig extends ResolvedOptions {
+    /** AG Grid API instance - not read by parsing/serialization operations */
+    gridApi?: AGGridApi | null;
 }
 /**
  * Internal configuration with all required fields and runtime dependencies
+ *
+ * @deprecated Give the grid API to `getFilterModel(gridApi, options)` and
+ * `applyFilterModel(filterState, gridApi, options)` as an argument. This type
+ * will be removed in 0.6.0.
  */
-export interface InternalConfig extends Required<AGGridUrlSyncConfig> {
+export interface InternalConfig extends ParseConfig {
     /** AG Grid API instance for filter operations */
     gridApi: AGGridApi;
 }
 /**
  * Text-only filter operations for string-based filtering
  */
-export declare const TEXT_ONLY_OPERATIONS: readonly ['contains', 'notContains', 'startsWith', 'endsWith'];
+export declare const TEXT_ONLY_OPERATIONS: readonly ["contains", "notContains", "startsWith", "endsWith"];
 /**
  * Number-only filter operations for numeric comparisons
  */
-export declare const NUMBER_ONLY_OPERATIONS: readonly ['lessThan', 'lessThanOrEqual', 'greaterThan', 'greaterThanOrEqual', 'inRange'];
+export declare const NUMBER_ONLY_OPERATIONS: readonly ["lessThan", "lessThanOrEqual", "greaterThan", "greaterThanOrEqual", "inRange"];
 /**
  * Date-specific filter operations for temporal comparisons
  */
-export declare const DATE_ONLY_OPERATIONS: readonly ['dateBefore', 'dateBeforeOrEqual', 'dateAfter', 'dateAfterOrEqual', 'dateRange'];
+export declare const DATE_ONLY_OPERATIONS: readonly ["dateBefore", "dateBeforeOrEqual", "dateAfter", "dateAfterOrEqual", "dateRange"];
 /**
  * Operations shared across multiple filter types
  */
-export declare const SHARED_OPERATIONS: readonly ['eq', 'notEqual', 'blank', 'notBlank'];
+export declare const SHARED_OPERATIONS: readonly ["eq", "notEqual", "blank", "notBlank"];
 /**
  * All supported filter operations across text, number, and date filters
  */
-export type FilterOperation = (typeof TEXT_ONLY_OPERATIONS)[number] | (typeof NUMBER_ONLY_OPERATIONS)[number] | (typeof DATE_ONLY_OPERATIONS)[number] | (typeof SHARED_OPERATIONS)[number];
+export type FilterOperation = Operator['id'];
 /**
  * Complete list of valid text filter operations
  */
@@ -96,29 +157,33 @@ export declare const TEXT_FILTER_OPERATIONS: readonly ["contains", "notContains"
  */
 export declare const NUMBER_FILTER_OPERATIONS: readonly ["lessThan", "lessThanOrEqual", "greaterThan", "greaterThanOrEqual", "inRange", "eq", "notEqual", "blank", "notBlank"];
 /**
- * Valid date filter operations as const array
+ * Valid date filter operations
  */
 export declare const DATE_FILTER_OPERATIONS: readonly ["dateBefore", "dateBeforeOrEqual", "dateAfter", "dateAfterOrEqual", "dateRange", "eq", "notEqual", "blank", "notBlank"];
 /**
  * Text-specific filter operations
  */
-export type TextFilterOperation = (typeof TEXT_FILTER_OPERATIONS)[number];
+export type TextFilterOperation = OperationsFor<'text'>;
 /**
  * Number-specific filter operations
  */
-export type NumberFilterOperation = (typeof NUMBER_FILTER_OPERATIONS)[number];
+export type NumberFilterOperation = OperationsFor<'number'>;
 /**
  * Date-specific filter operations
  */
-export type DateFilterOperation = (typeof DATE_FILTER_OPERATIONS)[number];
+export type DateFilterOperation = OperationsFor<'date'>;
 /**
  * Range operations that require two values (from/to)
  */
-export type RangeOperation = 'inRange' | 'dateRange';
+export type RangeOperation = Extract<Operator, {
+    arity: 2;
+}>['id'];
 /**
  * Operations that don't require a filter value
  */
-export type BlankOperation = 'blank' | 'notBlank';
+export type BlankOperation = Extract<Operator, {
+    arity: 0;
+}>['id'];
 /**
  * Supported filter types
  */
@@ -201,35 +266,56 @@ export declare function isNumberFilter(filter: ColumnFilter): filter is NumberCo
  * Type guard to check if a filter is a date filter
  */
 export declare function isDateFilter(filter: ColumnFilter): filter is DateColumnFilter;
+/**
+ * The reason for an issue (#220). Data issues are a filter that is dropped or
+ * not valid. The other codes are failures of an operation.
+ */
+export type IssueCode = 'INVALID_PARAM' | 'INVALID_NUMBER' | 'INVALID_DATE' | 'VALUE_TOO_LONG' | 'INVALID_GROUPED' | 'TYPE_MISMATCH' | 'INVALID_URL' | 'GRID_ERROR' | 'NOT_READY' | 'VIEW_NOT_FOUND' | 'VIEW_NAME_REQUIRED' | 'STORAGE_UNAVAILABLE' | 'STORAGE_FULL' | 'STORAGE_WRITE_FAILED' | 'UNKNOWN';
+/** The code and the column of an issue, when the default is not right */
+export interface IssueDetails {
+    code?: IssueCode | undefined;
+    column?: string | undefined;
+}
 /**
  * Base error class for all URL sync operations
  */
 export declare class URLSyncError extends Error {
     readonly cause?: Error | undefined;
-    constructor(message: string, cause?: Error | undefined);
+    /** The reason for the error */
+    readonly code: IssueCode;
+    /** The column of the filter, when it is known */
+    readonly column?: string;
+    constructor(message: string, cause?: Error | undefined, details?: IssueDetails);
 }
 /**
  * Error thrown when filter validation fails
  */
 export declare class InvalidFilterError extends URLSyncError {
-    constructor(message: string, cause?: Error);
+    constructor(message: string, cause?: Error, details?: IssueDetails);
 }
 /**
  * Error thrown when URL parsing fails
  */
 export declare class InvalidURLError extends URLSyncError {
-    constructor(message: string, cause?: Error);
+    constructor(message: string, cause?: Error, details?: IssueDetails);
 }
 /**
  * Error thrown when date validation fails
  */
 export declare class InvalidDateError extends InvalidFilterError {
-    constructor(message: string, cause?: Error);
+    constructor(message: string, cause?: Error, details?: IssueDetails);
 }
 /**
- * Error thrown when serialization/deserialization fails
- */
-export declare class InvalidSerializationError extends Error {
+ * Error thrown when serialization/deserialization fails.
+ *
+ * When the cause is an issue inside the grouped value (for example a value
+ * over maxValueLength), this error has the same code and column, so a filter
+ * gives the same code in both modes. `INVALID_GROUPED` means that the grouped
+ * value itself does not decode.
+ */
+export declare class InvalidSerializationError extends URLSyncError {
+    /** The grouped format: querystring, json or base64 */
+    readonly format: string;
     constructor(format: string, cause: Error);
 }
 /**
@@ -263,6 +349,28 @@ export interface RawAGGridFilter {
     dateFrom?: string;
     dateTo?: string;
 }
+/**
+ * The URL with the current filter state, and whether the grid has filters
+ */
+export interface UrlState {
+    /** The URL with the current filter state and the page's own params */
+    url: string;
+    /** Whether the grid has filters that the library supports */
+    hasFilters: boolean;
+    /**
+     * The issues of this call (#229): filters that the grid read or the URL
+     * leaves out. The same objects also go to `onParseError`.
+     */
+    issues: readonly URLSyncError[];
+}
+/** The result of an apply method (#229) */
+export interface ApplyResult {
+    /**
+     * The issues of this call: filters that were dropped. The same objects
+     * also go to `onParseError`.
+     */
+    issues: readonly URLSyncError[];
+}
 /**
  * Grouped serialization result
  */
@@ -276,10 +384,20 @@ export interface GroupedSerializationResult {
  * Format-specific serializer interface
  */
 export interface FormatSerializer {
-    /** Serialize filter state to string */
-    serialize(filterState: FilterState): string;
-    /** Deserialize string to filter state */
-    deserialize(value: string): FilterState;
+    /**
+     * Serialize filter state to string
+     * @param config - Caller's configuration. All serializers honour
+     * maxValueLength and onParseError. JSON and Base64 drop over-length text
+     * values and report them through onParseError (see #213, #207).
+     */
+    serialize(filterState: FilterState, config?: ResolvedOptions): string;
+    /**
+     * Deserialize string to filter state
+     * @param config - Caller's configuration. All serializers honour
+     * maxValueLength and onParseError. JSON and Base64 drop over-length text
+     * values and report them through onParseError (see #213, #207).
+     */
+    deserialize(value: string, config?: ResolvedOptions): FilterState;
     /** Format identifier */
     format: SerializationFormat;
 }
@@ -296,20 +414,41 @@ export interface GroupedDetectionResult {
     /** The raw value if grouped */
     value?: string;
 }
+/**
+ * Operation Mapping Strategy:
+ *
+ * We use three different naming conventions for better user experience:
+ *
+ * 1. URL Parameters: Short, clean names for URLs (e.g., 'eq', 'neq', 'before', 'after')
+ * 2. Internal Types: Consistent naming for our FilterOperation type
+ * 3. AG Grid Operations: Exact names expected by AG Grid API (e.g., 'equals', 'notEqual', 'lessThan')
+ *
+ * The operator table in `operators.ts` holds all three names for each
+ * operation (#217). The maps below are derived from it and kept only for
+ * callers that use them.
+ */
 /**
  * Maps URL operation names to internal operation types
+ * @deprecated Derived from the operator table. Will be removed in 0.6.0.
  */
 export declare const OPERATION_MAP: Record<string, FilterOperation>;
 /**
  * Maps internal operation types to URL operation names
+ * @deprecated Derived from the operator table. Will be removed in 0.6.0.
  */
 export declare const INTERNAL_TO_URL_OPERATION_MAP: Record<FilterOperation, string>;
 /**
  * Maps internal operation types to AG Grid operation names
+ * @deprecated Derived from the operator table. Will be removed in 0.6.0.
  */
 export declare const AG_GRID_OPERATION_NAMES: Record<string, string>;
 /**
- * Maps AG Grid operation names to internal operation types
+ * Maps AG Grid operation names to internal operation types.
+ *
+ * AG Grid uses one name for a number and a date operation, so this map is
+ * wrong for one of them: `lessThan` gives `dateBefore`. The last row in the
+ * operator table wins, as before.
+ * @deprecated The key needs the filter type too. Will be removed in 0.6.0.
  */
 export declare const REVERSE_AG_GRID_OPERATION_NAMES: Record<string, FilterOperation>;
 export {};

package/dist/core/types.js

@@ -1,55 +1,26 @@
-export const TEXT_ONLY_OPERATIONS = [
-    'contains',
-    'notContains',
-    'startsWith',
-    'endsWith'
-];
-export const NUMBER_ONLY_OPERATIONS = [
-    'lessThan',
-    'lessThanOrEqual',
-    'greaterThan',
-    'greaterThanOrEqual',
-    'inRange'
-];
-export const DATE_ONLY_OPERATIONS = [
-    'dateBefore',
-    'dateBeforeOrEqual',
-    'dateAfter',
-    'dateAfterOrEqual',
-    'dateRange'
-];
-export const SHARED_OPERATIONS = [
-    'eq',
-    'notEqual',
-    'blank',
-    'notBlank'
-];
-export const TEXT_FILTER_OPERATIONS = [
-    ...TEXT_ONLY_OPERATIONS,
-    ...SHARED_OPERATIONS
-];
-export const NUMBER_FILTER_OPERATIONS = [
-    ...NUMBER_ONLY_OPERATIONS,
-    ...SHARED_OPERATIONS
-];
-export const DATE_FILTER_OPERATIONS = [
-    ...DATE_ONLY_OPERATIONS,
-    ...SHARED_OPERATIONS
-];
+import { attachColumn } from './issue-columns.js';
+import { OPERATORS, operationsFor, operationsOnlyFor, sharedOperations, isOperationFor, operatorById } from './operators.js';
+export const TEXT_ONLY_OPERATIONS = operationsOnlyFor('text');
+export const NUMBER_ONLY_OPERATIONS = operationsOnlyFor('number');
+export const DATE_ONLY_OPERATIONS = operationsOnlyFor('date');
+export const SHARED_OPERATIONS = sharedOperations();
+export const TEXT_FILTER_OPERATIONS = operationsFor('text');
+export const NUMBER_FILTER_OPERATIONS = operationsFor('number');
+export const DATE_FILTER_OPERATIONS = operationsFor('date');
 export function isTextFilterOperation(op) {
-    return TEXT_FILTER_OPERATIONS.includes(op);
+    return isOperationFor(op, 'text');
 }
 export function isNumberFilterOperation(op) {
-    return NUMBER_FILTER_OPERATIONS.includes(op);
+    return isOperationFor(op, 'number');
 }
 export function isDateFilterOperation(op) {
-    return DATE_FILTER_OPERATIONS.includes(op);
+    return isOperationFor(op, 'date');
 }
 export function isRangeOperation(op) {
-    return op === 'inRange' || op === 'dateRange';
+    return operatorById(op)?.arity === 2;
 }
 export function isBlankOperation(op) {
-    return op === 'blank' || op === 'notBlank';
+    return operatorById(op)?.arity === 0;
 }
 export function isTextFilter(filter) {
     return filter.filterType === 'text';
@@ -62,90 +33,46 @@ export function isDateFilter(filter) {
 }
 export class URLSyncError extends Error {
     cause;
-    constructor(message, cause) {
+    code;
+    constructor(message, cause, details = {}) {
         super(message);
         this.cause = cause;
         this.name = 'URLSyncError';
+        this.code = details.code ?? 'UNKNOWN';
+        if (details.column !== undefined)
+            attachColumn(this, details.column);
     }
 }
 export class InvalidFilterError extends URLSyncError {
-    constructor(message, cause) {
-        super(message, cause);
+    constructor(message, cause, details = {}) {
+        super(message, cause, { ...details, code: details.code ?? 'INVALID_PARAM' });
         this.name = 'InvalidFilterError';
     }
 }
 export class InvalidURLError extends URLSyncError {
-    constructor(message, cause) {
-        super(message, cause);
+    constructor(message, cause, details = {}) {
+        super(message, cause, { ...details, code: details.code ?? 'INVALID_URL' });
         this.name = 'InvalidURLError';
     }
 }
 export class InvalidDateError extends InvalidFilterError {
-    constructor(message, cause) {
-        super(message, cause);
+    constructor(message, cause, details = {}) {
+        super(message, cause, { ...details, code: details.code ?? 'INVALID_DATE' });
         this.name = 'InvalidDateError';
     }
 }
-export class InvalidSerializationError extends Error {
+export class InvalidSerializationError extends URLSyncError {
+    format;
     constructor(format, cause) {
-        super(`Invalid ${format} serialization: ${cause.message}`);
+        super(`Invalid ${format} serialization: ${cause.message}`, cause, cause instanceof URLSyncError
+            ? { code: cause.code, column: cause.column }
+            : { code: 'INVALID_GROUPED' });
         this.name = 'InvalidSerializationError';
-        this.cause = cause;
+        this.format = format;
     }
 }
-const URL_SHORTHAND_MAPPINGS = {
-    notEqual: 'neq',
-    lessThan: 'lt',
-    lessThanOrEqual: 'lte',
-    greaterThan: 'gt',
-    greaterThanOrEqual: 'gte',
-    inRange: 'range',
-    dateBefore: 'before',
-    dateBeforeOrEqual: 'beforeEq',
-    dateAfter: 'after',
-    dateAfterOrEqual: 'afterEq',
-    dateRange: 'daterange'
-};
-const AG_GRID_NAME_MAPPINGS = {
-    eq: 'equals',
-    dateBefore: 'lessThan',
-    dateBeforeOrEqual: 'lessThanOrEqual',
-    dateAfter: 'greaterThan',
-    dateAfterOrEqual: 'greaterThanOrEqual',
-    dateRange: 'inRange'
-};
-function createOperationMaps() {
-    const allOperations = [
-        ...TEXT_FILTER_OPERATIONS,
-        ...NUMBER_FILTER_OPERATIONS,
-        ...DATE_FILTER_OPERATIONS
-    ];
-    const uniqueOperations = [...new Set(allOperations)];
-    const operationMap = {};
-    const internalToUrlMap = {};
-    uniqueOperations.forEach(operation => {
-        const urlName = URL_SHORTHAND_MAPPINGS[operation] || operation;
-        operationMap[urlName] = operation;
-        internalToUrlMap[operation] = urlName;
-    });
-    const agGridMap = {};
-    const reverseAgGridMap = {};
-    uniqueOperations.forEach(operation => {
-        const agGridName = AG_GRID_NAME_MAPPINGS[operation] ||
-            operation;
-        agGridMap[operation] = agGridName;
-        reverseAgGridMap[agGridName] = operation;
-    });
-    return {
-        operationMap,
-        internalToUrlMap,
-        agGridMap,
-        reverseAgGridMap
-    };
-}
-const mappings = createOperationMaps();
-export const OPERATION_MAP = mappings.operationMap;
-export const INTERNAL_TO_URL_OPERATION_MAP = mappings.internalToUrlMap;
-export const AG_GRID_OPERATION_NAMES = mappings.agGridMap;
-export const REVERSE_AG_GRID_OPERATION_NAMES = mappings.reverseAgGridMap;
+export const OPERATION_MAP = Object.fromEntries(OPERATORS.map(op => [op.url, op.id]));
+export const INTERNAL_TO_URL_OPERATION_MAP = Object.fromEntries(OPERATORS.map(op => [op.id, op.url]));
+export const AG_GRID_OPERATION_NAMES = Object.fromEntries(OPERATORS.map(op => [op.id, op.agGrid]));
+export const REVERSE_AG_GRID_OPERATION_NAMES = Object.fromEntries(OPERATORS.map(op => [op.agGrid, op.id]));
 //# sourceMappingURL=types.js.map

package/dist/core/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/core/types.ts"],"names":[],"mappings":"AA+FA,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,UAAU;IACV,aAAa;IACb,YAAY;IACZ,UAAU;CACF,CAAA;AAKV,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACpC,UAAU;IACV,iBAAiB;IACjB,aAAa;IACb,oBAAoB;IACpB,SAAS;CACD,CAAA;AAKV,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,YAAY;IACZ,mBAAmB;IACnB,WAAW;IACX,kBAAkB;IAClB,WAAW;CACH,CAAA;AAKV,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,IAAI;IACJ,UAAU;IACV,OAAO;IACP,UAAU;CACF,CAAA;AAcV,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACpC,GAAG,oBAAoB;IACvB,GAAG,iBAAiB;CACZ,CAAA;AAKV,MAAM,CAAC,MAAM,wBAAwB,GAAG;IACtC,GAAG,sBAAsB;IACzB,GAAG,iBAAiB;CACZ,CAAA;AAKV,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACpC,GAAG,oBAAoB;IACvB,GAAG,iBAAiB;CACZ,CAAA;AAyGV,MAAM,UAAU,qBAAqB,CACnC,EAAmB;IAEnB,OAAO,sBAAsB,CAAC,QAAQ,CAAC,EAAyB,CAAC,CAAA;AACnE,CAAC;AAKD,MAAM,UAAU,uBAAuB,CACrC,EAAmB;IAEnB,OAAO,wBAAwB,CAAC,QAAQ,CAAC,EAA2B,CAAC,CAAA;AACvE,CAAC;AAKD,MAAM,UAAU,qBAAqB,CACnC,EAAmB;IAEnB,OAAO,sBAAsB,CAAC,QAAQ,CAAC,EAAyB,CAAC,CAAA;AACnE,CAAC;AAKD,MAAM,UAAU,gBAAgB,CAAC,EAAmB;IAClD,OAAO,EAAE,KAAK,SAAS,IAAI,EAAE,KAAK,WAAW,CAAA;AAC/C,CAAC;AAKD,MAAM,UAAU,gBAAgB,CAAC,EAAmB;IAClD,OAAO,EAAE,KAAK,OAAO,IAAI,EAAE,KAAK,UAAU,CAAA;AAC5C,CAAC;AAKD,MAAM,UAAU,YAAY,CAAC,MAAoB;IAC/C,OAAO,MAAM,CAAC,UAAU,KAAK,MAAM,CAAA;AACrC,CAAC;AAKD,MAAM,UAAU,cAAc,CAC5B,MAAoB;IAEpB,OAAO,MAAM,CAAC,UAAU,KAAK,QAAQ,CAAA;AACvC,CAAC;AAKD,MAAM,UAAU,YAAY,CAAC,MAAoB;IAC/C,OAAO,MAAM,CAAC,UAAU,KAAK,MAAM,CAAA;AACrC,CAAC;AASD,MAAM,OAAO,YAAa,SAAQ,KAAK;IAGV,KAAK;IAFhC,YACE,OAAe,EACU,KAAa;QAEtC,KAAK,CAAC,OAAO,CAAC,CAAA;qBAFW,KAAK;QAG9B,IAAI,CAAC,IAAI,GAAG,cAAc,CAAA;IAC5B,CAAC;CACF;AAKD,MAAM,OAAO,kBAAmB,SAAQ,YAAY;IAClD,YAAY,OAAe,EAAE,KAAa;QACxC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;QACrB,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAA;IAClC,CAAC;CACF;AAKD,MAAM,OAAO,eAAgB,SAAQ,YAAY;IAC/C,YAAY,OAAe,EAAE,KAAa;QACxC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;QACrB,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAA;IAC/B,CAAC;CACF;AAKD,MAAM,OAAO,gBAAiB,SAAQ,kBAAkB;IACtD,YAAY,OAAe,EAAE,KAAa;QACxC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;QACrB,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAA;IAChC,CAAC;CACF;AAKD,MAAM,OAAO,yBAA0B,SAAQ,KAAK;IAClD,YAAY,MAAc,EAAE,KAAY;QACtC,KAAK,CAAC,WAAW,MAAM,mBAAmB,KAAK,CAAC,OAAO,EAAE,CAAC,CAAA;QAC1D,IAAI,CAAC,IAAI,GAAG,2BAA2B,CAAA;QACvC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;IACpB,CAAC;CACF;AAkGD,MAAM,sBAAsB,GAAG;IAE7B,QAAQ,EAAE,KAAK;IAEf,QAAQ,EAAE,IAAI;IACd,eAAe,EAAE,KAAK;IACtB,WAAW,EAAE,IAAI;IACjB,kBAAkB,EAAE,KAAK;IACzB,OAAO,EAAE,OAAO;IAEhB,UAAU,EAAE,QAAQ;IACpB,iBAAiB,EAAE,UAAU;IAC7B,SAAS,EAAE,OAAO;IAClB,gBAAgB,EAAE,SAAS;IAC3B,SAAS,EAAE,WAAW;CACd,CAAA;AAOV,MAAM,qBAAqB,GAAG;IAE5B,EAAE,EAAE,QAAQ;IAEZ,UAAU,EAAE,UAAU;IACtB,iBAAiB,EAAE,iBAAiB;IACpC,SAAS,EAAE,aAAa;IACxB,gBAAgB,EAAE,oBAAoB;IACtC,SAAS,EAAE,SAAS;CACZ,CAAA;AAKV,SAAS,mBAAmB;IAE1B,MAAM,aAAa,GAAG;QACpB,GAAG,sBAAsB;QACzB,GAAG,wBAAwB;QAC3B,GAAG,sBAAsB;KAC1B,CAAA;IAGD,MAAM,gBAAgB,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,aAAa,CAAC,CAAC,CAAA;IAGpD,MAAM,YAAY,GAAoC,EAAE,CAAA;IACxD,MAAM,gBAAgB,GAAG,EAAqC,CAAA;IAE9D,gBAAgB,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;QACnC,MAAM,OAAO,GACX,sBAAsB,CACpB,SAAgD,CACjD,IAAI,SAAS,CAAA;QAChB,YAAY,CAAC,OAAO,CAAC,GAAG,SAAS,CAAA;QACjC,gBAAgB,CAAC,SAAS,CAAC,GAAG,OAAO,CAAA;IACvC,CAAC,CAAC,CAAA;IAGF,MAAM,SAAS,GAA2B,EAAE,CAAA;IAC5C,MAAM,gBAAgB,GAAoC,EAAE,CAAA;IAE5D,gBAAgB,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;QACnC,MAAM,UAAU,GACd,qBAAqB,CAAC,SAA+C,CAAC;YACtE,SAAS,CAAA;QACX,SAAS,CAAC,SAAS,CAAC,GAAG,UAAU,CAAA;QACjC,gBAAgB,CAAC,UAAU,CAAC,GAAG,SAAS,CAAA;IAC1C,CAAC,CAAC,CAAA;IAEF,OAAO;QACL,YAAY;QACZ,gBAAgB;QAChB,SAAS;QACT,gBAAgB;KACR,CAAA;AACZ,CAAC;AAGD,MAAM,QAAQ,GAAG,mBAAmB,EAAE,CAAA;AAKtC,MAAM,CAAC,MAAM,aAAa,GAAG,QAAQ,CAAC,YAAY,CAAA;AAKlD,MAAM,CAAC,MAAM,6BAA6B,GAAG,QAAQ,CAAC,gBAAgB,CAAA;AAKtE,MAAM,CAAC,MAAM,uBAAuB,GAAG,QAAQ,CAAC,SAAS,CAAA;AAKzD,MAAM,CAAC,MAAM,+BAA+B,GAAG,QAAQ,CAAC,gBAAgB,CAAA"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/core/types.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACjD,OAAO,EACL,SAAS,EACT,aAAa,EACb,iBAAiB,EACjB,gBAAgB,EAChB,cAAc,EACd,YAAY,EAGb,MAAM,gBAAgB,CAAA;AA+JvB,MAAM,CAAC,MAAM,oBAAoB,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAA;AAK7D,MAAM,CAAC,MAAM,sBAAsB,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAA;AAKjE,MAAM,CAAC,MAAM,oBAAoB,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAA;AAK7D,MAAM,CAAC,MAAM,iBAAiB,GAAG,gBAAgB,EAAE,CAAA;AAUnD,MAAM,CAAC,MAAM,sBAAsB,GAAG,aAAa,CAAC,MAAM,CAAC,CAAA;AAK3D,MAAM,CAAC,MAAM,wBAAwB,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAA;AAK/D,MAAM,CAAC,MAAM,sBAAsB,GAAG,aAAa,CAAC,MAAM,CAAC,CAAA;AAsG3D,MAAM,UAAU,qBAAqB,CACnC,EAAmB;IAEnB,OAAO,cAAc,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;AACnC,CAAC;AAKD,MAAM,UAAU,uBAAuB,CACrC,EAAmB;IAEnB,OAAO,cAAc,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAA;AACrC,CAAC;AAKD,MAAM,UAAU,qBAAqB,CACnC,EAAmB;IAEnB,OAAO,cAAc,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;AACnC,CAAC;AAKD,MAAM,UAAU,gBAAgB,CAAC,EAAmB;IAClD,OAAO,YAAY,CAAC,EAAE,CAAC,EAAE,KAAK,KAAK,CAAC,CAAA;AACtC,CAAC;AAKD,MAAM,UAAU,gBAAgB,CAAC,EAAmB;IAClD,OAAO,YAAY,CAAC,EAAE,CAAC,EAAE,KAAK,KAAK,CAAC,CAAA;AACtC,CAAC;AAKD,MAAM,UAAU,YAAY,CAAC,MAAoB;IAC/C,OAAO,MAAM,CAAC,UAAU,KAAK,MAAM,CAAA;AACrC,CAAC;AAKD,MAAM,UAAU,cAAc,CAC5B,MAAoB;IAEpB,OAAO,MAAM,CAAC,UAAU,KAAK,QAAQ,CAAA;AACvC,CAAC;AAKD,MAAM,UAAU,YAAY,CAAC,MAAoB;IAC/C,OAAO,MAAM,CAAC,UAAU,KAAK,MAAM,CAAA;AACrC,CAAC;AAsCD,MAAM,OAAO,YAAa,SAAQ,KAAK;IASV,KAAK;IAPvB,IAAI,CAAW;IAKxB,YACE,OAAe,EACU,KAAa,EACtC,OAAO,GAAiB,EAAE;QAE1B,KAAK,CAAC,OAAO,CAAC,CAAA;qBAHW,KAAK;QAI9B,IAAI,CAAC,IAAI,GAAG,cAAc,CAAA;QAC1B,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,SAAS,CAAA;QAErC,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS;YAAE,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAA;IACtE,CAAC;CACF;AAKD,MAAM,OAAO,kBAAmB,SAAQ,YAAY;IAClD,YAAY,OAAe,EAAE,KAAa,EAAE,OAAO,GAAiB,EAAE;QACpE,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,eAAe,EAAE,CAAC,CAAA;QAC5E,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAA;IAClC,CAAC;CACF;AAKD,MAAM,OAAO,eAAgB,SAAQ,YAAY;IAC/C,YAAY,OAAe,EAAE,KAAa,EAAE,OAAO,GAAiB,EAAE;QACpE,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,aAAa,EAAE,CAAC,CAAA;QAC1E,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAA;IAC/B,CAAC;CACF;AAKD,MAAM,OAAO,gBAAiB,SAAQ,kBAAkB;IACtD,YAAY,OAAe,EAAE,KAAa,EAAE,OAAO,GAAiB,EAAE;QACpE,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,cAAc,EAAE,CAAC,CAAA;QAC3E,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAA;IAChC,CAAC;CACF;AAUD,MAAM,OAAO,yBAA0B,SAAQ,YAAY;IAEhD,MAAM,CAAQ;IAEvB,YAAY,MAAc,EAAE,KAAY;QACtC,KAAK,CACH,WAAW,MAAM,mBAAmB,KAAK,CAAC,OAAO,EAAE,EACnD,KAAK,EACL,KAAK,YAAY,YAAY;YAC3B,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE;YAC5C,CAAC,CAAC,EAAE,IAAI,EAAE,iBAAiB,EAAE,CAChC,CAAA;QACD,IAAI,CAAC,IAAI,GAAG,2BAA2B,CAAA;QACvC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;CACF;AAqID,MAAM,CAAC,MAAM,aAAa,GACxB,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;AAM1D,MAAM,CAAC,MAAM,6BAA6B,GAGxC,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAGtD,CAAA;AAMH,MAAM,CAAC,MAAM,uBAAuB,GAClC,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;AAU7D,MAAM,CAAC,MAAM,+BAA+B,GAC1C,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA"}

package/dist/core/url-generator.d.ts

@@ -1,9 +1,12 @@
-import type { FilterState, InternalConfig } from './types.js';
+import type { AGGridUrlSyncConfig, FilterState } from './types.js';
+import { serializeFilters } from './individual-params.js';
+export { serializeFilters };
 /**
- * Converts a filter state object into URL search parameters
+ * Generates a URL with the current filter state.
+ * This function does not need a grid. An option that the config leaves out
+ * gets its default.
+ *
+ * The host app's own params are kept, including repeated keys. Filter params
+ * from either mode are replaced.
  */
-export declare function serializeFilters(filterState: FilterState, config: InternalConfig): URLSearchParams;
-/**
- * Generates a URL with the current filter state
- */
-export declare function generateUrl(baseUrl: string, filterState: FilterState, config: InternalConfig): string;
+export declare function generateUrl(baseUrl: string, filterState: FilterState, config?: AGGridUrlSyncConfig): string;