@univerjs/sheets-ui 0.5.2 → 0.5.3-experimental.20250106-e3b7a39

package/lib/es/facade.js

@@ -1,11 +1,139 @@
-import { FUniver as b, toDisposable as i, ILogService as x, ICommandService as h, awaitTime as j, InterceptorEffectEnum as U, DisposableCollection as P, generateRandomId as D } from "@univerjs/core";
-import { IRenderManagerService as c, DeviceInputEventType as _, SHEET_VIEWPORT_KEY as B, sheetContentViewportKeys as T } from "@univerjs/engine-render";
-import { SHEET_VIEW_KEY as l, HoverManagerService as d, SetCellEditVisibleOperation as m, SheetScrollManagerService as v, ISheetSelectionRenderService as S, SheetSkeletonManagerService as C, ChangeZoomRatioCommand as W, SheetsScrollRenderController as F, DragManagerService as k, ISheetClipboardService as O, SheetCanvasPopManagerService as A, CellAlertManagerService as H, IMarkSelectionService as $ } from "@univerjs/sheets-ui";
-import { FSheetHooks as I, FWorkbook as R, FWorksheet as M, FPermission as f, FRange as y } from "@univerjs/sheets/facade";
-import { ISidebarService as V, IDialogService as N, KeyCode as w, ComponentManager as K } from "@univerjs/ui";
-import { filter as p } from "rxjs";
-import { SheetInterceptorService as L, INTERCEPTOR_POINT as Y, InterceptCellContentPriority as z } from "@univerjs/sheets";
-class Z extends b {
+import { FUniver as U, ICommandService as u, ILogService as b, toDisposable as s, awaitTime as H, InterceptorEffectEnum as N, FEventName as A, DisposableCollection as V, generateRandomId as $ } from "@univerjs/core";
+import { IRenderManagerService as c, DeviceInputEventType as I, SHEET_VIEWPORT_KEY as L, sheetContentViewportKeys as K } from "@univerjs/engine-render";
+import { SheetPasteShortKeyCommand as k, ISheetClipboardService as T, SHEET_VIEW_KEY as m, HoverManagerService as l, SetCellEditVisibleOperation as S, SheetScrollManagerService as f, ISheetSelectionRenderService as p, SheetSkeletonManagerService as _, ChangeZoomRatioCommand as Y, SheetsScrollRenderController as z, DragManagerService as P, SheetCanvasPopManagerService as X, CellAlertManagerService as Z, IMarkSelectionService as J } from "@univerjs/sheets-ui";
+import { FSheetHooks as w, FWorkbook as D, FWorksheet as W, FPermission as F, FRange as O } from "@univerjs/sheets/facade";
+import { CutCommand as E, CopyCommand as y, PasteCommand as M, IClipboardInterfaceService as q, PLAIN_TEXT_CLIPBOARD_MIME_TYPE as R, HTML_CLIPBOARD_MIME_TYPE as x, supportClipboardAPI as j, ISidebarService as G, IDialogService as Q, KeyCode as B, ComponentManager as ee } from "@univerjs/ui";
+import { filter as v } from "rxjs";
+import { SheetInterceptorService as te, INTERCEPTOR_POINT as re, InterceptCellContentPriority as ne } from "@univerjs/sheets";
+class oe extends U {
+  _initialize(e) {
+    const t = e.get(u);
+    this.disposeWithMe(t.beforeCommandExecuted((r) => {
+      switch (r.id) {
+        case y.id:
+        case E.id:
+          this._beforeClipboardChange();
+          break;
+        case k.id:
+          this._beforeClipboardPaste(r.params);
+          break;
+      }
+    })), this.disposeWithMe(t.onCommandExecuted((r) => {
+      switch (r.id) {
+        case y.id:
+        case E.id:
+          this._clipboardChanged();
+          break;
+        case k.id:
+          this._clipboardPaste();
+          break;
+        case M.id:
+          this._clipboardPasteAsync();
+          break;
+      }
+    })), this.disposeWithMe(t.beforeCommandExecuted(async (r) => {
+      switch (r.id) {
+        case M.id:
+          await this._beforeClipboardPasteAsync();
+          break;
+      }
+    }));
+  }
+  _generateClipboardCopyParam() {
+    const e = this.getActiveUniverSheet(), t = e == null ? void 0 : e.getActiveSheet(), r = e == null ? void 0 : e.getActiveRange();
+    if (!e || !t || !r)
+      return;
+    const o = this._injector.get(T).generateCopyContent(e.getId(), t.getSheetId(), r.getRange());
+    if (!o)
+      return;
+    const { html: i, plain: a } = o;
+    return {
+      workbook: e,
+      worksheet: t,
+      text: a,
+      html: i,
+      fromSheet: t,
+      fromRange: r
+    };
+  }
+  _beforeClipboardChange() {
+    if (!this.hasEventCallback(this.Event.BeforeClipboardChange))
+      return;
+    const e = this._generateClipboardCopyParam();
+    if (e && (this.fireEvent(this.Event.BeforeClipboardChange, e), e.cancel))
+      throw new Error("Before clipboard change is canceled");
+  }
+  _clipboardChanged() {
+    if (!this.hasEventCallback(this.Event.ClipboardChanged))
+      return;
+    const e = this._generateClipboardCopyParam();
+    if (e && (this.fireEvent(this.Event.ClipboardChanged, e), e.cancel))
+      throw new Error("Clipboard changed is canceled");
+  }
+  _generateClipboardPasteParam(e) {
+    if (!e)
+      return;
+    const { htmlContent: t, textContent: r } = e, n = this.getActiveUniverSheet(), o = n == null ? void 0 : n.getActiveSheet();
+    return !n || !o ? void 0 : {
+      workbook: n,
+      worksheet: o,
+      text: r,
+      html: t
+    };
+  }
+  async _generateClipboardPasteParamAsync() {
+    const e = this.getActiveUniverSheet(), t = e == null ? void 0 : e.getActiveSheet();
+    if (!e || !t)
+      return;
+    const o = (await this._injector.get(q).read())[0];
+    let i;
+    if (o) {
+      const a = o.types, h = a.indexOf(R) !== -1 ? await o.getType(R).then((C) => C && C.text()) : "", g = a.indexOf(x) !== -1 ? await o.getType(x).then((C) => C && C.text()) : "";
+      i = {
+        workbook: e,
+        worksheet: t,
+        text: h,
+        html: g
+      };
+    }
+    return i;
+  }
+  _beforeClipboardPaste(e) {
+    if (!this.hasEventCallback(this.Event.BeforeClipboardPaste))
+      return;
+    const t = this._generateClipboardPasteParam(e);
+    if (t && (this.fireEvent(this.Event.BeforeClipboardPaste, t), t.cancel))
+      throw new Error("Before clipboard paste is canceled");
+  }
+  _clipboardPaste(e) {
+    if (!this.hasEventCallback(this.Event.BeforeClipboardPaste))
+      return;
+    const t = this._generateClipboardPasteParam(e);
+    if (t && (this.fireEvent(this.Event.BeforeClipboardPaste, t), t.cancel))
+      throw new Error("Clipboard pasted is canceled");
+  }
+  async _beforeClipboardPasteAsync() {
+    if (!this.hasEventCallback(this.Event.BeforeClipboardPaste))
+      return;
+    if (!j()) {
+      this._injector.get(b).warn("[Facade]: The navigator object only supports the browser environment");
+      return;
+    }
+    const e = await this._generateClipboardPasteParamAsync();
+    if (e && (this.fireEvent(this.Event.BeforeClipboardPaste, e), e.cancel))
+      throw new Error("Before clipboard paste is canceled");
+  }
+  async _clipboardPasteAsync() {
+    if (!this.hasEventCallback(this.Event.ClipboardPasted))
+      return;
+    if (!j()) {
+      this._injector.get(b).warn("[Facade]: The navigator object only supports the browser environment");
+      return;
+    }
+    const e = await this._generateClipboardPasteParamAsync();
+    if (e && (this.fireEvent(this.Event.ClipboardPasted, e), e.cancel))
+      throw new Error("Clipboard pasted is canceled");
+  }
   customizeColumnHeader(e) {
     const t = this.getActiveWorkbook();
     if (!t) {
@@ -13,7 +141,7 @@ class Z extends b {
       return;
     }
     const r = t == null ? void 0 : t.getId();
-    this._getSheetRenderComponent(r, l.COLUMN).setCustomHeader(e);
+    this._getSheetRenderComponent(r, m.COLUMN).setCustomHeader(e);
   }
   customizeRowHeader(e) {
     const t = this.getActiveWorkbook();
@@ -22,31 +150,29 @@ class Z extends b {
       return;
     }
     const r = t == null ? void 0 : t.getId();
-    this._getSheetRenderComponent(r, l.ROW).setCustomHeader(e);
+    this._getSheetRenderComponent(r, m.ROW).setCustomHeader(e);
   }
   registerSheetRowHeaderExtension(e, ...t) {
-    const r = this._getSheetRenderComponent(e, l.ROW), n = r.register(...t);
-    return i(() => {
+    const r = this._getSheetRenderComponent(e, m.ROW), n = r.register(...t);
+    return s(() => {
       n.dispose(), r.makeDirty(!0);
     });
   }
   registerSheetColumnHeaderExtension(e, ...t) {
-    const r = this._getSheetRenderComponent(e, l.COLUMN), n = r.register(...t);
-    return i(() => {
+    const r = this._getSheetRenderComponent(e, m.COLUMN), n = r.register(...t);
+    return s(() => {
       n.dispose(), r.makeDirty(!0);
     });
   }
   registerSheetMainExtension(e, ...t) {
-    const r = this._getSheetRenderComponent(e, l.MAIN), n = r.register(...t);
-    return i(() => {
+    const r = this._getSheetRenderComponent(e, m.MAIN), n = r.register(...t);
+    return s(() => {
       n.dispose(), r.makeDirty(!0);
     });
   }
   /**
    * Get sheet render component from render by unitId and view key.
-   *
    * @private
-   *
    * @param {string} unitId The unit id of the spreadsheet.
    * @param {SHEET_VIEW_KEY} viewKey The view key of the spreadsheet.
    * @returns {Nullable<RenderComponentType>} The render component.
@@ -55,28 +181,27 @@ class Z extends b {
     const n = this._injector.get(c).getRenderById(e);
     if (!n)
       throw new Error(`Render Unit with unitId ${e} not found`);
-    const { components: o } = n, s = o.get(t);
-    if (!s)
+    const { components: o } = n, i = o.get(t);
+    if (!i)
       throw new Error("Render component not found");
-    return s;
+    return i;
   }
   /**
    * Get sheet hooks.
-   *
    * @returns {FSheetHooks} FSheetHooks instance
    */
   getSheetHooks() {
-    return this._injector.createInstance(I);
+    return this._injector.createInstance(w);
   }
 }
-b.extend(Z);
-class J extends R {
+U.extend(oe);
+class ie extends D {
   openSiderbar(e) {
-    return this._logDeprecation("openSiderbar"), this._injector.get(V).open(e);
+    return this._logDeprecation("openSiderbar"), this._injector.get(G).open(e);
   }
   openDialog(e) {
     this._logDeprecation("openDialog");
-    const r = this._injector.get(N).open({
+    const r = this._injector.get(Q).open({
       ...e,
       onClose: () => {
         r.dispose();
@@ -85,94 +210,106 @@ class J extends R {
     return r;
   }
   _logDeprecation(e) {
-    this._injector.get(x).warn("[FWorkbook]", `${e} is deprecated. Please use the function of the same name on "FUniver".`);
+    this._injector.get(b).warn("[FWorkbook]", `${e} is deprecated. Please use the function of the same name on "FUniver".`);
   }
   onCellClick(e) {
-    const t = this._injector.get(d);
-    return i(
-      t.currentClickedCell$.pipe(p((r) => !!r)).subscribe(e)
+    const t = this._injector.get(l);
+    return s(
+      t.currentClickedCell$.pipe(v((r) => !!r)).subscribe(e)
     );
   }
   onCellHover(e) {
-    const t = this._injector.get(d);
-    return i(
-      t.currentRichText$.pipe(p((r) => !!r)).subscribe(e)
+    const t = this._injector.get(l);
+    return s(
+      t.currentRichText$.pipe(v((r) => !!r)).subscribe(e)
     );
   }
   onCellPointerDown(e) {
-    const t = this._injector.get(d);
-    return i(
+    const t = this._injector.get(l);
+    return s(
       t.currentPointerDownCell$.subscribe(e)
     );
   }
   onCellPointerUp(e) {
-    const t = this._injector.get(d);
-    return i(
+    const t = this._injector.get(l);
+    return s(
       t.currentPointerUpCell$.subscribe(e)
     );
   }
   onPointerMove(e) {
-    const t = this._injector.get(d);
-    return i(
-      t.currentCellPosWithEvent$.pipe(p((r) => !!r)).subscribe((r) => {
+    const t = this._injector.get(l);
+    return s(
+      t.currentCellPosWithEvent$.pipe(v((r) => !!r)).subscribe((r) => {
         e(r, r.event.buttons);
       })
     );
   }
   startEditing() {
-    return this._injector.get(h).syncExecuteCommand(m.id, {
-      eventType: _.Dblclick,
+    return this._injector.get(u).syncExecuteCommand(S.id, {
+      eventType: I.Dblclick,
       unitId: this._workbook.getUnitId(),
       visible: !0
     });
   }
   async endEditing(e) {
-    return this._injector.get(h).syncExecuteCommand(m.id, {
-      eventType: _.Keyboard,
-      keycode: e ? w.ENTER : w.ESC,
+    return this._injector.get(u).syncExecuteCommand(S.id, {
+      eventType: I.Keyboard,
+      keycode: e ? B.ENTER : B.ESC,
       visible: !1,
       unitId: this._workbook.getUnitId()
-    }), await j(0), !0;
+    }), await H(0), !0;
   }
+  endEditingAsync(e = !0) {
+    return this.endEditing(e);
+  }
+  /**
+   * Get scroll state of specified sheet.
+   * @param {string} sheetId - sheet id
+   * @returns {IScrollState} scroll state
+   * @example
+   * ``` ts
+   * univerAPI.getActiveWorkbook().getScrollStateBySheetId($sheetId)
+   * ```
+   */
   getScrollStateBySheetId(e) {
     const t = this._workbook.getUnitId(), n = this._injector.get(c).getRenderById(t);
-    return n ? n.with(v).getScrollStateByParam({ unitId: t, sheetId: e }) : null;
+    return n ? n.with(f).getScrollStateByParam({ unitId: t, sheetId: e }) : null;
   }
   disableSelection() {
     const e = this._workbook.getUnitId(), r = this._injector.get(c).getRenderById(e);
-    r && r.with(S).disableSelection();
+    return r && r.with(p).disableSelection(), this;
   }
   enableSelection() {
     const e = this._workbook.getUnitId(), r = this._injector.get(c).getRenderById(e);
-    r && r.with(S).enableSelection();
+    return r && r.with(p).enableSelection(), this;
   }
   transparentSelection() {
     const e = this._workbook.getUnitId(), r = this._injector.get(c).getRenderById(e);
-    r && r.with(S).transparentSelection();
+    return r && r.with(p).transparentSelection(), this;
   }
   showSelection() {
     const e = this._workbook.getUnitId(), r = this._injector.get(c).getRenderById(e);
-    r && r.with(S).showSelection();
+    return r && r.with(p).showSelection(), this;
   }
 }
-R.extend(J);
-class X extends M {
+D.extend(ie);
+class se extends W {
   refreshCanvas() {
     const e = this._injector.get(c), t = this._fWorkbook.id, r = e.getRenderById(t);
     if (!r)
       throw new Error(`Render Unit with unitId ${t} not found`);
-    r.with(C).reCalculate();
+    r.with(_).reCalculate();
     const n = r.mainComponent;
     if (!n)
       throw new Error("Main component not found");
-    n.makeDirty();
+    return n.makeDirty(), this;
   }
   zoom(e) {
-    return this._injector.get(h).executeCommand(W.id, {
+    return this._injector.get(u).syncExecuteCommand(Y.id, {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId(),
       zoomRatio: e
-    });
+    }), this;
   }
   getZoom() {
     return this._worksheet.getZoomRatio();
@@ -186,60 +323,65 @@ class X extends M {
       endRow: 0
     };
     if (!r) return n;
-    const s = r.with(C).getCurrentSkeleton();
-    if (!s) return n;
-    const g = s == null ? void 0 : s.getVisibleRanges();
-    if (!g) return n;
-    n = s.getVisibleRangeByViewport(B.VIEW_MAIN);
-    for (const [E, u] of g)
-      T.indexOf(E) !== -1 && (n.startColumn = Math.min(n.startColumn, u.startColumn), n.startRow = Math.min(n.startRow, u.startRow), n.endColumn = Math.max(n.endColumn, u.endColumn), n.endRow = Math.max(n.endRow, u.endRow));
+    const i = r.with(_).getCurrentSkeleton();
+    if (!i) return n;
+    const a = i == null ? void 0 : i.getVisibleRanges();
+    if (!a) return n;
+    n = i.getVisibleRangeByViewport(L.VIEW_MAIN);
+    for (const [h, g] of a)
+      K.indexOf(h) !== -1 && (n.startColumn = Math.min(n.startColumn, g.startColumn), n.startRow = Math.min(n.startRow, g.startRow), n.endColumn = Math.max(n.endColumn, g.endColumn), n.endRow = Math.max(n.endRow, g.endRow));
     return n;
   }
   scrollToCell(e, t) {
     const r = this._workbook.getUnitId(), o = this._injector.get(c).getRenderById(r);
-    o && (o == null ? void 0 : o.with(F)).scrollToCell(e, t);
+    return o && (o == null ? void 0 : o.with(z)).scrollToCell(e, t), this;
   }
   getScrollState() {
-    const e = this._workbook.getUnitId(), t = this._worksheet.getSheetId(), n = this._injector.get(c).getRenderById(e);
-    return n ? n.with(v).getScrollStateByParam({ unitId: e, sheetId: t }) : null;
+    const e = {
+      offsetX: 0,
+      offsetY: 0,
+      sheetViewStartColumn: 0,
+      sheetViewStartRow: 0
+    }, t = this._workbook.getUnitId(), r = this._worksheet.getSheetId(), o = this._injector.get(c).getRenderById(t);
+    return o && o.with(f).getScrollStateByParam({ unitId: t, sheetId: r }) || e;
   }
   onScroll(e) {
     var o;
-    const t = this._workbook.getUnitId(), n = (o = this._injector.get(c).getRenderById(t)) == null ? void 0 : o.with(v);
+    const t = this._workbook.getUnitId(), n = (o = this._injector.get(c).getRenderById(t)) == null ? void 0 : o.with(f);
     if (n) {
-      const s = n.validViewportScrollInfo$.subscribe((g) => {
-        e(g);
+      const i = n.validViewportScrollInfo$.subscribe((a) => {
+        e(a);
       });
-      return i(s);
+      return s(i);
     }
-    return i(() => {
+    return s(() => {
     });
   }
 }
-M.extend(X);
-class q extends f {
+W.extend(se);
+class ae extends F {
   setPermissionDialogVisible(e) {
     this._permissionService.setShowComponents(e);
   }
 }
-f.extend(q);
-class G extends I {
+F.extend(ae);
+class ce extends w {
   onCellPointerMove(e) {
-    return i(this._injector.get(d).currentPosition$.subscribe(e));
+    return s(this._injector.get(l).currentPosition$.subscribe(e));
   }
   onCellPointerOver(e) {
-    return i(this._injector.get(d).currentCell$.subscribe(e));
+    return s(this._injector.get(l).currentCell$.subscribe(e));
   }
   onCellDragOver(e) {
-    return i(this._injector.get(k).currentCell$.subscribe(e));
+    return s(this._injector.get(P).currentCell$.subscribe(e));
   }
   onCellDrop(e) {
-    return i(this._injector.get(k).endCell$.subscribe(e));
+    return s(this._injector.get(P).endCell$.subscribe(e));
   }
-  onCellRender(e, t = U.Style, r = z.DATA_VALIDATION) {
-    return this._injector.get(L).intercept(Y.CELL_CONTENT, {
+  onCellRender(e, t = N.Style, r = ne.DATA_VALIDATION) {
+    return this._injector.get(te).intercept(re.CELL_CONTENT, {
       effect: t,
-      handler: (n, o, s) => s({
+      handler: (n, o, i) => i({
         ...n,
         customRender: [
           ...(n == null ? void 0 : n.customRender) || [],
@@ -250,23 +392,38 @@ class G extends I {
     });
   }
   onBeforeCellEdit(e) {
-    return this._injector.get(h).beforeCommandExecuted((t) => {
+    return this._injector.get(u).beforeCommandExecuted((t) => {
       const r = t.params;
-      t.id === m.id && r.visible && e(r);
+      t.id === S.id && r.visible && e(r);
     });
   }
   onAfterCellEdit(e) {
-    return this._injector.get(h).onCommandExecuted((t) => {
+    return this._injector.get(u).onCommandExecuted((t) => {
       const r = t.params;
-      t.id === m.id && !r.visible && e(r);
+      t.id === S.id && !r.visible && e(r);
     });
   }
 }
-I.extend(G);
-class Q extends y {
+w.extend(ce);
+class de extends A {
+  get BeforeClipboardChange() {
+    return "BeforeClipboardChange";
+  }
+  get ClipboardChanged() {
+    return "ClipboardChanged";
+  }
+  get BeforeClipboardPaste() {
+    return "BeforeClipboardPaste";
+  }
+  get ClipboardPasted() {
+    return "ClipboardPasted";
+  }
+}
+A.extend(de);
+class he extends O {
   getCell() {
     const e = this._injector.get(c), t = this._workbook.getUnitId(), r = this._worksheet.getSheetId();
-    return e.getRenderById(t).with(C).getWorksheetSkeleton(r).skeleton.getCellWithCoordByIndex(this._range.startRow, this._range.startColumn);
+    return e.getRenderById(t).with(_).getWorksheetSkeleton(r).skeleton.getCellWithCoordByIndex(this._range.startRow, this._range.startColumn);
   }
   getCellRect() {
     const { startX: e, startY: t, endX: r, endY: n } = this.getCell(), o = { x: e, y: t, width: r - e, height: n - t, top: t, left: e, bottom: n, right: r };
@@ -274,7 +431,7 @@ class Q extends y {
   }
   generateHTML() {
     var t;
-    const e = this._injector.get(O).generateCopyContent(
+    const e = this._injector.get(T).generateCopyContent(
       this._workbook.getUnitId(),
       this._worksheet.getSheetId(),
       this._range
@@ -282,7 +439,9 @@ class Q extends y {
     return (t = e == null ? void 0 : e.html) != null ? t : "";
   }
   attachPopup(e) {
-    const { key: t, disposableCollection: r } = ee(e, this._injector.get(K)), o = this._injector.get(A).attachPopupToCell(
+    var i, a, h;
+    e.direction = (i = e.direction) != null ? i : "horizontal", e.extraProps = (a = e.extraProps) != null ? a : {}, e.offset = (h = e.offset) != null ? h : [0, 0];
+    const { key: t, disposableCollection: r } = le(e, this._injector.get(ee)), o = this._injector.get(X).attachPopupToCell(
       this._range.startRow,
       this._range.startColumn,
       { ...e, componentKey: t },
@@ -292,7 +451,7 @@ class Q extends y {
     return o ? (r.add(o), r) : (r.dispose(), null);
   }
   attachAlertPopup(e) {
-    const t = this._injector.get(H), r = {
+    const t = this._injector.get(Z), r = {
       workbook: this._workbook,
       worksheet: this._worksheet,
       row: this._range.startRow,
@@ -310,24 +469,24 @@ class Q extends y {
     };
   }
   highlight(e, t) {
-    const r = this._injector.get($), n = r.addShape({ range: this._range, style: e, primary: t });
+    const r = this._injector.get(J), n = r.addShape({ range: this._range, style: e, primary: t });
     if (!n)
       throw new Error("Failed to highlight current range");
-    return i(() => {
+    return s(() => {
       r.removeShape(n);
     });
   }
 }
-y.extend(Q);
-function ee(a, e) {
-  const { componentKey: t, isVue3: r } = a;
+O.extend(he);
+function le(d, e) {
+  const { componentKey: t, isVue3: r } = d;
   let n;
-  const o = new P();
-  return typeof t == "string" ? n = t : (n = `External_${D(6)}`, o.add(e.register(n, t, { framework: r ? "vue3" : "react" }))), {
+  const o = new V();
+  return typeof t == "string" ? n = t : (n = `External_${$(6)}`, o.add(e.register(n, t, { framework: r ? "vue3" : "react" }))), {
     key: n,
     disposableCollection: o
   };
 }
 export {
-  ee as transformComponentKey
+  le as transformComponentKey
 };