@toolbox-web/grid 1.6.2 → 1.8.0

package/lib/plugins/server-side/index.js

@@ -149,6 +149,63 @@ class u {
     const o = new CustomEvent(e, { detail: t, bubbles: !0, cancelable: !0 });
     return this.grid?.dispatchEvent?.(o), o.defaultPrevented;
   }
+  // =========================================================================
+  // Event Bus - Plugin-to-Plugin Communication
+  // =========================================================================
+  /**
+   * Subscribe to an event from another plugin.
+   * The subscription is automatically cleaned up when this plugin is detached.
+   *
+   * @category Plugin Development
+   * @param eventType - The event type to listen for (e.g., 'filter-change')
+   * @param callback - The callback to invoke when the event is emitted
+   *
+   * @example
+   * ```typescript
+   * // In attach() or other initialization
+   * this.on('filter-change', (detail) => {
+   *   console.log('Filter changed:', detail);
+   * });
+   * ```
+   */
+  on(e, t) {
+    this.grid?._pluginManager?.subscribe(this, e, t);
+  }
+  /**
+   * Unsubscribe from a plugin event.
+   *
+   * @category Plugin Development
+   * @param eventType - The event type to stop listening for
+   *
+   * @example
+   * ```typescript
+   * this.off('filter-change');
+   * ```
+   */
+  off(e) {
+    this.grid?._pluginManager?.unsubscribe(this, e);
+  }
+  /**
+   * Emit an event to other plugins via the Event Bus.
+   * This is for inter-plugin communication only; it does NOT dispatch DOM events.
+   * Use `emit()` to dispatch DOM events that external consumers can listen to.
+   *
+   * @category Plugin Development
+   * @param eventType - The event type to emit (should be declared in manifest.events)
+   * @param detail - The event payload
+   *
+   * @example
+   * ```typescript
+   * // Emit to other plugins (not DOM)
+   * this.emitPluginEvent('filter-change', { field: 'name', value: 'Alice' });
+   *
+   * // For DOM events that consumers can addEventListener to:
+   * this.emit('filter-change', { field: 'name', value: 'Alice' });
+   * ```
+   */
+  emitPluginEvent(e, t) {
+    this.grid?._pluginManager?.emitPluginEvent(e, t);
+  }
   /**
    * Request a re-render of the grid.
    */
@@ -311,38 +368,38 @@ class u {
   }
   // #endregion
 }
-function l(s, e) {
-  return Math.floor(s / e);
+function l(i, e) {
+  return Math.floor(i / e);
 }
-function h(s, e) {
+function h(i, e) {
   return {
-    start: s * e,
-    end: (s + 1) * e
+    start: i * e,
+    end: (i + 1) * e
   };
 }
-function g(s, e, t) {
-  const o = l(s, t), r = l(e - 1, t), i = [];
+function g(i, e, t) {
+  const o = l(i, t), r = l(e - 1, t), s = [];
   for (let n = o; n <= r; n++)
-    i.push(n);
-  return i;
+    s.push(n);
+  return s;
 }
-async function a(s, e, t, o) {
+async function a(i, e, t, o) {
   const r = h(e, t);
-  return s.getRows({
+  return i.getRows({
     startRow: r.start,
     endRow: r.end,
     sortModel: o.sortModel,
     filterModel: o.filterModel
   });
 }
-function f(s, e, t) {
-  const o = l(s, e), r = t.get(o);
+function f(i, e, t) {
+  const o = l(i, e), r = t.get(o);
   if (!r) return;
-  const i = s % e;
-  return r[i];
+  const s = i % e;
+  return r[s];
 }
 const R = 100;
-class k extends u {
+class m extends u {
   /** @internal */
   name = "serverSide";
   /** @internal */
@@ -374,14 +431,14 @@ class k extends u {
   loadRequiredBlocks() {
     if (!this.dataSource) return;
     const e = this.grid, t = this.config.cacheBlockSize ?? 100, o = { startRow: e._virtualization.start, endRow: e._virtualization.end }, r = g(o.startRow, o.endRow, t);
-    for (const i of r)
-      if (!(this.loadedBlocks.has(i) || this.loadingBlocks.has(i))) {
+    for (const s of r)
+      if (!(this.loadedBlocks.has(s) || this.loadingBlocks.has(s))) {
         if (this.loadingBlocks.size >= (this.config.maxConcurrentRequests ?? 2))
           break;
-        this.loadingBlocks.add(i), a(this.dataSource, i, t, {}).then((n) => {
-          this.loadedBlocks.set(i, n.rows), this.totalRowCount = n.totalRowCount, this.loadingBlocks.delete(i), this.requestRender(), this.loadRequiredBlocks();
+        this.loadingBlocks.add(s), a(this.dataSource, s, t, {}).then((n) => {
+          this.loadedBlocks.set(s, n.rows), this.totalRowCount = n.totalRowCount, this.loadingBlocks.delete(s), this.requestRender(), this.loadRequiredBlocks();
         }).catch(() => {
-          this.loadingBlocks.delete(i);
+          this.loadingBlocks.delete(s);
         });
       }
   }
@@ -451,6 +508,6 @@ class k extends u {
   // #endregion
 }
 export {
-  k as ServerSidePlugin
+  m as ServerSidePlugin
 };
 //# sourceMappingURL=index.js.map