@univerjs/sheets-hyper-link 0.5.3 → 0.5.4-nightly.202501131606

package/lib/es/index.js

@@ -1,17 +1,17 @@
 var Ae = Object.defineProperty;
 var We = (s, e, t) => e in s ? Ae(s, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : s[e] = t;
 var w = (s, e, t) => We(s, typeof e != "symbol" ? e + "" : e, t);
-import { Disposable as V, ObjectMatrix as q, UniverInstanceType as I, IUniverInstanceService as E, CommandType as L, CustomRangeType as b, Inject as M, ICommandService as P, sequenceExecuteAsync as ve, isValidRange as Re, toDisposable as Be, DisposableCollection as je, Rectangle as Fe, Range as Ke, Tools as oe, BuildTextUtils as Z, generateRandomId as de, TextX as ce, DOCS_NORMAL_EDITOR_UNIT_ID_KEY as Ye, IResourceManagerService as Ge, IUndoRedoService as Se, CellValueType as Ie, sequenceExecute as ze, getBodySlice as Ne, LocaleService as Je, DependentOn as Xe, Injector as qe, Plugin as Ze, merge as Qe, registerDependencies as et, touchDependencies as tt, IConfigService as nt } from "@univerjs/core";
+import { Disposable as V, ObjectMatrix as q, UniverInstanceType as v, IUniverInstanceService as E, CommandType as L, CustomRangeType as b, Inject as M, ICommandService as P, sequenceExecuteAsync as Re, isValidRange as Se, toDisposable as Be, DisposableCollection as je, Rectangle as Fe, Range as Ke, Tools as oe, BuildTextUtils as Z, generateRandomId as de, TextX as ce, DOCS_NORMAL_EDITOR_UNIT_ID_KEY as Ye, IResourceManagerService as Ge, IUndoRedoService as Ie, CellValueType as ve, sequenceExecute as ze, getBodySlice as Ne, LocaleService as Je, DependentOn as Xe, Injector as qe, Plugin as Ze, merge as Qe, registerDependencies as et, touchDependencies as tt, IConfigService as nt } from "@univerjs/core";
 import { Subject as rt } from "rxjs";
 import { getSheetCommandTarget as j, RefRangeService as Oe, SheetsSelectionsService as ke, handleCommonRangeChangeWithEffectRefCommandsSkipNoInterests as st, handleDefaultRangeChangeWithEffectRefCommandsSkipNoInterests as it, SheetInterceptorService as le, RemoveSheetCommand as at, handleDefaultRangeChangeWithEffectRefCommands as ot, SetRangeValuesMutation as H, SetRangeValuesCommand as dt, ClearSelectionContentCommand as ct, ClearSelectionAllCommand as lt, ClearSelectionFormatCommand as ut, AFTER_CELL_EDIT as pt, SetRangeValuesUndoMutationFactory as Me, UniverSheetsPlugin as ht } from "@univerjs/sheets";
 import { deserializeRangeWithSheet as Ce, serializeRange as B, serializeRangeWithSheet as gt, IDefinedNamesService as ft } from "@univerjs/engine-formula";
 import { addCustomRangeBySelectionFactory as _t, deleteCustomRangeFactory as mt, replaceSelectionFactory as De } from "@univerjs/docs";
-var yt = Object.defineProperty, vt = Object.getOwnPropertyDescriptor, Rt = (s, e, t, n) => {
-  for (var r = n > 1 ? void 0 : n ? vt(e, t) : e, i = s.length - 1, a; i >= 0; i--)
+var yt = Object.defineProperty, Rt = Object.getOwnPropertyDescriptor, St = (s, e, t, n) => {
+  for (var r = n > 1 ? void 0 : n ? Rt(e, t) : e, i = s.length - 1, a; i >= 0; i--)
     (a = s[i]) && (r = (n ? a(e, t, r) : a(r)) || r);
   return n && r && yt(e, t, r), r;
-}, St = (s, e) => (t, n) => e(t, n, s);
-let S = class extends V {
+}, It = (s, e) => (t, n) => e(t, n, s);
+let I = class extends V {
   constructor(e) {
     super();
     w(this, "_linkUpdate$", new rt());
@@ -101,7 +101,7 @@ let S = class extends V {
   }
   getHyperLinkByLocationSync(e, t, n, r) {
     var l, u, h, g, p;
-    const { matrix: i } = this._ensureMap(e, t), a = this._univerInstanceService.getUnit(e, I.UNIVER_SHEET), o = (l = a == null ? void 0 : a.getSheetBySheetId(t)) == null ? void 0 : l.getCellRaw(n, r), c = ((p = (g = o == null ? void 0 : o.v) != null ? g : (h = (u = o == null ? void 0 : o.p) == null ? void 0 : u.body) == null ? void 0 : h.dataStream.slice(0, -2)) != null ? p : "").toString(), d = i.getValue(n, r);
+    const { matrix: i } = this._ensureMap(e, t), a = this._univerInstanceService.getUnit(e, v.UNIVER_SHEET), o = (l = a == null ? void 0 : a.getSheetBySheetId(t)) == null ? void 0 : l.getCellRaw(n, r), c = ((p = (g = o == null ? void 0 : o.v) != null ? g : (h = (u = o == null ? void 0 : o.p) == null ? void 0 : u.body) == null ? void 0 : h.dataStream.slice(0, -2)) != null ? p : "").toString(), d = i.getValue(n, r);
     if (d)
       return {
         ...d,
@@ -137,17 +137,17 @@ let S = class extends V {
     return Array.from(this._linkMap.keys()).map((t) => this.getUnit(t));
   }
 };
-S = Rt([
-  St(0, E)
-], S);
+I = St([
+  It(0, E)
+], I);
 var U = /* @__PURE__ */ ((s) => (s.SHEET = "gid", s.RANGE = "range", s.DEFINE_NAME = "rangeid", s.INVALID = "invalid", s.URL = "url", s))(U || {});
-const It = "sheets-hyper-link.config", Ue = {}, O = {
+const vt = "sheets-hyper-link.config", Ue = {}, O = {
   type: L.MUTATION,
   id: "sheets.mutation.add-hyper-link",
   handler(s, e) {
     if (!e)
       return !1;
-    const t = s.get(S), { unitId: n, subUnitId: r, link: i } = e;
+    const t = s.get(I), { unitId: n, subUnitId: r, link: i } = e;
     return t.addHyperLink(n, r, i);
   }
 }, k = {
@@ -156,7 +156,7 @@ const It = "sheets-hyper-link.config", Ue = {}, O = {
   handler(s, e) {
     if (!e)
       return !1;
-    const t = s.get(S), { unitId: n, subUnitId: r, id: i } = e;
+    const t = s.get(I), { unitId: n, subUnitId: r, id: i } = e;
     return t.removeHyperLink(n, r, i);
   }
 }, _e = {
@@ -165,7 +165,7 @@ const It = "sheets-hyper-link.config", Ue = {}, O = {
   handler(s, e) {
     if (!e)
       return !1;
-    const t = s.get(S), { unitId: n, subUnitId: r, payload: i, id: a } = e;
+    const t = s.get(I), { unitId: n, subUnitId: r, payload: i, id: a } = e;
     return t.updateHyperLink(n, r, a, i, !1);
   }
 }, me = {
@@ -174,7 +174,7 @@ const It = "sheets-hyper-link.config", Ue = {}, O = {
   handler(s, e) {
     if (!e)
       return !1;
-    const t = s.get(S), { unitId: n, subUnitId: r, id: i, row: a, column: o, silent: c } = e;
+    const t = s.get(I), { unitId: n, subUnitId: r, id: i, row: a, column: o, silent: c } = e;
     return t.updateHyperLinkRef(n, r, i, { row: a, column: o }, c);
   }
 }, X = {
@@ -280,7 +280,7 @@ let ee = class extends V {
       r,
       this._refRangeService.watchRange(e, t, i, (a, o) => {
         const { redos: c } = this._handlePositionChange(e, t, n, o, !0);
-        ve(c, this._commandService, { onlyLocal: !0 });
+        Re(c, this._commandService, { onlyLocal: !0 });
       }, !0)
     );
   }
@@ -302,7 +302,7 @@ let ee = class extends V {
       };
       if (d.range && d.gid) {
         const l = d.gid, u = Ce(d.range).range;
-        if (Re(u) && d.range !== Q) {
+        if (Se(u) && d.range !== Q) {
           const h = (g) => {
             const p = it(u, g, { selectionManagerService: this._selectionManagerService });
             return p && B(p) === B(u) ? {
@@ -404,7 +404,7 @@ let ee = class extends V {
 };
 ee = wt([
   z(0, M(Oe)),
-  z(1, M(S)),
+  z(1, M(I)),
   z(2, M(ke)),
   z(3, P)
 ], ee);
@@ -423,7 +423,7 @@ let te = class extends V {
         getMutations: (s) => {
           var e;
           if (s.id === at.id) {
-            const t = s.params, n = t.unitId ? this._univerInstanceService.getUnit(t.unitId) : this._univerInstanceService.getCurrentUnitForType(I.UNIVER_SHEET);
+            const t = s.params, n = t.unitId ? this._univerInstanceService.getUnit(t.unitId) : this._univerInstanceService.getCurrentUnitForType(v.UNIVER_SHEET);
             if (!n)
               return { redos: [], undos: [] };
             const r = n.getUnitId(), i = t.subUnitId || ((e = n.getActiveSheet()) == null ? void 0 : e.getSheetId());
@@ -455,7 +455,7 @@ let te = class extends V {
 te = Ut([
   he(0, M(le)),
   he(1, E),
-  he(2, M(S))
+  he(2, M(I))
 ], te);
 var bt = Object.defineProperty, Pt = Object.getOwnPropertyDescriptor, Nt = (s, e, t, n) => {
   for (var r = n > 1 ? void 0 : n ? Pt(e, t) : e, i = s.length - 1, a; i >= 0; i--)
@@ -476,7 +476,7 @@ let ne = class extends V {
   }
   _isLegalRangeUrl(e, t) {
     var r, i, a;
-    const n = this._univerInstanceService.getUnit(e, I.UNIVER_SHEET);
+    const n = this._univerInstanceService.getUnit(e, v.UNIVER_SHEET);
     if (!n)
       return null;
     if (t && t.startsWith("#")) {
@@ -490,7 +490,7 @@ let ne = class extends V {
         if (!l)
           return null;
         const u = Ce(c.range).range;
-        if (Re(u, l) && c.range !== Q)
+        if (Se(u, l) && c.range !== Q)
           return {
             range: u,
             worksheet: l
@@ -518,8 +518,8 @@ let ne = class extends V {
               this._refRangeService.registerRefRange(
                 m,
                 (y) => {
-                  const v = ot(m, y);
-                  return v && Fe.equals(v, m) ? {
+                  const R = ot(m, y);
+                  return R && Fe.equals(R, m) ? {
                     preRedos: [],
                     preUndos: [],
                     redos: [],
@@ -533,7 +533,7 @@ let ne = class extends V {
                         row: n,
                         col: r,
                         id: g.rangeId,
-                        url: `#gid=${t}&range=${v ? B(v) : Q}`
+                        url: `#gid=${t}&range=${R ? B(R) : Q}`
                       }
                     }],
                     undos: [{
@@ -570,17 +570,17 @@ let ne = class extends V {
         });
       });
     };
-    this._univerInstanceService.getAllUnitsForType(I.UNIVER_SHEET).forEach((t) => {
+    this._univerInstanceService.getAllUnitsForType(v.UNIVER_SHEET).forEach((t) => {
       e(t);
     }), this.disposeWithMe(
       this._univerInstanceService.unitAdded$.subscribe((t) => {
-        t.type === I.UNIVER_SHEET && e(t);
+        t.type === v.UNIVER_SHEET && e(t);
       })
     );
   }
   _initWorkbookUnload() {
     this._univerInstanceService.unitDisposed$.subscribe((e) => {
-      if (e.type === I.UNIVER_SHEET) {
+      if (e.type === v.UNIVER_SHEET) {
         const t = e, n = t.getUnitId();
         t.getSheets().forEach((r) => {
           const i = r.getSheetId();
@@ -710,7 +710,7 @@ let re = class extends V {
         if (!s || s.p)
           return t(s);
         if (typeof s.v == "string" && oe.isLegalUrl(s.v) && s.v[s.v.length - 1] !== " ") {
-          const { unitId: n, subUnitId: r } = e, i = this._univerInstanceService.getUnit(n, I.UNIVER_SHEET), a = i == null ? void 0 : i.getSheetBySheetId(r);
+          const { unitId: n, subUnitId: r } = e, i = this._univerInstanceService.getUnit(n, v.UNIVER_SHEET), a = i == null ? void 0 : i.getSheetBySheetId(r);
           if (!a)
             return t(s);
           const o = a.getBlankCellDocumentModel(s);
@@ -760,7 +760,7 @@ let re = class extends V {
 };
 re = Dt([
   J(0, M(le)),
-  J(1, M(S)),
+  J(1, M(I)),
   J(2, M(ke)),
   J(3, E)
 ], re);
@@ -810,7 +810,7 @@ let se = class extends V {
 };
 se = $t([
   be(0, Ge),
-  be(1, M(S))
+  be(1, M(I))
 ], se);
 const xt = {
   type: L.COMMAND,
@@ -818,16 +818,16 @@ const xt = {
   // eslint-disable-next-line max-lines-per-function
   async handler(s, e) {
     if (!e) return !1;
-    const t = s.get(P), n = s.get(Se), r = s.get(E), i = s.get(S), a = s.get(le), o = j(r, e);
+    const t = s.get(P), n = s.get(Ie), r = s.get(E), i = s.get(I), a = s.get(le), o = j(r, e);
     if (!o) return !1;
-    const { unitId: c, subUnitId: d, workbook: l, worksheet: u } = o, { link: h } = e, { payload: g, display: p, row: f, column: _, id: m } = h, C = u.getCell(f, _), y = u.getBlankCellDocumentModel(C), v = y.documentModel.getSnapshot(), R = oe.deepClone(v.body);
-    if (!R) return !1;
+    const { unitId: c, subUnitId: d, workbook: l, worksheet: u } = o, { link: h } = e, { payload: g, display: p, row: f, column: _, id: m } = h, C = u.getCell(f, _), y = u.getBlankCellDocumentModel(C), R = y.documentModel.getSnapshot(), S = oe.deepClone(R.body);
+    if (!S) return !1;
     let N;
     if (p ? N = Z.selection.replace({
       selection: {
         startOffset: 0,
-        endOffset: R.dataStream.length - 2,
-        collapsed: R.dataStream.length - 2 === 0
+        endOffset: S.dataStream.length - 2,
+        collapsed: S.dataStream.length - 2 === 0
       },
       body: {
         dataStream: `${p}`,
@@ -844,8 +844,8 @@ const xt = {
       },
       doc: y.documentModel
     }) : N = Z.customRange.add({
-      body: R,
-      ranges: [{ startOffset: 0, endOffset: R.dataStream.length - 2, collapsed: !1 }],
+      body: S,
+      ranges: [{ startOffset: 0, endOffset: S.dataStream.length - 2, collapsed: !1 }],
       rangeId: m,
       rangeType: b.HYPERLINK,
       properties: {
@@ -853,12 +853,12 @@ const xt = {
         refId: m
       }
     }), !N) return !1;
-    const F = ce.apply(R, N.serialize()), D = {
+    const F = ce.apply(S, N.serialize()), D = {
       p: {
-        ...v,
+        ...R,
         body: F
       },
-      t: Ie.STRING
+      t: ve.STRING
     }, x = await a.onWriteCell(l, u, f, _, D), T = {
       unitId: c,
       subUnitId: d,
@@ -888,7 +888,7 @@ const xt = {
         subUnitId: d,
         link: W
       }
-    })), await ve(K, t) ? (n.pushUndoRedo({
+    })), await Re(K, t) ? (n.pushUndoRedo({
       redoMutations: K,
       undoMutations: A,
       unitID: c
@@ -918,7 +918,7 @@ const xt = {
   handler(s, e) {
     var D, x;
     if (!e) return !1;
-    const t = s.get(P), n = s.get(Se), r = s.get(E), i = s.get(S), a = j(r, e);
+    const t = s.get(P), n = s.get(Ie), r = s.get(E), i = s.get(I), a = j(r, e);
     if (!a) return !1;
     const { row: o, column: c, id: d } = e, { unitId: l, subUnitId: u, worksheet: h } = a, g = h.getCell(o, c);
     if (!g) return !1;
@@ -926,9 +926,9 @@ const xt = {
     if (!(p != null && p.documentModel)) return !1;
     const f = oe.deepClone(p.documentModel.getSnapshot()), _ = (x = (D = f.body) == null ? void 0 : D.customRanges) == null ? void 0 : x.find((T) => `${T.rangeId}` === d);
     if (!_) return !1;
-    const m = Z.customRange.delete(s, { documentDataModel: p.documentModel, rangeId: _.rangeId });
+    const m = Z.customRange.delete({ documentDataModel: p.documentModel, rangeId: _.rangeId });
     if (!m) return !1;
-    const C = ce.apply(f.body, m.serialize()), y = [], v = [], R = {
+    const C = ce.apply(f.body, m.serialize()), y = [], R = [], S = {
       unitId: l,
       subUnitId: u,
       cellValue: {
@@ -938,17 +938,17 @@ const xt = {
               ...f,
               body: C
             },
-            t: Ie.STRING
+            t: ve.STRING
           }
         }
       }
     };
     y.push({
       id: H.id,
-      params: R
+      params: S
     });
-    const N = Me(s, R);
-    v.push({
+    const N = Me(s, S);
+    R.push({
       id: H.id,
       params: N
     });
@@ -960,7 +960,7 @@ const xt = {
         subUnitId: u,
         id: d
       }
-    }), v.push({
+    }), R.push({
       id: O.id,
       params: {
         unitId: l,
@@ -971,7 +971,7 @@ const xt = {
       }
     })), ze(y, t).result ? (n.pushUndoRedo({
       redoMutations: y,
-      undoMutations: v,
+      undoMutations: R,
       unitID: l
     }), !0) : !1;
   }
@@ -982,7 +982,7 @@ const xt = {
     var l, u;
     if (!e)
       return !1;
-    const { id: t, documentId: n } = e, r = s.get(P), a = s.get(E).getUnit(n, I.UNIVER_DOC), o = (u = (l = a == null ? void 0 : a.getBody()) == null ? void 0 : l.customRanges) == null ? void 0 : u.find((h) => h.rangeId === t);
+    const { id: t, documentId: n } = e, r = s.get(P), a = s.get(E).getUnit(n, v.UNIVER_DOC), o = (u = (l = a == null ? void 0 : a.getBody()) == null ? void 0 : l.customRanges) == null ? void 0 : u.find((h) => h.rangeId === t);
     let c = null;
     o && o.endIndex === a.getBody().dataStream.length - 3 && (c = {
       dataStream: " "
@@ -997,7 +997,7 @@ const xt = {
   async handler(s, e) {
     var we, Ee, Le;
     if (!e) return !1;
-    const t = s.get(P), n = s.get(Se), r = s.get(E), i = s.get(S), a = s.get(le), o = j(r, {
+    const t = s.get(P), n = s.get(Ie), r = s.get(E), i = s.get(I), a = s.get(le), o = j(r, {
       unitId: e.unitId,
       subUnitId: e.subUnitId
     });
@@ -1006,9 +1006,9 @@ const xt = {
     if (!C) return !1;
     const y = g.getCellDocumentModelWithFormula(C);
     if (!(y != null && y.documentModel)) return !1;
-    const v = y.documentModel.getSnapshot(), R = (Ee = (we = v.body) == null ? void 0 : we.customRanges) == null ? void 0 : Ee.find((Te) => `${Te.rangeId}` === u);
-    if (!R) return !1;
-    const N = de(), $ = (Le = Ne(y.documentModel.getBody(), R.startIndex, R.endIndex + 1).textRuns) == null ? void 0 : Le[0];
+    const R = y.documentModel.getSnapshot(), S = (Ee = (we = R.body) == null ? void 0 : we.customRanges) == null ? void 0 : Ee.find((Te) => `${Te.rangeId}` === u);
+    if (!S) return !1;
+    const N = de(), $ = (Le = Ne(y.documentModel.getBody(), S.startIndex, S.endIndex + 1).textRuns) == null ? void 0 : Le[0];
     $ && ($.ed = m.length + 1);
     const D = De(s, {
       unitId: p,
@@ -1026,20 +1026,20 @@ const xt = {
         textRuns: $ ? [$] : void 0
       },
       selection: {
-        startOffset: R.startIndex,
-        endOffset: R.endIndex + 1,
+        startOffset: S.startIndex,
+        endOffset: S.endIndex + 1,
         collapsed: !1
       },
       doc: y.documentModel
     });
     if (!D)
       return !1;
-    const x = ce.apply(oe.deepClone(v.body), D.textX.serialize()), T = {
+    const x = ce.apply(oe.deepClone(R.body), D.textX.serialize()), T = {
       p: {
-        ...v,
+        ...R,
         body: x
       },
-      t: Ie.STRING
+      t: ve.STRING
     }, ue = await a.onWriteCell(h, g, d, l, T), Y = {
       id: H.id,
       params: {
@@ -1069,7 +1069,7 @@ const xt = {
         subUnitId: f,
         link: G
       }
-    })), await ve(A, t) ? (n.pushUndoRedo({
+    })), await Re(A, t) ? (n.pushUndoRedo({
       redoMutations: A,
       undoMutations: W,
       unitID: p
@@ -1082,7 +1082,7 @@ const xt = {
     var p, f, _, m;
     if (!e)
       return !1;
-    const { documentId: t, payload: n, id: r } = e, i = s.get(E), a = s.get(P), o = i.getUnit(t, I.UNIVER_DOC);
+    const { documentId: t, payload: n, id: r } = e, i = s.get(E), a = s.get(P), o = i.getUnit(t, v.UNIVER_DOC);
     if (!o)
       return !1;
     const c = (f = (p = o.getBody()) == null ? void 0 : p.customRanges) == null ? void 0 : f.find((C) => C.rangeId === r);
@@ -1182,7 +1182,7 @@ let ye = class {
   }
   _getURLName(s) {
     var d;
-    const { gid: e, range: t, rangeid: n, unitid: r } = s, i = r ? this._univerInstanceService.getUnit(r, I.UNIVER_SHEET) : this._univerInstanceService.getCurrentUnitForType(I.UNIVER_SHEET), a = {
+    const { gid: e, range: t, rangeid: n, unitid: r } = s, i = r ? this._univerInstanceService.getUnit(r, v.UNIVER_SHEET) : this._univerInstanceService.getCurrentUnitForType(v.UNIVER_SHEET), a = {
       type: U.INVALID,
       name: this._localeService.t("hyperLink.message.refError")
     };
@@ -1192,7 +1192,7 @@ let ye = class {
     if (t) {
       if (!o) return a;
       const l = Ce(t).range;
-      return Re(l, o) && t !== Q ? {
+      return Se(l, o) && t !== Q ? {
         type: U.RANGE,
         name: gt(c, l)
       } : a;
@@ -1232,11 +1232,11 @@ let ae = class extends Ze {
       Ue,
       this._config
     );
-    this._configService.setConfig(It, n);
+    this._configService.setConfig(vt, n);
   }
   onStarting() {
     et(this._injector, [
-      [S],
+      [I],
       [ye],
       [se],
       [ie],
@@ -1255,7 +1255,7 @@ let ae = class extends Ze {
   }
 };
 xe(ae, "pluginName", He);
-xe(ae, "type", I.UNIVER_SHEET);
+xe(ae, "type", v.UNIVER_SHEET);
 ae = Qt([
   Xe(ht),
   Pe(1, M(qe)),
@@ -1268,7 +1268,7 @@ export {
   At as CancelHyperLinkCommand,
   Wt as CancelRichHyperLinkCommand,
   Q as ERROR_RANGE,
-  S as HyperLinkModel,
+  I as HyperLinkModel,
   k as RemoveHyperLinkMutation,
   U as SheetHyperLinkType,
   ye as SheetsHyperLinkParserService,

package/lib/types/commands/commands/add-hyper-link.command.d.ts

@@ -1,9 +1,9 @@
 import { ICommand } from '@univerjs/core';
-import { ICellHyperLink } from '../../types/interfaces/i-hyper-link';
+import { ISheetHyperLink } from '../../types/interfaces/i-hyper-link';
 export interface IAddHyperLinkCommandParams {
     unitId: string;
     subUnitId: string;
-    link: ICellHyperLink;
+    link: ISheetHyperLink;
 }
 /**
  * Command for add hyperlink
@@ -14,6 +14,6 @@ export interface IAddRichHyperLinkCommandParams {
      * url of link
      */
     documentId: string;
-    link: ICellHyperLink;
+    link: ISheetHyperLink;
 }
 export declare const AddRichHyperLinkCommand: ICommand<IAddRichHyperLinkCommandParams>;

package/lib/types/commands/mutations/add-hyper-link.mutation.d.ts

@@ -1,8 +1,8 @@
 import { ICommand } from '@univerjs/core';
-import { ICellHyperLink } from '../../types/interfaces/i-hyper-link';
+import { ISheetHyperLink } from '../../types/interfaces/i-hyper-link';
 export interface IAddHyperLinkMutationParams {
     unitId: string;
     subUnitId: string;
-    link: ICellHyperLink;
+    link: ISheetHyperLink;
 }
 export declare const AddHyperLinkMutation: ICommand<IAddHyperLinkMutationParams>;

package/lib/types/facade/f-range.d.ts

@@ -8,57 +8,50 @@ export interface ICellHyperLink {
 }
 export interface IFRangeHyperlinkMixin {
     /**
-     * Set hyperlink in the cell in the range.
-     * [!important] This method is async.
-     * @param url url
-     * @param label optional, label of the url
-     * @returns success or not
+     * @deprecated use `range.setRichTextValueForCell(univerAPI.newRichText().insertLink(label, url))` instead
      */
     setHyperLink(url: string, label?: string): Promise<boolean>;
     /**
-     * Get all hyperlinks in the cell in the range.
-     * @returns hyperlinks
+     * @deprecated use `range.setRichTextValueForCell(range.getRichTextValue().getLinks())` instead
      */
     getHyperLinks(): ICellHyperLink[];
     /**
-     * Update hyperlink in the cell in the range.
-     * [!important] This method is async.
-     * @param id id of the hyperlink
-     * @param url url
-     * @param label optional, label of the url
-     * @returns success or not
+     * @deprecated use `range.setRichTextValueForCell(range.getRichTextValue().copy().updateLink(id, url))` instead
      */
     updateHyperLink(id: string, url: string, label?: string): Promise<boolean>;
     /**
-     * Cancel hyperlink in the cell in the range.
-     * [!important] This method is async.
-     * @param id id of the hyperlink
-     * @returns success or not
+     * @deprecated use `range.setRichTextValueForCell(range.getRichTextValue().copy().cancelLink(id))` instead
      */
     cancelHyperLink(id: string): boolean;
+    /**
+     * Get the url of this range.
+     */
+    getUrl(): string;
 }
 export declare class FRangeHyperlinkMixin extends FRange implements IFRangeHyperlinkMixin {
+    /**
+     * @param url
+     * @param label
+     * @deprecated
+     */
     setHyperLink(url: string, label?: string): Promise<boolean>;
     /**
-     * Get all hyperlinks in the cell in the range.
-     * @returns hyperlinks
+     * @deprecated
      */
     getHyperLinks(): ICellHyperLink[];
     /**
-     * Update hyperlink in the cell in the range.
-     * [!important] This method is async.
-     * @param id id of the hyperlink
-     * @param url url
-     * @param label optional, label of the url
-     * @returns success or not
+     * @param id
+     * @param url
+     * @param label
+     * @deprecated
      */
     updateHyperLink(id: string, url: string, label?: string): Promise<boolean>;
     /**
-     * Cancel hyperlink in the cell in the range.
-     * @param id id of the hyperlink
-     * @returns success or not
+     * @param id
+     * @deprecated
      */
     cancelHyperLink(id: string): boolean;
+    getUrl(): string;
 }
 declare module '@univerjs/sheets/facade' {
     interface FRange extends IFRangeHyperlinkMixin {

package/lib/types/facade/f-workbook.d.ts

@@ -1,27 +1,34 @@
+import { ISheetHyperLinkInfo, SheetsHyperLinkParserService } from '@univerjs/sheets-hyper-link';
+import { FRange, FWorkbook } from '@univerjs/sheets/facade';
 import { IRange } from '@univerjs/core';
-import { ISheetHyperLinkInfo } from '@univerjs/sheets-hyper-link';
-import { FWorkbook } from '@univerjs/sheets/facade';
+export declare class SheetHyperLinkBuilder {
+    private _workbook;
+    private readonly _parserService;
+    constructor(_workbook: FWorkbook, _parserService: SheetsHyperLinkParserService);
+    getRangeUrl(range: FRange): this;
+}
 export interface IFWorkbookHyperlinkMixin {
     /**
-     * create a hyperlink for the sheet
-     * @param sheetId the sheet id to link
-     * @param range the range to link, or define-name id
-     * @returns the hyperlink string
+     * @deprecated use `getUrl` method in `FRange` or `FWorksheet` instead.
      */
     createSheetHyperlink(this: FWorkbook, sheetId: string, range?: string | IRange): string;
     /**
-     * parse the hyperlink string to get the hyperlink info
+     * Parse the hyperlink string to get the hyperlink info.
      * @param hyperlink the hyperlink string
      * @returns the hyperlink info
+     * @example
+     * ``` ts
+     * univerAPI.getActiveWorkbook().parseSheetHyperlink('#gid=sheet_Id&range=F6')
+     * ```
      */
     parseSheetHyperlink(this: FWorkbook, hyperlink: string): ISheetHyperLinkInfo;
 }
 export declare class FWorkbookHyperLinkMixin extends FWorkbook implements IFWorkbookHyperlinkMixin {
     createSheetHyperlink(sheetId: string, range?: string | IRange): string;
     /**
-     * parse the hyperlink string to get the hyperlink info
-     * @param hyperlink the hyperlink string
-     * @returns the hyperlink info
+     * Parse the hyperlink string to get the hyperlink info.
+     * @param {string} hyperlink the hyperlink string
+     * @returns {ISheetHyperLinkInfo} the hyperlink info
      */
     parseSheetHyperlink(hyperlink: string): ISheetHyperLinkInfo;
 }

package/lib/types/facade/f-worksheet.d.ts

@@ -0,0 +1,14 @@
+import { FWorksheet } from '@univerjs/sheets/facade';
+export interface IFWorksheetHyperlinkMixin {
+    /**
+     * Get the url of this sheet
+     */
+    getUrl(): string;
+}
+export declare class FWorksheetHyperlinkMixin extends FWorksheet implements IFWorksheetHyperlinkMixin {
+    getUrl(): string;
+}
+declare module '@univerjs/sheets/facade' {
+    interface FWorksheet extends IFWorksheetHyperlinkMixin {
+    }
+}

package/lib/types/facade/index.d.ts

@@ -14,7 +14,9 @@
  * limitations under the License.
  */
 import './f-workbook';
+import './f-worksheet';
 import './f-range';
 export { FWorkbookHyperLinkMixin } from './f-workbook';
 export type * from './f-range';
 export type * from './f-workbook';
+export type * from './f-worksheet';

package/lib/types/index.d.ts

@@ -16,7 +16,7 @@
 export { HyperLinkModel } from './models/hyper-link.model';
 export { SheetHyperLinkType } from './types/enums/hyper-link-type';
 export { UniverSheetsHyperLinkPlugin } from './plugin';
-export type { ICellHyperLink, ICellLinkContent } from './types/interfaces/i-hyper-link';
+export type { ICellLinkContent, ISheetHyperLink } from './types/interfaces/i-hyper-link';
 export { type ISheetHyperLinkInfo, type ISheetUrlParams, SheetsHyperLinkParserService } from './services/parser.service';
 export { ERROR_RANGE } from './types/const';
 export { AddHyperLinkCommand, AddRichHyperLinkCommand, type IAddHyperLinkCommandParams, type IAddRichHyperLinkCommandParams } from './commands/commands/add-hyper-link.command';