@toolbox-web/grid 0.3.3 → 0.4.1

package/lib/plugins/pivot/index.js

@@ -9,6 +9,22 @@ const E = {
   toolPanel: "☰"
 };
 class P {
+  /**
+   * Plugin dependencies - declare other plugins this one requires.
+   *
+   * Dependencies are validated when the plugin is attached.
+   * Required dependencies throw an error if missing.
+   * Optional dependencies log an info message if missing.
+   *
+   * @example
+   * ```typescript
+   * static readonly dependencies: PluginDependency[] = [
+   *   { name: 'editing', required: true, reason: 'Tracks cell edits for undo/redo' },
+   *   { name: 'selection', required: false, reason: 'Enables selection-based undo' },
+   * ];
+   * ```
+   */
+  static dependencies;
   /** Plugin version - override in subclass if needed */
   version = "1.0.0";
   /** CSS styles to inject into the grid's shadow DOM */
@@ -25,6 +41,12 @@ class P {
   config;
   /** User-provided configuration from constructor */
   userConfig;
+  /**
+   * Plugin-level AbortController for event listener cleanup.
+   * Created fresh in attach(), aborted in detach().
+   * This ensures event listeners are properly cleaned up when plugins are re-attached.
+   */
+  #e;
   /**
    * Default configuration - subclasses should override this getter.
    * Note: This must be a getter (not property initializer) for proper inheritance
@@ -39,19 +61,48 @@ class P {
   /**
    * Called when the plugin is attached to a grid.
    * Override to set up event listeners, initialize state, etc.
+   *
+   * @example
+   * ```ts
+   * attach(grid: GridElement): void {
+   *   super.attach(grid);
+   *   // Set up document-level listeners with auto-cleanup
+   *   document.addEventListener('keydown', this.handleEscape, {
+   *     signal: this.disconnectSignal
+   *   });
+   * }
+   * ```
    */
   attach(e) {
-    this.grid = e, this.config = { ...this.defaultConfig, ...this.userConfig };
+    this.#e?.abort(), this.#e = new AbortController(), this.grid = e, this.config = { ...this.defaultConfig, ...this.userConfig };
   }
   /**
    * Called when the plugin is detached from a grid.
    * Override to clean up event listeners, timers, etc.
+   *
+   * @example
+   * ```ts
+   * detach(): void {
+   *   // Clean up any state not handled by disconnectSignal
+   *   this.selectedRows.clear();
+   *   this.cache = null;
+   * }
+   * ```
    */
   detach() {
+    this.#e?.abort(), this.#e = void 0;
   }
   /**
    * Get another plugin instance from the same grid.
    * Use for inter-plugin communication.
+   *
+   * @example
+   * ```ts
+   * const selection = this.getPlugin(SelectionPlugin);
+   * if (selection) {
+   *   const selectedRows = selection.getSelectedRows();
+   * }
+   * ```
    */
   getPlugin(e) {
     return this.grid?.getPlugin(e);
@@ -125,7 +176,7 @@ class P {
    * document.addEventListener('keydown', handler, { signal: this.disconnectSignal });
    */
   get disconnectSignal() {
-    return this.grid?.disconnectSignal;
+    return this.#e?.signal ?? this.grid?.disconnectSignal;
   }
   /**
    * Get the grid-level icons configuration.
@@ -214,7 +265,7 @@ const m = {
   list() {
     return [...Object.keys(m), ...v.keys()];
   }
-}, A = {
+}, R = {
   sum: (i) => i.reduce((e, t) => e + t, 0),
   avg: (i) => i.length ? i.reduce((e, t) => e + t, 0) / i.length : 0,
   count: (i) => i.length,
@@ -224,7 +275,7 @@ const m = {
   last: (i) => i[i.length - 1] ?? 0
 };
 function N(i) {
-  return A[i] ?? A.sum;
+  return R[i] ?? R.sum;
 }
 h.register.bind(h);
 h.unregister.bind(h);
@@ -292,8 +343,8 @@ function L(i, e, t, o, n, r, s) {
   const l = e[0], d = e.slice(1), c = d.length > 0, p = M(i, l);
   for (const [u, g] of p) {
     const y = s ? `${s}|${u}` : u, F = T(g, t, o, n), k = _(F);
-    let R;
-    c && (R = L(
+    let A;
+    c && (A = L(
       g,
       d,
       t,
@@ -308,7 +359,7 @@ function L(i, e, t, o, n, r, s) {
       values: F,
       total: k,
       isGroup: c,
-      children: R,
+      children: A,
       rowCount: g.length
     });
   }