@toolbox-web/grid 1.6.2 → 1.8.0

package/lib/plugins/export/index.js

@@ -149,6 +149,63 @@ class C {
     const n = new CustomEvent(e, { detail: t, bubbles: !0, cancelable: !0 });
     return this.grid?.dispatchEvent?.(n), n.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,45 +368,45 @@ class C {
   }
   // #endregion
 }
-function b(i, e = !0) {
-  if (i == null) return "";
-  if (i instanceof Date) return i.toISOString();
-  if (typeof i == "object") return JSON.stringify(i);
-  const t = String(i);
+function b(o, e = !0) {
+  if (o == null) return "";
+  if (o instanceof Date) return o.toISOString();
+  if (typeof o == "object") return JSON.stringify(o);
+  const t = String(o);
   return e && (t.includes(",") || t.includes('"') || t.includes(`
 `) || t.includes("\r")) ? `"${t.replace(/"/g, '""')}"` : t;
 }
-function E(i, e, t, n = {}) {
+function E(o, e, t, n = {}) {
   const c = n.delimiter ?? ",", l = n.newline ?? `
-`, o = [], r = n.bom ? "\uFEFF" : "";
+`, i = [], r = n.bom ? "\uFEFF" : "";
   if (t.includeHeaders !== !1) {
     const s = e.map((a) => {
       const d = a.header || a.field, u = t.processHeader ? t.processHeader(d, a.field) : d;
       return b(u);
     });
-    o.push(s.join(c));
+    i.push(s.join(c));
   }
-  for (const s of i) {
+  for (const s of o) {
     const a = e.map((d) => {
       let u = s[d.field];
       return t.processCell && (u = t.processCell(u, d.field, s)), b(u);
     });
-    o.push(a.join(c));
+    i.push(a.join(c));
   }
-  return r + o.join(l);
+  return r + i.join(l);
 }
-function h(i, e) {
-  const t = URL.createObjectURL(i), n = document.createElement("a");
+function h(o, e) {
+  const t = URL.createObjectURL(o), n = document.createElement("a");
   n.href = t, n.download = e, n.style.display = "none", document.body.appendChild(n), n.click(), document.body.removeChild(n), URL.revokeObjectURL(t);
 }
-function S(i, e) {
-  const t = new Blob([i], { type: "text/csv;charset=utf-8;" });
+function S(o, e) {
+  const t = new Blob([o], { type: "text/csv;charset=utf-8;" });
   h(t, e);
 }
-function w(i) {
-  return i.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&apos;");
+function w(o) {
+  return o.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&apos;");
 }
-function y(i, e, t) {
+function v(o, e, t) {
   let n = `<?xml version="1.0" encoding="UTF-8"?>
 <?mso-application progid="Excel.Sheet"?>
 <Workbook xmlns="urn:schemas-microsoft-com:office:spreadsheet"
@@ -360,19 +417,19 @@ function y(i, e, t) {
     n += `
 <Row>`;
     for (const c of e) {
-      const l = c.header || c.field, o = t.processHeader ? t.processHeader(l, c.field) : l;
-      n += `<Cell><Data ss:Type="String">${w(o)}</Data></Cell>`;
+      const l = c.header || c.field, i = t.processHeader ? t.processHeader(l, c.field) : l;
+      n += `<Cell><Data ss:Type="String">${w(i)}</Data></Cell>`;
     }
     n += "</Row>";
   }
-  for (const c of i) {
+  for (const c of o) {
     n += `
 <Row>`;
     for (const l of e) {
-      let o = c[l.field];
-      t.processCell && (o = t.processCell(o, l.field, c));
+      let i = c[l.field];
+      t.processCell && (i = t.processCell(i, l.field, c));
       let r = "String", s = "";
-      o == null ? s = "" : typeof o == "number" && !isNaN(o) ? (r = "Number", s = String(o)) : o instanceof Date ? (r = "DateTime", s = o.toISOString()) : s = w(String(o)), n += `<Cell><Data ss:Type="${r}">${s}</Data></Cell>`;
+      i == null ? s = "" : typeof i == "number" && !isNaN(i) ? (r = "Number", s = String(i)) : i instanceof Date ? (r = "DateTime", s = i.toISOString()) : s = w(String(i)), n += `<Cell><Data ss:Type="${r}">${s}</Data></Cell>`;
     }
     n += "</Row>";
   }
@@ -381,8 +438,8 @@ function y(i, e, t) {
 </Worksheet>
 </Workbook>`, n;
 }
-function v(i, e) {
-  const t = e.endsWith(".xls") ? e : `${e}.xls`, n = new Blob([i], {
+function y(o, e) {
+  const t = e.endsWith(".xls") ? e : `${e}.xls`, n = new Blob([o], {
     type: "application/vnd.ms-excel;charset=utf-8;"
   });
   h(n, t);
@@ -419,27 +476,27 @@ class I extends C {
       const s = new Set(t.columns);
       l = l.filter((a) => s.has(a.field));
     }
-    let o = [...this.rows];
+    let i = [...this.rows];
     if (n.onlySelected) {
       const s = this.getSelectionState();
-      s?.selected?.size && (o = [...s.selected].sort((d, u) => d - u).map((d) => this.rows[d]).filter(Boolean));
+      s?.selected?.size && (i = [...s.selected].sort((d, u) => d - u).map((d) => this.rows[d]).filter(Boolean));
     }
-    t?.rowIndices && (o = t.rowIndices.map((s) => this.rows[s]).filter(Boolean)), this.isExportingFlag = !0;
+    t?.rowIndices && (i = t.rowIndices.map((s) => this.rows[s]).filter(Boolean)), this.isExportingFlag = !0;
     let r = c.fileName;
     try {
       switch (e) {
         case "csv": {
-          const s = E(o, l, c, { bom: !0 });
+          const s = E(i, l, c, { bom: !0 });
           r = r.endsWith(".csv") ? r : `${r}.csv`, S(s, r);
           break;
         }
         case "excel": {
-          const s = y(o, l, c);
-          r = r.endsWith(".xls") ? r : `${r}.xls`, v(s, r);
+          const s = v(i, l, c);
+          r = r.endsWith(".xls") ? r : `${r}.xls`, y(s, r);
           break;
         }
         case "json": {
-          const s = o.map((u) => {
+          const s = i.map((u) => {
             const p = {};
             for (const f of l) {
               let g = u[f.field];
@@ -456,7 +513,7 @@ class I extends C {
       this.lastExportInfo = { format: e, timestamp: /* @__PURE__ */ new Date() }, this.emit("export-complete", {
         format: e,
         fileName: r,
-        rowCount: o.length,
+        rowCount: i.length,
         columnCount: l.length
       });
     } finally {