apex-grid 3.4.0 → 3.6.0

package/controllers/expansion.d.ts

@@ -4,23 +4,30 @@ import type { GridHost } from '../internal/types.js';
  * The default expansion configuration used when the grid has none set.
  *
  * @remarks
- * `detailTemplate` defaults to `null` here — the controller will refuse to
+ * `detailTemplate` defaults to `null` here; the controller will refuse to
  * toggle rows when the configuration is missing or no template is provided.
  */
 export declare const DEFAULT_EXPANSION_CONFIG: Readonly<{
     enabled: false;
     showToggleColumn: true;
 }>;
+/**
+ * Returns `rows` without the entries that are no longer in `data`, for an
+ * expansion set that follows a data refresh. The survivors are counted first,
+ * so the usual refresh (nothing left) allocates nothing and returns `rows`
+ * itself. A row listed twice in `data` counts twice, which can keep one stale
+ * entry until a later refresh.
+ */
+export declare function retainPresent<T>(rows: Set<T>, data: ReadonlyArray<T>): Set<T>;
 /**
  * Reactive controller backing row expansion (master-detail).
  *
  * @remarks
- * Expansion state is reference-based — the controller holds a `Set` of row
+ * Expansion state is reference-based: the controller holds a `Set` of row
  * data references so the expansion set survives sort / filter / pagination as
  * long as those operations preserve row identity (the default in-place
- * pipeline does). Replacing {@link ApexGrid.data} wholesale invalidates any
- * expanded rows that are no longer present; consumers should call
- * {@link collapseAll} or re-apply expansion afterwards.
+ * pipeline does). Replacing {@link ApexGrid.data} keeps the rows that are
+ * still present and drops the rest, without events.
  *
  * Mutations go through the cancellable `rowExpanding` event and emit a
  * follow-up `rowExpanded` event, mirroring the pattern used by selection
@@ -33,6 +40,8 @@ export declare class ExpansionController<T extends object> implements ReactiveCo
     expanded: Set<T>;
     constructor(host: GridHost<T>);
     hostConnected(): void;
+    /** Drops expanded rows that left {@link ApexGrid.data} once it is replaced. */
+    hostUpdate(): void;
     /** Whether expansion is enabled at the grid level. */
     get enabled(): boolean;
     /** Whether the built-in chevron toggle column should be rendered. */

package/controllers/expansion.js

@@ -2,13 +2,36 @@ export const DEFAULT_EXPANSION_CONFIG = Object.freeze({
     enabled: false,
     showToggleColumn: true,
 });
+export function retainPresent(rows, data) {
+    if (rows.size === 0)
+        return rows;
+    let present = 0;
+    for (const row of data)
+        if (rows.has(row))
+            present++;
+    if (present === rows.size)
+        return rows;
+    const next = new Set();
+    for (const row of data)
+        if (rows.has(row))
+            next.add(row);
+    return next;
+}
 export class ExpansionController {
+    #data;
     constructor(host) {
         this.host = host;
         this.expanded = new Set();
         this.host.addController(this);
     }
     hostConnected() { }
+    hostUpdate() {
+        const data = this.host.data;
+        if (!data || data === this.#data)
+            return;
+        this.#data = data;
+        this.expanded = retainPresent(this.expanded, data);
+    }
     get enabled() {
         return Boolean(this.host.expansion?.enabled);
     }
@@ -111,7 +134,7 @@ export class ExpansionController {
         else if (added.length === 0 && removed.length === 1) {
             this.host.announce(this.host.localize('announce.rowCollapsed'));
         }
-        else if (added.length > 0 && next.size === added.length + this.expanded.size - added.length) {
+        else if (added.length > 0 && removed.length === 0) {
             this.host.announce(this.host.localize('announce.rowsExpanded', { count: added.length }));
         }
         else if (removed.length > 0 && next.size === 0) {

package/controllers/expansion.js.map

@@ -1 +1 @@
-{"version":3,"file":"expansion.js","sourceRoot":"","sources":["../../src/controllers/expansion.ts"],"names":[],"mappings":"AAUA,MAAM,CAAC,MAAM,wBAAwB,GAAG,MAAM,CAAC,MAAM,CAAC;IACpD,OAAO,EAAE,KAAK;IACd,gBAAgB,EAAE,IAAI;CACvB,CAAC,CAAC;AAiBH,MAAM,OAAO,mBAAmB;IAI9B,YAAsB,IAAiB;QAAjB,SAAI,GAAJ,IAAI,CAAa;QAFhC,aAAQ,GAAW,IAAI,GAAG,EAAE,CAAC;QAGlC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAEM,aAAa,KAAI,CAAC;IAGzB,IAAW,OAAO;QAChB,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;IAGD,IAAW,gBAAgB;QACzB,OAAO,CACL,IAAI,CAAC,OAAO;YACZ,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,gBAAgB,IAAI,wBAAwB,CAAC,gBAAgB,CAAC,CACrF,CAAC;IACJ,CAAC;IAGM,UAAU,CAAC,GAAM;QACtB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAChC,CAAC;IAOM,SAAS,CAAC,GAAM;QACrB,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO,KAAK,CAAC;QAChC,IAAI,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,cAAc,KAAK,UAAU;YAAE,OAAO,KAAK,CAAC;QAC5E,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC;QACpD,OAAO,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACpD,CAAC;IAGM,YAAY;QACjB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACnC,CAAC;IAGM,KAAK,CAAC,SAAS,CAAC,GAAM;QAC3B,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,OAAO,KAAK,CAAC;QAClE,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpC,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;;YAC/B,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACnB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAGM,KAAK,CAAC,SAAS,CAAC,GAAM;QAC3B,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,OAAO,IAAI,CAAC;QACxC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC;YAAE,OAAO,KAAK,CAAC;QACvC,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACd,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAGM,KAAK,CAAC,WAAW,CAAC,GAAM;QAC7B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,OAAO,IAAI,CAAC;QACzC,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACjB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAMM,KAAK,CAAC,SAAS;QACpB,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,cAAc,KAAK,UAAU;YAAE,OAAO,KAAK,CAAC;QAC7F,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC;QACpD,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpC,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,QAA4B,EAAE,CAAC;YACzD,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC,GAAG,CAAC;gBAAE,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAClD,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAGM,KAAK,CAAC,WAAW;QACtB,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC;IACjC,CAAC;IAMM,KAAK,CAAC,gBAAgB,CAAC,IAAsB;QAClD,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO,KAAK,CAAC;QAChC,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC;QACpD,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC9E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,IAAY;QACxB,MAAM,KAAK,GAAQ,EAAE,CAAC;QACtB,MAAM,OAAO,GAAQ,EAAE,CAAC;QACxB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC;gBAAE,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC/C,CAAC;QACD,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAChC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;gBAAE,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxC,CAAC;QACD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QAE5D,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE;YAClD,MAAM,EAAE;gBACN,KAAK;gBACL,OAAO;gBACP,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;gBAClC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;aACvB;YACD,UAAU,EAAE,IAAI;SACjB,CAAC,CAAC;QACH,IAAI,CAAC,OAAO;YAAE,OAAO,KAAK,CAAC;QAE3B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;QAE1B,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/C,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAC,CAAC;QACjE,CAAC;aAAM,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,uBAAuB,CAAC,CAAC,CAAC;QAClE,CAAC;aAAM,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;YAC9F,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,uBAAuB,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC3F,CAAC;aAAM,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YACjD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,2BAA2B,CAAC,CAAC,CAAC;QACtE,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE;YACjC,MAAM,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;SAChE,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;CACF","sourcesContent":["import type { ReactiveController } from 'lit';\nimport type { GridHost } from '../internal/types.js';\n\n/**\n * The default expansion configuration used when the grid has none set.\n *\n * @remarks\n * `detailTemplate` defaults to `null` here — the controller will refuse to\n * toggle rows when the configuration is missing or no template is provided.\n */\nexport const DEFAULT_EXPANSION_CONFIG = Object.freeze({\n  enabled: false,\n  showToggleColumn: true,\n});\n\n/**\n * Reactive controller backing row expansion (master-detail).\n *\n * @remarks\n * Expansion state is reference-based — the controller holds a `Set` of row\n * data references so the expansion set survives sort / filter / pagination as\n * long as those operations preserve row identity (the default in-place\n * pipeline does). Replacing {@link ApexGrid.data} wholesale invalidates any\n * expanded rows that are no longer present; consumers should call\n * {@link collapseAll} or re-apply expansion afterwards.\n *\n * Mutations go through the cancellable `rowExpanding` event and emit a\n * follow-up `rowExpanded` event, mirroring the pattern used by selection\n * and editing.\n */\nexport class ExpansionController<T extends object> implements ReactiveController {\n  /** Set of currently expanded row data references. */\n  public expanded: Set<T> = new Set();\n\n  constructor(protected host: GridHost<T>) {\n    this.host.addController(this);\n  }\n\n  public hostConnected() {}\n\n  /** Whether expansion is enabled at the grid level. */\n  public get enabled(): boolean {\n    return Boolean(this.host.expansion?.enabled);\n  }\n\n  /** Whether the built-in chevron toggle column should be rendered. */\n  public get showToggleColumn(): boolean {\n    return (\n      this.enabled &&\n      (this.host.expansion?.showToggleColumn ?? DEFAULT_EXPANSION_CONFIG.showToggleColumn)\n    );\n  }\n\n  /** Whether `row` is currently expanded. */\n  public isExpanded(row: T): boolean {\n    return this.expanded.has(row);\n  }\n\n  /**\n   * Whether `row` is permitted to expand. Combines the grid-wide `enabled`\n   * flag, the presence of a `detailTemplate`, and the optional per-row\n   * `isExpandable` predicate.\n   */\n  public canExpand(row: T): boolean {\n    if (!this.enabled) return false;\n    if (typeof this.host.expansion?.detailTemplate !== 'function') return false;\n    const predicate = this.host.expansion?.isExpandable;\n    return predicate ? Boolean(predicate(row)) : true;\n  }\n\n  /** Snapshot of currently expanded rows in insertion order. */\n  public expandedRows(): T[] {\n    return Array.from(this.expanded);\n  }\n\n  /** Toggles the expansion of `row`. */\n  public async toggleRow(row: T): Promise<boolean> {\n    if (!this.canExpand(row) && !this.expanded.has(row)) return false;\n    const next = new Set(this.expanded);\n    if (next.has(row)) next.delete(row);\n    else next.add(row);\n    return this.#commit(next);\n  }\n\n  /** Expands `row`. No-op when the row is already expanded or not expandable. */\n  public async expandRow(row: T): Promise<boolean> {\n    if (this.expanded.has(row)) return true;\n    if (!this.canExpand(row)) return false;\n    const next = new Set(this.expanded);\n    next.add(row);\n    return this.#commit(next);\n  }\n\n  /** Collapses `row`. No-op when the row is not expanded. */\n  public async collapseRow(row: T): Promise<boolean> {\n    if (!this.expanded.has(row)) return true;\n    const next = new Set(this.expanded);\n    next.delete(row);\n    return this.#commit(next);\n  }\n\n  /**\n   * Expands every expandable row in {@link ApexGrid.dataView}. Skips rows\n   * the optional `isExpandable` predicate rejects.\n   */\n  public async expandAll(): Promise<boolean> {\n    if (!this.enabled || typeof this.host.expansion?.detailTemplate !== 'function') return false;\n    const predicate = this.host.expansion?.isExpandable;\n    const next = new Set(this.expanded);\n    for (const row of this.host.dataView as ReadonlyArray<T>) {\n      if (!predicate || predicate(row)) next.add(row);\n    }\n    return this.#commit(next);\n  }\n\n  /** Collapses every currently expanded row. */\n  public async collapseAll(): Promise<boolean> {\n    if (this.expanded.size === 0) return true;\n    return this.#commit(new Set());\n  }\n\n  /**\n   * Replaces the expansion set with `rows`. Used by the public\n   * {@link ApexGrid.expandedRows} setter for programmatic control.\n   */\n  public async replaceExpansion(rows: ReadonlyArray<T>): Promise<boolean> {\n    if (!this.enabled) return false;\n    const predicate = this.host.expansion?.isExpandable;\n    const next = new Set(predicate ? rows.filter((row) => predicate(row)) : rows);\n    return this.#commit(next);\n  }\n\n  async #commit(next: Set<T>): Promise<boolean> {\n    const added: T[] = [];\n    const removed: T[] = [];\n    for (const row of next) {\n      if (!this.expanded.has(row)) added.push(row);\n    }\n    for (const row of this.expanded) {\n      if (!next.has(row)) removed.push(row);\n    }\n    if (added.length === 0 && removed.length === 0) return true;\n\n    const proceed = this.host.emitEvent('rowExpanding', {\n      detail: {\n        added,\n        removed,\n        current: Array.from(this.expanded),\n        next: Array.from(next),\n      },\n      cancelable: true,\n    });\n    if (!proceed) return false;\n\n    this.expanded = next;\n    this.host.requestUpdate();\n\n    if (added.length === 1 && removed.length === 0) {\n      this.host.announce(this.host.localize('announce.rowExpanded'));\n    } else if (added.length === 0 && removed.length === 1) {\n      this.host.announce(this.host.localize('announce.rowCollapsed'));\n    } else if (added.length > 0 && next.size === added.length + this.expanded.size - added.length) {\n      this.host.announce(this.host.localize('announce.rowsExpanded', { count: added.length }));\n    } else if (removed.length > 0 && next.size === 0) {\n      this.host.announce(this.host.localize('announce.allRowsCollapsed'));\n    }\n\n    this.host.emitEvent('rowExpanded', {\n      detail: { added, removed, expanded: Array.from(this.expanded) },\n    });\n    return true;\n  }\n}\n"]}
+{"version":3,"file":"expansion.js","sourceRoot":"","sources":["../../src/controllers/expansion.ts"],"names":[],"mappings":"AAUA,MAAM,CAAC,MAAM,wBAAwB,GAAG,MAAM,CAAC,MAAM,CAAC;IACpD,OAAO,EAAE,KAAK;IACd,gBAAgB,EAAE,IAAI;CACvB,CAAC,CAAC;AASH,MAAM,UAAU,aAAa,CAAI,IAAY,EAAE,IAAsB;IACnE,IAAI,IAAI,CAAC,IAAI,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IACjC,IAAI,OAAO,GAAG,CAAC,CAAC;IAChB,KAAK,MAAM,GAAG,IAAI,IAAI;QAAE,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,OAAO,EAAE,CAAC;IACrD,IAAI,OAAO,KAAK,IAAI,CAAC,IAAI;QAAE,OAAO,IAAI,CAAC;IACvC,MAAM,IAAI,GAAG,IAAI,GAAG,EAAK,CAAC;IAC1B,KAAK,MAAM,GAAG,IAAI,IAAI;QAAE,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACzD,OAAO,IAAI,CAAC;AACd,CAAC;AAgBD,MAAM,OAAO,mBAAmB;IAI9B,KAAK,CAAoB;IAEzB,YAAsB,IAAiB;QAAjB,SAAI,GAAJ,IAAI,CAAa;QAJhC,aAAQ,GAAW,IAAI,GAAG,EAAE,CAAC;QAKlC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAEM,aAAa,KAAI,CAAC;IAGlB,UAAU;QACf,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;QAC5B,IAAI,CAAC,IAAI,IAAI,IAAI,KAAK,IAAI,CAAC,KAAK;YAAE,OAAO;QACzC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,QAAQ,GAAG,aAAa,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IACrD,CAAC;IAGD,IAAW,OAAO;QAChB,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;IAGD,IAAW,gBAAgB;QACzB,OAAO,CACL,IAAI,CAAC,OAAO;YACZ,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,gBAAgB,IAAI,wBAAwB,CAAC,gBAAgB,CAAC,CACrF,CAAC;IACJ,CAAC;IAGM,UAAU,CAAC,GAAM;QACtB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAChC,CAAC;IAOM,SAAS,CAAC,GAAM;QACrB,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO,KAAK,CAAC;QAChC,IAAI,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,cAAc,KAAK,UAAU;YAAE,OAAO,KAAK,CAAC;QAC5E,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC;QACpD,OAAO,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACpD,CAAC;IAGM,YAAY;QACjB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACnC,CAAC;IAGM,KAAK,CAAC,SAAS,CAAC,GAAM;QAC3B,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,OAAO,KAAK,CAAC;QAClE,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpC,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;;YAC/B,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACnB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAGM,KAAK,CAAC,SAAS,CAAC,GAAM;QAC3B,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,OAAO,IAAI,CAAC;QACxC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC;YAAE,OAAO,KAAK,CAAC;QACvC,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACd,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAGM,KAAK,CAAC,WAAW,CAAC,GAAM;QAC7B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,OAAO,IAAI,CAAC;QACzC,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACjB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAMM,KAAK,CAAC,SAAS;QACpB,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,cAAc,KAAK,UAAU;YAAE,OAAO,KAAK,CAAC;QAC7F,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC;QACpD,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpC,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,QAA4B,EAAE,CAAC;YACzD,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC,GAAG,CAAC;gBAAE,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAClD,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAGM,KAAK,CAAC,WAAW;QACtB,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC;IACjC,CAAC;IAMM,KAAK,CAAC,gBAAgB,CAAC,IAAsB;QAClD,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO,KAAK,CAAC;QAChC,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC;QACpD,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC9E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,IAAY;QACxB,MAAM,KAAK,GAAQ,EAAE,CAAC;QACtB,MAAM,OAAO,GAAQ,EAAE,CAAC;QACxB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC;gBAAE,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC/C,CAAC;QACD,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAChC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;gBAAE,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxC,CAAC;QACD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QAE5D,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE;YAClD,MAAM,EAAE;gBACN,KAAK;gBACL,OAAO;gBACP,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;gBAClC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;aACvB;YACD,UAAU,EAAE,IAAI;SACjB,CAAC,CAAC;QACH,IAAI,CAAC,OAAO;YAAE,OAAO,KAAK,CAAC;QAE3B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;QAE1B,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/C,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAC,CAAC;QACjE,CAAC;aAAM,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,uBAAuB,CAAC,CAAC,CAAC;QAClE,CAAC;aAAM,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAGpD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,uBAAuB,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC3F,CAAC;aAAM,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YACjD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,2BAA2B,CAAC,CAAC,CAAC;QACtE,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE;YACjC,MAAM,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;SAChE,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;CACF","sourcesContent":["import type { ReactiveController } from 'lit';\nimport type { GridHost } from '../internal/types.js';\n\n/**\n * The default expansion configuration used when the grid has none set.\n *\n * @remarks\n * `detailTemplate` defaults to `null` here; the controller will refuse to\n * toggle rows when the configuration is missing or no template is provided.\n */\nexport const DEFAULT_EXPANSION_CONFIG = Object.freeze({\n  enabled: false,\n  showToggleColumn: true,\n});\n\n/**\n * Returns `rows` without the entries that are no longer in `data`, for an\n * expansion set that follows a data refresh. The survivors are counted first,\n * so the usual refresh (nothing left) allocates nothing and returns `rows`\n * itself. A row listed twice in `data` counts twice, which can keep one stale\n * entry until a later refresh.\n */\nexport function retainPresent<T>(rows: Set<T>, data: ReadonlyArray<T>): Set<T> {\n  if (rows.size === 0) return rows;\n  let present = 0;\n  for (const row of data) if (rows.has(row)) present++;\n  if (present === rows.size) return rows;\n  const next = new Set<T>();\n  for (const row of data) if (rows.has(row)) next.add(row);\n  return next;\n}\n\n/**\n * Reactive controller backing row expansion (master-detail).\n *\n * @remarks\n * Expansion state is reference-based: the controller holds a `Set` of row\n * data references so the expansion set survives sort / filter / pagination as\n * long as those operations preserve row identity (the default in-place\n * pipeline does). Replacing {@link ApexGrid.data} keeps the rows that are\n * still present and drops the rest, without events.\n *\n * Mutations go through the cancellable `rowExpanding` event and emit a\n * follow-up `rowExpanded` event, mirroring the pattern used by selection\n * and editing.\n */\nexport class ExpansionController<T extends object> implements ReactiveController {\n  /** Set of currently expanded row data references. */\n  public expanded: Set<T> = new Set();\n  /** The data array the expansion set was last reconciled with. */\n  #data?: ReadonlyArray<T>;\n\n  constructor(protected host: GridHost<T>) {\n    this.host.addController(this);\n  }\n\n  public hostConnected() {}\n\n  /** Drops expanded rows that left {@link ApexGrid.data} once it is replaced. */\n  public hostUpdate() {\n    const data = this.host.data;\n    if (!data || data === this.#data) return;\n    this.#data = data;\n    this.expanded = retainPresent(this.expanded, data);\n  }\n\n  /** Whether expansion is enabled at the grid level. */\n  public get enabled(): boolean {\n    return Boolean(this.host.expansion?.enabled);\n  }\n\n  /** Whether the built-in chevron toggle column should be rendered. */\n  public get showToggleColumn(): boolean {\n    return (\n      this.enabled &&\n      (this.host.expansion?.showToggleColumn ?? DEFAULT_EXPANSION_CONFIG.showToggleColumn)\n    );\n  }\n\n  /** Whether `row` is currently expanded. */\n  public isExpanded(row: T): boolean {\n    return this.expanded.has(row);\n  }\n\n  /**\n   * Whether `row` is permitted to expand. Combines the grid-wide `enabled`\n   * flag, the presence of a `detailTemplate`, and the optional per-row\n   * `isExpandable` predicate.\n   */\n  public canExpand(row: T): boolean {\n    if (!this.enabled) return false;\n    if (typeof this.host.expansion?.detailTemplate !== 'function') return false;\n    const predicate = this.host.expansion?.isExpandable;\n    return predicate ? Boolean(predicate(row)) : true;\n  }\n\n  /** Snapshot of currently expanded rows in insertion order. */\n  public expandedRows(): T[] {\n    return Array.from(this.expanded);\n  }\n\n  /** Toggles the expansion of `row`. */\n  public async toggleRow(row: T): Promise<boolean> {\n    if (!this.canExpand(row) && !this.expanded.has(row)) return false;\n    const next = new Set(this.expanded);\n    if (next.has(row)) next.delete(row);\n    else next.add(row);\n    return this.#commit(next);\n  }\n\n  /** Expands `row`. No-op when the row is already expanded or not expandable. */\n  public async expandRow(row: T): Promise<boolean> {\n    if (this.expanded.has(row)) return true;\n    if (!this.canExpand(row)) return false;\n    const next = new Set(this.expanded);\n    next.add(row);\n    return this.#commit(next);\n  }\n\n  /** Collapses `row`. No-op when the row is not expanded. */\n  public async collapseRow(row: T): Promise<boolean> {\n    if (!this.expanded.has(row)) return true;\n    const next = new Set(this.expanded);\n    next.delete(row);\n    return this.#commit(next);\n  }\n\n  /**\n   * Expands every expandable row in {@link ApexGrid.dataView}. Skips rows\n   * the optional `isExpandable` predicate rejects.\n   */\n  public async expandAll(): Promise<boolean> {\n    if (!this.enabled || typeof this.host.expansion?.detailTemplate !== 'function') return false;\n    const predicate = this.host.expansion?.isExpandable;\n    const next = new Set(this.expanded);\n    for (const row of this.host.dataView as ReadonlyArray<T>) {\n      if (!predicate || predicate(row)) next.add(row);\n    }\n    return this.#commit(next);\n  }\n\n  /** Collapses every currently expanded row. */\n  public async collapseAll(): Promise<boolean> {\n    if (this.expanded.size === 0) return true;\n    return this.#commit(new Set());\n  }\n\n  /**\n   * Replaces the expansion set with `rows`. Used by the public\n   * {@link ApexGrid.expandedRows} setter for programmatic control.\n   */\n  public async replaceExpansion(rows: ReadonlyArray<T>): Promise<boolean> {\n    if (!this.enabled) return false;\n    const predicate = this.host.expansion?.isExpandable;\n    const next = new Set(predicate ? rows.filter((row) => predicate(row)) : rows);\n    return this.#commit(next);\n  }\n\n  async #commit(next: Set<T>): Promise<boolean> {\n    const added: T[] = [];\n    const removed: T[] = [];\n    for (const row of next) {\n      if (!this.expanded.has(row)) added.push(row);\n    }\n    for (const row of this.expanded) {\n      if (!next.has(row)) removed.push(row);\n    }\n    if (added.length === 0 && removed.length === 0) return true;\n\n    const proceed = this.host.emitEvent('rowExpanding', {\n      detail: {\n        added,\n        removed,\n        current: Array.from(this.expanded),\n        next: Array.from(next),\n      },\n      cancelable: true,\n    });\n    if (!proceed) return false;\n\n    this.expanded = next;\n    this.host.requestUpdate();\n\n    if (added.length === 1 && removed.length === 0) {\n      this.host.announce(this.host.localize('announce.rowExpanded'));\n    } else if (added.length === 0 && removed.length === 1) {\n      this.host.announce(this.host.localize('announce.rowCollapsed'));\n    } else if (added.length > 0 && removed.length === 0) {\n      // Only a pure expansion has a count to report; a swap that also\n      // collapses rows would be misread as \"N rows expanded\".\n      this.host.announce(this.host.localize('announce.rowsExpanded', { count: added.length }));\n    } else if (removed.length > 0 && next.size === 0) {\n      this.host.announce(this.host.localize('announce.allRowsCollapsed'));\n    }\n\n    this.host.emitEvent('rowExpanded', {\n      detail: { added, removed, expanded: Array.from(this.expanded) },\n    });\n    return true;\n  }\n}\n"]}

package/controllers/filter.d.ts

@@ -15,7 +15,15 @@ export declare class FilterController<T extends object> implements ReactiveContr
     setActiveColumn(column?: ColumnConfiguration<T>, triggerRect?: DOMRect): void;
     getDefaultExpression(column: ColumnConfiguration<T>): FilterExpression<T>;
     removeAllExpressions(key: Keys<T>): Promise<void>;
-    removeExpression(expression: FilterExpression<T>): Promise<void>;
-    filterWithEvent(expression: FilterExpression<T>, type: 'add' | 'modify' | 'remove'): Promise<void>;
+    /** Resolves to false when nothing was removed (not applied, or cancelled). */
+    removeExpression(expression: FilterExpression<T>): Promise<boolean>;
+    /**
+     * Emits the cancelable `filtering` event for `expression` and applies it
+     * when the event passes. With a `target` (the panel's draft or an applied
+     * expression), `expression` is the proposed copy: it is written into
+     * `target` only after the event passes, so a cancelled change leaves the
+     * applied filter untouched. Resolves to false when cancelled.
+     */
+    filterWithEvent(expression: FilterExpression<T>, type: 'add' | 'modify' | 'remove', target?: FilterExpression<T>): Promise<boolean>;
     filter(expression: FilterExpression<T> | FilterExpression<T>[]): void;
 }

package/controllers/filter.js

@@ -5,14 +5,13 @@ export class FilterController {
     constructor(host) {
         this.host = host;
         this.state = new FilterState();
+        this.#applied = [];
+        this.#touched = false;
         this.host.addController(this);
     }
     get filterRow() {
         return this.host.filterRow;
     }
-    get #virtualizer() {
-        return this.host.scrollContainer;
-    }
     #emitFilteringEvent(expression, type) {
         return this.host.emitEvent('filtering', {
             detail: {
@@ -30,11 +29,20 @@ export class FilterController {
         for (const expr of asArray(expression)) {
             this.state.set(expr);
         }
-        this.#virtualizer?.scrollTo({ top: 0 });
+        this.#touched = true;
         this.host.requestUpdate(PIPELINE);
     }
+    #applied;
+    #touched;
     hostConnected() { }
     hostUpdate() {
+        if (this.#touched) {
+            this.#touched = false;
+            const next = snapshot(this.state);
+            if (!sameFilter(this.#applied, next))
+                this.host.scrollTop = 0;
+            this.#applied = next;
+        }
         this.filterRow?.requestUpdate();
     }
     get(key) {
@@ -42,6 +50,7 @@ export class FilterController {
     }
     reset(key) {
         key ? this.state.delete(key) : this.state.clear();
+        this.#touched = true;
     }
     setActiveColumn(column, triggerRect) {
         const filterRow = this.filterRow;
@@ -72,6 +81,8 @@ export class FilterController {
         };
     }
     async removeAllExpressions(key) {
+        if (!this.state.has(key))
+            return;
         const state = this.get(key)?.all ?? [];
         if (!this.host.emitEvent('filtering', {
             detail: {
@@ -85,33 +96,37 @@ export class FilterController {
         }
         this.reset(key);
         this.#filter([]);
-        await this.host.updateComplete;
+        await this.host.pipelineSettled();
         this.#announce(key, 'cleared');
         this.#emitFilteredEvent({ key, state: this.get(key)?.all ?? [] });
     }
     async removeExpression(expression) {
         const state = this.get(expression.key);
+        if (!state?.has(expression))
+            return false;
         if (!this.#emitFilteringEvent(expression, 'remove')) {
-            return;
+            return false;
         }
-        state?.remove(expression);
-        if (state?.empty) {
+        state.remove(expression);
+        if (state.empty) {
             this.reset(state.key);
         }
         this.#filter([]);
-        await this.host.updateComplete;
+        await this.host.pipelineSettled();
         this.#announce(expression.key, 'cleared');
-        this.#emitFilteredEvent({ key: expression.key, state: state?.all ?? [] });
+        this.#emitFilteredEvent({ key: expression.key, state: state.all });
+        return true;
     }
-    async filterWithEvent(expression, type) {
+    async filterWithEvent(expression, type, target = expression) {
         if (!this.#emitFilteringEvent(expression, type)) {
-            return;
+            return false;
         }
-        this.#filter(expression);
-        await this.host.updateComplete;
+        this.#filter(Object.assign(target, expression));
+        await this.host.pipelineSettled();
         if (type === 'add')
-            this.#announce(expression.key, 'applied');
-        this.#emitFilteredEvent({ key: expression.key, state: this.get(expression.key)?.all ?? [] });
+            this.#announce(target.key, 'applied');
+        this.#emitFilteredEvent({ key: target.key, state: this.get(target.key)?.all ?? [] });
+        return true;
     }
     #announce(key, kind) {
         const column = this.host.getColumn(key);
@@ -121,7 +136,37 @@ export class FilterController {
         }));
     }
     filter(expression) {
-        this.#filter(asArray(expression).map((expr) => Object.assign(this.getDefaultExpression(this.host.getColumn(expr.key)), expr)));
+        this.#filter(asArray(expression).map((expr) => {
+            const defaults = this.getDefaultExpression(this.host.getColumn(expr.key));
+            return Object.assign(defaults, expr, {
+                condition: expr.condition ?? defaults.condition,
+                caseSensitive: expr.caseSensitive ?? defaults.caseSensitive,
+            });
+        }));
+    }
+}
+function snapshot(state) {
+    const out = [];
+    for (const tree of state.values) {
+        for (const e of tree)
+            out.push(e.key, e.condition, e.searchTerm, e.criteria, e.caseSensitive);
     }
+    return out;
+}
+function sameFilter(a, b) {
+    if (a.length !== b.length)
+        return false;
+    for (let i = 0; i < a.length; i++) {
+        const x = a[i];
+        const y = b[i];
+        if (Object.is(x, y))
+            continue;
+        if (x instanceof Date && y instanceof Date && x.getTime() === y.getTime())
+            continue;
+        if (Array.isArray(x) && Array.isArray(y) && sameFilter(x, y))
+            continue;
+        return false;
+    }
+    return true;
 }
 //# sourceMappingURL=filter.js.map

package/controllers/filter.js.map

@@ -1 +1 @@
-{"version":3,"file":"filter.js","sourceRoot":"","sources":["../../src/controllers/filter.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAEpD,OAAO,EAAE,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AACrE,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAG5D,MAAM,OAAO,gBAAgB;IAC3B,YAAsB,IAAiB;QAAjB,SAAI,GAAJ,IAAI,CAAa;QAIhC,UAAK,GAAmB,IAAI,WAAW,EAAE,CAAC;QAH/C,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAID,IAAW,SAAS;QAElB,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC;IAC7B,CAAC;IAED,IAAI,YAAY;QAEd,OAAO,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC;IACnC,CAAC;IAED,mBAAmB,CAAC,UAA+B,EAAE,IAAiC;QACpF,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE;YACtC,MAAM,EAAE;gBACN,GAAG,EAAE,UAAU,CAAC,GAAG;gBACnB,WAAW,EAAE,CAAC,UAAU,CAAC;gBACzB,IAAI;aACL;YACD,UAAU,EAAE,IAAI;SACjB,CAAC,CAAC;IACL,CAAC;IAED,kBAAkB,CAAC,MAA6B;QAC9C,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACrD,CAAC;IAED,OAAO,CAAC,UAAuD;QAC7D,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;YACvC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACvB,CAAC;QAID,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;QACxC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;IAEM,aAAa,KAAI,CAAC;IAElB,UAAU;QACf,IAAI,CAAC,SAAS,EAAE,aAAa,EAAE,CAAC;IAClC,CAAC;IAEM,GAAG,CAAC,GAAY;QACrB,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;IAEM,KAAK,CAAC,GAAa;QACxB,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IACpD,CAAC;IAEM,eAAe,CAAC,MAA+B,EAAE,WAAqB;QAC3E,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,SAAS;YAAE,OAAO;QAEvB,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC;YACpB,SAAS,CAAC,MAAM,GAAG,KAAK,CAAC;YACzB,OAAO;QACT,CAAC;QAGD,IAAI,SAAS,CAAC,MAAM,IAAI,SAAS,CAAC,MAAM,EAAE,GAAG,KAAK,MAAM,CAAC,GAAG,EAAE,CAAC;YAC7D,SAAS,CAAC,MAAM,GAAG,KAAK,CAAC;YACzB,OAAO;QACT,CAAC;QAED,SAAS,CAAC,WAAW,GAAG,WAAW,IAAI,IAAI,CAAC;QAC5C,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC;QAC1B,SAAS,CAAC,UAAU,GAAG,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;QACzD,SAAS,CAAC,MAAM,GAAG,IAAI,CAAC;QACxB,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;IAC5B,CAAC;IAEM,oBAAoB,CAAC,MAA8B;QACxD,MAAM,aAAa,GACjB,OAAO,MAAM,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;QACrF,MAAM,QAAQ,GAAG,oBAAoB,CAAC,MAAM,CAAC,CAAC;QAC9C,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAA4B,CAAC;QAG9D,OAAO;YACL,GAAG,EAAE,MAAM,CAAC,GAAG;YACf,SAAS,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC5B,aAAa;SACoB,CAAC;IACtC,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAC,GAAY;QAC5C,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC;QAEvC,IACE,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE;YAChC,MAAM,EAAE;gBACN,GAAG;gBACH,WAAW,EAAE,KAAK;gBAClB,IAAI,EAAE,QAAQ;aACf;YACD,UAAU,EAAE,IAAI;SACjB,CAAC,EACF,CAAC;YACD,OAAO;QACT,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAChB,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAEjB,MAAM,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC;QAC/B,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAC/B,IAAI,CAAC,kBAAkB,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC,CAAC;IACpE,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,UAA+B;QAC3D,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAEvC,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,UAAU,EAAE,QAAQ,CAAC,EAAE,CAAC;YACpD,OAAO;QACT,CAAC;QAED,KAAK,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC;QAE1B,IAAI,KAAK,EAAE,KAAK,EAAE,CAAC;YACjB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACxB,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAEjB,MAAM,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC;QAC/B,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAC1C,IAAI,CAAC,kBAAkB,CAAC,EAAE,GAAG,EAAE,UAAU,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC,CAAC;IAC5E,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,UAA+B,EAAE,IAAiC;QAC7F,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,UAAU,EAAE,IAAI,CAAC,EAAE,CAAC;YAChD,OAAO;QACT,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAEzB,MAAM,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC;QAG/B,IAAI,IAAI,KAAK,KAAK;YAAE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAC9D,IAAI,CAAC,kBAAkB,CAAC,EAAE,GAAG,EAAE,UAAU,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED,SAAS,CAAC,GAAY,EAAE,IAA2B;QACjD,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QACxC,MAAM,KAAK,GAAG,MAAM,EAAE,UAAU,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC;QAChD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAChB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,wBAAwB,EAAE;YACtF,KAAK;SACN,CAAC,CACH,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,UAAuD;QACnE,IAAI,CAAC,OAAO,CACV,OAAO,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAC/B,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAE,CAAC,EAAE,IAAI,CAAC,CAC/E,CACF,CAAC;IACJ,CAAC;CACF","sourcesContent":["import type { ReactiveController } from 'lit';\nimport type { ApexFilteredEvent } from '../components/grid.js';\nimport { PIPELINE } from '../internal/constants.js';\nimport type { ColumnConfiguration, GridHost, Keys } from '../internal/types.js';\nimport { asArray, getFilterOperandsFor } from '../internal/utils.js';\nimport { FilterState } from '../operations/filter/state.js';\nimport type { FilterExpression } from '../operations/filter/types.js';\n\nexport class FilterController<T extends object> implements ReactiveController {\n  constructor(protected host: GridHost<T>) {\n    this.host.addController(this);\n  }\n\n  public state: FilterState<T> = new FilterState();\n\n  public get filterRow() {\n    // @ts-expect-error - protected access\n    return this.host.filterRow;\n  }\n\n  get #virtualizer() {\n    // @ts-expect-error - protected access\n    return this.host.scrollContainer;\n  }\n\n  #emitFilteringEvent(expression: FilterExpression<T>, type: 'add' | 'modify' | 'remove') {\n    return this.host.emitEvent('filtering', {\n      detail: {\n        key: expression.key,\n        expressions: [expression],\n        type,\n      },\n      cancelable: true,\n    });\n  }\n\n  #emitFilteredEvent(detail?: ApexFilteredEvent<T>) {\n    return this.host.emitEvent('filtered', { detail });\n  }\n\n  #filter(expression: FilterExpression<T> | FilterExpression<T>[]) {\n    for (const expr of asArray(expression)) {\n      this.state.set(expr);\n    }\n\n    // HACK: In the case where the scrollTop is a large and amount and a big chunk of data is filtered out\n    // HACK: the virtualizer can't recalculate its scroll position correctly. Thus, we reset the scrollTop state.\n    this.#virtualizer?.scrollTo({ top: 0 });\n    this.host.requestUpdate(PIPELINE);\n  }\n\n  public hostConnected() {}\n\n  public hostUpdate(): void {\n    this.filterRow?.requestUpdate();\n  }\n\n  public get(key: Keys<T>) {\n    return this.state.get(key);\n  }\n\n  public reset(key?: Keys<T>) {\n    key ? this.state.delete(key) : this.state.clear();\n  }\n\n  public setActiveColumn(column?: ColumnConfiguration<T>, triggerRect?: DOMRect) {\n    const filterRow = this.filterRow;\n    if (!filterRow) return;\n\n    if (!column?.filter) {\n      filterRow.active = false;\n      return;\n    }\n\n    // Toggle: clicking the same column's filter while the panel is open closes it.\n    if (filterRow.active && filterRow.column?.key === column.key) {\n      filterRow.active = false;\n      return;\n    }\n\n    filterRow.triggerRect = triggerRect ?? null;\n    filterRow.column = column;\n    filterRow.expression = this.getDefaultExpression(column);\n    filterRow.active = true;\n    this.host.requestUpdate();\n  }\n\n  public getDefaultExpression(column: ColumnConfiguration<T>) {\n    const caseSensitive =\n      typeof column.filter === 'boolean' ? false : Boolean(column.filter?.caseSensitive);\n    const operands = getFilterOperandsFor(column);\n    const keys = Object.keys(operands) as Keys<typeof operands>[];\n\n    // XXX: Types\n    return {\n      key: column.key,\n      condition: operands[keys[0]],\n      caseSensitive,\n    } as unknown as FilterExpression<T>;\n  }\n\n  public async removeAllExpressions(key: Keys<T>) {\n    const state = this.get(key)?.all ?? [];\n\n    if (\n      !this.host.emitEvent('filtering', {\n        detail: {\n          key,\n          expressions: state,\n          type: 'remove',\n        },\n        cancelable: true,\n      })\n    ) {\n      return;\n    }\n\n    this.reset(key);\n    this.#filter([]);\n\n    await this.host.updateComplete;\n    this.#announce(key, 'cleared');\n    this.#emitFilteredEvent({ key, state: this.get(key)?.all ?? [] });\n  }\n\n  public async removeExpression(expression: FilterExpression<T>) {\n    const state = this.get(expression.key);\n\n    if (!this.#emitFilteringEvent(expression, 'remove')) {\n      return;\n    }\n\n    state?.remove(expression);\n\n    if (state?.empty) {\n      this.reset(state.key);\n    }\n\n    this.#filter([]);\n\n    await this.host.updateComplete;\n    this.#announce(expression.key, 'cleared');\n    this.#emitFilteredEvent({ key: expression.key, state: state?.all ?? [] });\n  }\n\n  public async filterWithEvent(expression: FilterExpression<T>, type: 'add' | 'modify' | 'remove') {\n    if (!this.#emitFilteringEvent(expression, type)) {\n      return;\n    }\n\n    this.#filter(expression);\n\n    await this.host.updateComplete;\n    // Announce only on `add`: `modify` fires per keystroke while typing a\n    // filter value and would flood the live region.\n    if (type === 'add') this.#announce(expression.key, 'applied');\n    this.#emitFilteredEvent({ key: expression.key, state: this.get(expression.key)?.all ?? [] });\n  }\n\n  #announce(key: Keys<T>, kind: 'applied' | 'cleared') {\n    const column = this.host.getColumn(key);\n    const label = column?.headerText ?? String(key);\n    this.host.announce(\n      this.host.localize(kind === 'applied' ? 'announce.filtered' : 'announce.filterCleared', {\n        label,\n      })\n    );\n  }\n\n  public filter(expression: FilterExpression<T> | FilterExpression<T>[]) {\n    this.#filter(\n      asArray(expression).map((expr) =>\n        Object.assign(this.getDefaultExpression(this.host.getColumn(expr.key)!), expr)\n      )\n    );\n  }\n}\n"]}
+{"version":3,"file":"filter.js","sourceRoot":"","sources":["../../src/controllers/filter.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAEpD,OAAO,EAAE,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AACrE,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAG5D,MAAM,OAAO,gBAAgB;IAC3B,YAAsB,IAAiB;QAAjB,SAAI,GAAJ,IAAI,CAAa;QAIhC,UAAK,GAAmB,IAAI,WAAW,EAAE,CAAC;QAgCjD,aAAQ,GAAc,EAAE,CAAC;QAEzB,aAAQ,GAAG,KAAK,CAAC;QArCf,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAID,IAAW,SAAS;QAElB,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC;IAC7B,CAAC;IAED,mBAAmB,CAAC,UAA+B,EAAE,IAAiC;QACpF,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE;YACtC,MAAM,EAAE;gBACN,GAAG,EAAE,UAAU,CAAC,GAAG;gBACnB,WAAW,EAAE,CAAC,UAAU,CAAC;gBACzB,IAAI;aACL;YACD,UAAU,EAAE,IAAI;SACjB,CAAC,CAAC;IACL,CAAC;IAED,kBAAkB,CAAC,MAA6B;QAC9C,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACrD,CAAC;IAED,OAAO,CAAC,UAAuD;QAC7D,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;YACvC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACvB,CAAC;QAED,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;IAGD,QAAQ,CAAiB;IAEzB,QAAQ,CAAS;IAEV,aAAa,KAAI,CAAC;IAElB,UAAU;QACf,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;YACtB,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAOlC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC;gBAAE,IAAI,CAAC,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;YAC9D,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACvB,CAAC;QACD,IAAI,CAAC,SAAS,EAAE,aAAa,EAAE,CAAC;IAClC,CAAC;IAEM,GAAG,CAAC,GAAY;QACrB,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;IAEM,KAAK,CAAC,GAAa;QACxB,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QAClD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IACvB,CAAC;IAEM,eAAe,CAAC,MAA+B,EAAE,WAAqB;QAC3E,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,SAAS;YAAE,OAAO;QAEvB,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC;YACpB,SAAS,CAAC,MAAM,GAAG,KAAK,CAAC;YACzB,OAAO;QACT,CAAC;QAGD,IAAI,SAAS,CAAC,MAAM,IAAI,SAAS,CAAC,MAAM,EAAE,GAAG,KAAK,MAAM,CAAC,GAAG,EAAE,CAAC;YAC7D,SAAS,CAAC,MAAM,GAAG,KAAK,CAAC;YACzB,OAAO;QACT,CAAC;QAED,SAAS,CAAC,WAAW,GAAG,WAAW,IAAI,IAAI,CAAC;QAC5C,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC;QAC1B,SAAS,CAAC,UAAU,GAAG,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;QACzD,SAAS,CAAC,MAAM,GAAG,IAAI,CAAC;QACxB,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;IAC5B,CAAC;IAEM,oBAAoB,CAAC,MAA8B;QACxD,MAAM,aAAa,GACjB,OAAO,MAAM,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;QACrF,MAAM,QAAQ,GAAG,oBAAoB,CAAC,MAAM,CAAC,CAAC;QAC9C,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAA4B,CAAC;QAG9D,OAAO;YACL,GAAG,EAAE,MAAM,CAAC,GAAG;YACf,SAAS,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC5B,aAAa;SACoB,CAAC;IACtC,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAC,GAAY;QAE5C,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,OAAO;QACjC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC;QAEvC,IACE,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE;YAChC,MAAM,EAAE;gBACN,GAAG;gBACH,WAAW,EAAE,KAAK;gBAClB,IAAI,EAAE,QAAQ;aACf;YACD,UAAU,EAAE,IAAI;SACjB,CAAC,EACF,CAAC;YACD,OAAO;QACT,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAChB,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAGjB,MAAM,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;QAClC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAC/B,IAAI,CAAC,kBAAkB,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC,CAAC;IACpE,CAAC;IAGM,KAAK,CAAC,gBAAgB,CAAC,UAA+B;QAC3D,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAEvC,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,UAAU,CAAC;YAAE,OAAO,KAAK,CAAC;QAE1C,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,UAAU,EAAE,QAAQ,CAAC,EAAE,CAAC;YACpD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAEzB,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;YAChB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACxB,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAGjB,MAAM,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;QAClC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAC1C,IAAI,CAAC,kBAAkB,CAAC,EAAE,GAAG,EAAE,UAAU,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC;QACnE,OAAO,IAAI,CAAC;IACd,CAAC;IASM,KAAK,CAAC,eAAe,CAC1B,UAA+B,EAC/B,IAAiC,EACjC,MAAM,GAAG,UAAU;QAEnB,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,UAAU,EAAE,IAAI,CAAC,EAAE,CAAC;YAChD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC;QAGhD,MAAM,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;QAGlC,IAAI,IAAI,KAAK,KAAK;YAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAC1D,IAAI,CAAC,kBAAkB,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC,CAAC;QACrF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,SAAS,CAAC,GAAY,EAAE,IAA2B;QACjD,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QACxC,MAAM,KAAK,GAAG,MAAM,EAAE,UAAU,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC;QAChD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAChB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,wBAAwB,EAAE;YACtF,KAAK;SACN,CAAC,CACH,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,UAAuD;QACnE,IAAI,CAAC,OAAO,CACV,OAAO,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YAC/B,MAAM,QAAQ,GAAG,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAE,CAAC,CAAC;YAI3E,OAAO,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,EAAE;gBACnC,SAAS,EAAE,IAAI,CAAC,SAAS,IAAI,QAAQ,CAAC,SAAS;gBAC/C,aAAa,EAAE,IAAI,CAAC,aAAa,IAAI,QAAQ,CAAC,aAAa;aAC5D,CAAC,CAAC;QACL,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;CACF;AAOD,SAAS,QAAQ,CAAI,KAAqB;IACxC,MAAM,GAAG,GAAc,EAAE,CAAC;IAC1B,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QAChC,KAAK,MAAM,CAAC,IAAI,IAAI;YAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,aAAa,CAAC,CAAC;IAChG,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,UAAU,CAAC,CAAY,EAAE,CAAY;IAC5C,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM;QAAE,OAAO,KAAK,CAAC;IACxC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAClC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACf,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACf,IAAI,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;YAAE,SAAS;QAC9B,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,OAAO,EAAE;YAAE,SAAS;QAEpF,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC;YAAE,SAAS;QACvE,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC","sourcesContent":["import type { ReactiveController } from 'lit';\nimport type { ApexFilteredEvent } from '../components/grid.js';\nimport { PIPELINE } from '../internal/constants.js';\nimport type { ColumnConfiguration, GridHost, Keys } from '../internal/types.js';\nimport { asArray, getFilterOperandsFor } from '../internal/utils.js';\nimport { FilterState } from '../operations/filter/state.js';\nimport type { FilterExpression } from '../operations/filter/types.js';\n\nexport class FilterController<T extends object> implements ReactiveController {\n  constructor(protected host: GridHost<T>) {\n    this.host.addController(this);\n  }\n\n  public state: FilterState<T> = new FilterState();\n\n  public get filterRow() {\n    // @ts-expect-error - protected access\n    return this.host.filterRow;\n  }\n\n  #emitFilteringEvent(expression: FilterExpression<T>, type: 'add' | 'modify' | 'remove') {\n    return this.host.emitEvent('filtering', {\n      detail: {\n        key: expression.key,\n        expressions: [expression],\n        type,\n      },\n      cancelable: true,\n    });\n  }\n\n  #emitFilteredEvent(detail?: ApexFilteredEvent<T>) {\n    return this.host.emitEvent('filtered', { detail });\n  }\n\n  #filter(expression: FilterExpression<T> | FilterExpression<T>[]) {\n    for (const expr of asArray(expression)) {\n      this.state.set(expr);\n    }\n\n    this.#touched = true;\n    this.host.requestUpdate(PIPELINE);\n  }\n\n  /** The filter as of the last host update, to tell a change from a reapply. */\n  #applied: unknown[] = [];\n  /** Set by every write to the filter state; checked at the next update. */\n  #touched = false;\n\n  public hostConnected() {}\n\n  public hostUpdate(): void {\n    if (this.#touched) {\n      this.#touched = false;\n      const next = snapshot(this.state);\n      // A changed match set starts at its first row. The grid host owns\n      // vertical scrolling (the virtualizer is not a scroller), so reset it\n      // there; left alone, a deep offset is clamped to the end of a shorter\n      // result. Reapplying the same filter (setState(getState()), or a\n      // wrapper that assigns filterExpressions on every render) keeps the\n      // position.\n      if (!sameFilter(this.#applied, next)) this.host.scrollTop = 0;\n      this.#applied = next;\n    }\n    this.filterRow?.requestUpdate();\n  }\n\n  public get(key: Keys<T>) {\n    return this.state.get(key);\n  }\n\n  public reset(key?: Keys<T>) {\n    key ? this.state.delete(key) : this.state.clear();\n    this.#touched = true;\n  }\n\n  public setActiveColumn(column?: ColumnConfiguration<T>, triggerRect?: DOMRect) {\n    const filterRow = this.filterRow;\n    if (!filterRow) return;\n\n    if (!column?.filter) {\n      filterRow.active = false;\n      return;\n    }\n\n    // Toggle: clicking the same column's filter while the panel is open closes it.\n    if (filterRow.active && filterRow.column?.key === column.key) {\n      filterRow.active = false;\n      return;\n    }\n\n    filterRow.triggerRect = triggerRect ?? null;\n    filterRow.column = column;\n    filterRow.expression = this.getDefaultExpression(column);\n    filterRow.active = true;\n    this.host.requestUpdate();\n  }\n\n  public getDefaultExpression(column: ColumnConfiguration<T>) {\n    const caseSensitive =\n      typeof column.filter === 'boolean' ? false : Boolean(column.filter?.caseSensitive);\n    const operands = getFilterOperandsFor(column);\n    const keys = Object.keys(operands) as Keys<typeof operands>[];\n\n    // XXX: Types\n    return {\n      key: column.key,\n      condition: operands[keys[0]],\n      caseSensitive,\n    } as unknown as FilterExpression<T>;\n  }\n\n  public async removeAllExpressions(key: Keys<T>) {\n    // Nothing to clear: no events and no announcement.\n    if (!this.state.has(key)) return;\n    const state = this.get(key)?.all ?? [];\n\n    if (\n      !this.host.emitEvent('filtering', {\n        detail: {\n          key,\n          expressions: state,\n          type: 'remove',\n        },\n        cancelable: true,\n      })\n    ) {\n      return;\n    }\n\n    this.reset(key);\n    this.#filter([]);\n\n    // @ts-expect-error - protected member access\n    await this.host.pipelineSettled();\n    this.#announce(key, 'cleared');\n    this.#emitFilteredEvent({ key, state: this.get(key)?.all ?? [] });\n  }\n\n  /** Resolves to false when nothing was removed (not applied, or cancelled). */\n  public async removeExpression(expression: FilterExpression<T>) {\n    const state = this.get(expression.key);\n    // An expression that was never applied (the panel's draft) is a no-op.\n    if (!state?.has(expression)) return false;\n\n    if (!this.#emitFilteringEvent(expression, 'remove')) {\n      return false;\n    }\n\n    state.remove(expression);\n\n    if (state.empty) {\n      this.reset(state.key);\n    }\n\n    this.#filter([]);\n\n    // @ts-expect-error - protected member access\n    await this.host.pipelineSettled();\n    this.#announce(expression.key, 'cleared');\n    this.#emitFilteredEvent({ key: expression.key, state: state.all });\n    return true;\n  }\n\n  /**\n   * Emits the cancelable `filtering` event for `expression` and applies it\n   * when the event passes. With a `target` (the panel's draft or an applied\n   * expression), `expression` is the proposed copy: it is written into\n   * `target` only after the event passes, so a cancelled change leaves the\n   * applied filter untouched. Resolves to false when cancelled.\n   */\n  public async filterWithEvent(\n    expression: FilterExpression<T>,\n    type: 'add' | 'modify' | 'remove',\n    target = expression\n  ) {\n    if (!this.#emitFilteringEvent(expression, type)) {\n      return false;\n    }\n\n    this.#filter(Object.assign(target, expression));\n\n    // @ts-expect-error - protected member access\n    await this.host.pipelineSettled();\n    // Announce only on `add`: `modify` fires per keystroke while typing a\n    // filter value and would flood the live region.\n    if (type === 'add') this.#announce(target.key, 'applied');\n    this.#emitFilteredEvent({ key: target.key, state: this.get(target.key)?.all ?? [] });\n    return true;\n  }\n\n  #announce(key: Keys<T>, kind: 'applied' | 'cleared') {\n    const column = this.host.getColumn(key);\n    const label = column?.headerText ?? String(key);\n    this.host.announce(\n      this.host.localize(kind === 'applied' ? 'announce.filtered' : 'announce.filterCleared', {\n        label,\n      })\n    );\n  }\n\n  public filter(expression: FilterExpression<T> | FilterExpression<T>[]) {\n    this.#filter(\n      asArray(expression).map((expr) => {\n        const defaults = this.getDefaultExpression(this.host.getColumn(expr.key)!);\n        // An omitted or undefined field keeps the column default, so a\n        // caseSensitive: undefined from setState or an AI patch inherits the\n        // column's filter.caseSensitive instead of overriding it.\n        return Object.assign(defaults, expr, {\n          condition: expr.condition ?? defaults.condition,\n          caseSensitive: expr.caseSensitive ?? defaults.caseSensitive,\n        });\n      })\n    );\n  }\n}\n\n/**\n * The parts of every applied expression that decide the match set, flattened\n * in state order. Values are captured, so a later in-place edit of an\n * expression (the filter panel's draft) still reads as a change.\n */\nfunction snapshot<T>(state: FilterState<T>): unknown[] {\n  const out: unknown[] = [];\n  for (const tree of state.values) {\n    for (const e of tree) out.push(e.key, e.condition, e.searchTerm, e.criteria, e.caseSensitive);\n  }\n  return out;\n}\n\nfunction sameFilter(a: unknown[], b: unknown[]): boolean {\n  if (a.length !== b.length) return false;\n  for (let i = 0; i < a.length; i++) {\n    const x = a[i];\n    const y = b[i];\n    if (Object.is(x, y)) continue;\n    if (x instanceof Date && y instanceof Date && x.getTime() === y.getTime()) continue;\n    // Array terms (a set filter's values) are copied by getState and setState.\n    if (Array.isArray(x) && Array.isArray(y) && sameFilter(x, y)) continue;\n    return false;\n  }\n  return true;\n}\n"]}

package/controllers/history.d.ts

@@ -2,8 +2,8 @@ import type { ReactiveController } from 'lit';
 import type { GridHost, Keys } from '../internal/types.js';
 /**
  * A single recorded cell mutation: the record reference, its column, and the
- * before / after values. `rowIndex` is the view-relative index at record time
- * and is used only for the replayed `cellValueChanged` event (the live record
+ * before / after values. `rowIndex` is the view-relative index at record time;
+ * replay reports the record's index at replay time instead (the live record
  * reference is authoritative).
  */
 export interface CellChange<T extends object> {
@@ -24,20 +24,38 @@ export interface CellChange<T extends object> {
 export interface EditCommand {
     apply(): void;
     revert(): void;
+    /** The record the command acts on: history is cleared once a reload drops it. */
+    readonly record?: object;
+    /**
+     * For a command staged with a row edit: the value to stage for its cell,
+     * re-read from the row's staged values just before the row commits, so
+     * validation judges what the command will leave there.
+     */
+    stagedValue?(staged: ReadonlyMap<PropertyKey, unknown>): unknown;
 }
 /**
  * One or more cell mutations that undo / redo as a single step. A single-cell
  * edit holds one change; a row-mode commit or a bulk paste / fill holds many so
- * one Ctrl+Z reverts the whole batch.
+ * one Ctrl+Z reverts the whole batch. `commands` are other commands pushed in
+ * the same batch (a feature's state riding with the edit, such as a formula):
+ * they replay after the cell values in both directions, so a value write can
+ * never undo the state they restore.
  */
 export declare class CellEditCommand<T extends object> implements EditCommand {
     #private;
     private host;
     readonly changes: ReadonlyArray<CellChange<T>>;
-    constructor(host: GridHost<T>, changes: ReadonlyArray<CellChange<T>>);
+    readonly commands: ReadonlyArray<EditCommand>;
+    constructor(host: GridHost<T>, changes: ReadonlyArray<CellChange<T>>, commands?: ReadonlyArray<EditCommand>);
     apply(): void;
     revert(): void;
 }
+/**
+ * Returns a lookup of a record's index in `items` (by reference, `-1` when
+ * absent). For more than one lookup it indexes `items` once, so a large batch
+ * costs one pass instead of one scan per record.
+ */
+export declare function viewIndexer<T>(items: ReadonlyArray<T>, lookups: number): (record: T) => number;
 /**
  * Reactive controller owning the undo / redo stacks for cell-data edits.
  *
@@ -67,20 +85,39 @@ export declare class HistoryController<T extends object> implements ReactiveCont
      * disabled.
      */
     record(change: CellChange<T>): void;
+    /**
+     * Records a command that is not a plain cell write (its first `apply` has
+     * already run). Joins the open batch, replaying after the batch's cell
+     * changes, otherwise pushed as its own step. No-op when history is disabled.
+     */
+    push(command: EditCommand): void;
     /**
      * Opens a batch so subsequent {@link record} calls coalesce into one command.
-     * Nestable calls are flattened (the outermost {@link endBatch} commits).
+     * Nested calls are flattened: a batch opened while another is open (a
+     * `cellValueChanged` listener that calls `applyEdits`, say) joins it, and
+     * only the outermost {@link endBatch} commits. Counted even while history
+     * is disabled, so every begin pairs with its end.
      */
     beginBatch(): void;
     /**
-     * Closes the open batch, pushing it as a single command when it captured any
-     * changes.
+     * Closes the innermost open batch. Closing the outermost pushes everything
+     * it captured as a single command.
      */
     endBatch(): void;
     /** Reverts the most recent command. No-op when the undo stack is empty. */
     undo(): void;
     /** Re-applies the most recently undone command. No-op when nothing to redo. */
     redo(): void;
-    /** Clears both stacks (e.g. after a data reset). */
+    /** Clears both stacks, and the changes an open batch has captured so far. */
     clear(): void;
+    /**
+     * Clears both stacks when the grid's data was replaced and a recorded change
+     * (or a command's {@link EditCommand.record}) names a record that `records`
+     * no longer yields (a reload with new objects).
+     * Replaying onto such a detached record would change nothing on screen while
+     * still reporting the edit. New data that keeps the edited records (an
+     * append, a re-sorted copy) keeps its history. `records` is read only while
+     * a stack has entries, so the caller may pass an expensive source.
+     */
+    reconcile(records: () => Iterable<T>): void;
 }

package/controllers/history.js

@@ -1,37 +1,53 @@
 import { PIPELINE } from '../internal/constants.js';
 const DEFAULT_STACK_SIZE = 100;
 export class CellEditCommand {
-    constructor(host, changes) {
+    constructor(host, changes, commands = []) {
         this.host = host;
         this.changes = changes;
+        this.commands = commands;
     }
     apply() {
+        const indexOf = viewIndexer(this.host.pageItems, this.changes.length);
         for (const change of this.changes) {
-            this.#write(change, change.newValue);
+            this.#write(change, change.newValue, indexOf);
         }
+        for (const command of this.commands)
+            command.apply();
     }
     revert() {
+        const indexOf = viewIndexer(this.host.pageItems, this.changes.length);
         for (let i = this.changes.length - 1; i >= 0; i -= 1) {
-            this.#write(this.changes[i], this.changes[i].oldValue);
+            this.#write(this.changes[i], this.changes[i].oldValue, indexOf);
         }
+        for (let i = this.commands.length - 1; i >= 0; i -= 1)
+            this.commands[i].revert();
     }
-    #write(change, value) {
+    #write(change, value, indexOf) {
         change.record[change.key] = value;
-        const liveIndex = this.host.pageItems.indexOf(change.record);
         this.host.emitEvent('cellValueChanged', {
-            detail: {
-                key: change.key,
-                rowIndex: liveIndex >= 0 ? liveIndex : change.rowIndex,
-                data: change.record,
-                value,
-            },
+            detail: { key: change.key, rowIndex: indexOf(change.record), data: change.record, value },
         });
     }
 }
+export function viewIndexer(items, lookups) {
+    if (lookups < 2)
+        return (record) => items.indexOf(record);
+    let index;
+    return (record) => {
+        if (!index) {
+            index = new Map();
+            for (let i = items.length - 1; i >= 0; i -= 1)
+                index.set(items[i], i);
+        }
+        return index.get(record) ?? -1;
+    };
+}
 export class HistoryController {
     #undo = [];
     #redo = [];
-    #batch = null;
+    #batch = [];
+    #commands = [];
+    #depth = 0;
     constructor(host) {
         this.host = host;
         this.host.addController(this);
@@ -53,22 +69,32 @@ export class HistoryController {
     record(change) {
         if (!this.enabled)
             return;
-        if (this.#batch) {
+        if (this.#depth > 0) {
             this.#batch.push(change);
             return;
         }
         this.#push(new CellEditCommand(this.host, [change]));
     }
-    beginBatch() {
+    push(command) {
         if (!this.enabled)
             return;
-        this.#batch ??= [];
+        if (this.#depth > 0)
+            this.#commands.push(command);
+        else
+            this.#push(command);
+    }
+    beginBatch() {
+        this.#depth += 1;
     }
     endBatch() {
+        if (this.#depth === 0 || --this.#depth > 0)
+            return;
         const batch = this.#batch;
-        this.#batch = null;
-        if (batch && batch.length > 0) {
-            this.#push(new CellEditCommand(this.host, batch));
+        const commands = this.#commands;
+        this.#batch = [];
+        this.#commands = [];
+        if (batch.length > 0 || commands.length > 0) {
+            this.#push(new CellEditCommand(this.host, batch, commands));
         }
     }
     undo() {
@@ -88,13 +114,25 @@ export class HistoryController {
         this.#afterReplay(command, 'redo');
     }
     clear() {
+        this.#batch = [];
+        this.#commands = [];
         if (this.#undo.length === 0 && this.#redo.length === 0)
             return;
         this.#undo = [];
         this.#redo = [];
-        this.#batch = null;
         this.#emitChanged();
     }
+    reconcile(records) {
+        if (this.#undo.length === 0 && this.#redo.length === 0)
+            return;
+        const live = new Set(records());
+        const stale = (command) => (command.record !== undefined && !live.has(command.record)) ||
+            (command instanceof CellEditCommand &&
+                (command.changes.some((change) => !live.has(change.record)) ||
+                    command.commands.some(stale)));
+        if (this.#undo.some(stale) || this.#redo.some(stale))
+            this.clear();
+    }
     #push(command) {
         this.#undo.push(command);
         this.#redo = [];
@@ -105,7 +143,7 @@ export class HistoryController {
     }
     #afterReplay(command, kind) {
         this.host.requestUpdate(PIPELINE);
-        const count = command instanceof CellEditCommand ? command.changes.length : 1;
+        const count = command instanceof CellEditCommand ? command.changes.length || 1 : 1;
         const key = kind === 'undo'
             ? count === 1
                 ? 'announce.undoOne'