@toolbox-web/grid 0.3.3 → 0.4.1

package/lib/plugins/selection/index.js

@@ -17,6 +17,22 @@ const R = {
   toolPanel: "☰"
 };
 class C {
+  /**
+   * 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 */
@@ -33,6 +49,12 @@ class C {
   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.
+   */
+  #t;
   /**
    * Default configuration - subclasses should override this getter.
    * Note: This must be a getter (not property initializer) for proper inheritance
@@ -47,19 +69,48 @@ class C {
   /**
    * 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.#t?.abort(), this.#t = 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.#t?.abort(), this.#t = 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);
@@ -133,7 +184,7 @@ class C {
    * document.addEventListener('keydown', handler, { signal: this.disconnectSignal });
    */
   get disconnectSignal() {
-    return this.grid?.disconnectSignal;
+    return this.#t?.signal ?? this.grid?.disconnectSignal;
   }
   /**
    * Get the grid-level icons configuration.
@@ -190,14 +241,14 @@ function m(s) {
 function u(s) {
   return s.map(m);
 }
-function p(s, e, t) {
+function b(s, e, t) {
   const r = h(t);
   return s >= r.startRow && s <= r.endRow && e >= r.startCol && e <= r.endCol;
 }
 function f(s, e, t) {
-  return t.some((r) => p(s, e, r));
+  return t.some((r) => b(s, e, r));
 }
-function b(s) {
+function p(s) {
   const e = [], t = h(s);
   for (let r = t.startRow; r <= t.endRow; r++)
     for (let n = t.startCol; n <= t.endCol; n++)
@@ -207,7 +258,7 @@ function b(s) {
 function A(s) {
   const e = /* @__PURE__ */ new Map();
   for (const t of s)
-    for (const r of b(t))
+    for (const r of p(t))
       e.set(`${r.row},${r.col}`, r);
   return [...e.values()];
 }