@univerjs/sheets-note 0.7.0-beta.1

package/lib/index.js

@@ -0,0 +1,438 @@
+var j = Object.defineProperty;
+var A = (i, r, e) => r in i ? j(i, r, { enumerable: !0, configurable: !0, writable: !0, value: e }) : i[r] = e;
+var d = (i, r, e) => A(i, typeof r != "symbol" ? r + "" : r, e);
+import { Disposable as S, ObjectMatrix as W, CommandType as l, Inject as _, ICommandService as g, sequenceExecuteAsync as L, IResourceManagerService as J, IUniverInstanceService as x, UniverInstanceType as U, DependentOn as H, IConfigService as z, Injector as G, Plugin as q, touchDependencies as y } from "@univerjs/core";
+import { RefRangeService as F, SheetsSelectionsService as R, handleCommonRangeChangeWithEffectRefCommandsSkipNoInterests as B, getSheetCommandTarget as D, UniverSheetsPlugin as K } from "@univerjs/sheets";
+import { Subject as Q, filter as O, map as $ } from "rxjs";
+class u extends S {
+  constructor() {
+    super(...arguments);
+    d(this, "_noteMatrix", /* @__PURE__ */ new Map());
+    d(this, "_change$", new Q());
+    d(this, "change$", this._change$.asObservable());
+  }
+  _ensureNoteMatrix(e, n) {
+    let t = this._noteMatrix.get(e);
+    t || (t = /* @__PURE__ */ new Map(), this._noteMatrix.set(e, t));
+    let s = t.get(n);
+    return s || (s = new W(), t.set(n, s)), s;
+  }
+  getSheetShowNotes$(e, n) {
+    return this._change$.pipe(
+      O(({ unitId: t, sheetId: s }) => t === e && s === n),
+      $(() => {
+        const t = this._ensureNoteMatrix(e, n), s = [];
+        return t.forValue((o, a, c) => {
+          c.show && s.push({ loc: { row: o, col: a, unitId: e, subUnitId: n }, note: c });
+        }), s;
+      })
+    );
+  }
+  getCellNoteChange$(e, n, t, s) {
+    return this._change$.pipe(
+      O(({ unitId: o, sheetId: a, row: c, col: h }) => o === e && a === n && c === t && h === s),
+      $(({ note: o }) => o)
+    );
+  }
+  updateNote(e, n, t, s, o, a) {
+    const c = this._ensureNoteMatrix(e, n), h = c.getValue(t, s);
+    c.setValue(t, s, o), this._change$.next({ unitId: e, sheetId: n, row: t, col: s, type: "update", note: o, oldNote: h, silent: a });
+  }
+  removeNote(e, n, t, s, o) {
+    const a = this._ensureNoteMatrix(e, n), c = a.getValue(t, s);
+    a.realDeleteValue(t, s), this._change$.next({ unitId: e, sheetId: n, row: t, col: s, type: "update", note: null, oldNote: c, silent: o });
+  }
+  toggleNotePopup(e, n, t, s, o) {
+    const a = this._ensureNoteMatrix(e, n), c = a.getValue(t, s);
+    if (c) {
+      c.show = !c.show;
+      const h = { ...c, show: c.show };
+      a.setValue(t, s, h), this._change$.next({
+        unitId: e,
+        sheetId: n,
+        row: t,
+        col: s,
+        type: "update",
+        note: h,
+        oldNote: c,
+        silent: o
+      });
+    }
+  }
+  updateNotePosition(e, n, t, s, o, a, c) {
+    const h = this._ensureNoteMatrix(e, n), p = h.getValue(t, s);
+    p && (h.realDeleteValue(t, s), h.setValue(o, a, p), this._change$.next({
+      unitId: e,
+      sheetId: n,
+      row: t,
+      col: s,
+      type: "ref",
+      newPosition: { row: o, col: a },
+      note: p,
+      silent: c
+    }));
+  }
+  getNote(e, n, t, s) {
+    return this._ensureNoteMatrix(e, n).getValue(t, s);
+  }
+  getUnitNotes(e) {
+    return this._noteMatrix.get(e);
+  }
+  getSheetNotes(e, n) {
+    const t = this._noteMatrix.get(e);
+    if (t)
+      return t.get(n);
+  }
+  getNotes() {
+    return this._noteMatrix;
+  }
+  deleteUnitNotes(e) {
+    this._noteMatrix.delete(e);
+  }
+}
+const I = {
+  id: "sheet.mutation.update-note",
+  type: l.MUTATION,
+  handler: (i, r) => {
+    const { unitId: e, sheetId: n, row: t, col: s, note: o, silent: a } = r;
+    return i.get(u).updateNote(e, n, t, s, o, a), !0;
+  }
+}, P = {
+  id: "sheet.mutation.remove-note",
+  type: l.MUTATION,
+  handler: (i, r) => {
+    const { unitId: e, sheetId: n, row: t, col: s, silent: o } = r;
+    return i.get(u).removeNote(e, n, t, s, o), !0;
+  }
+}, E = {
+  id: "sheet.mutation.toggle-note-popup",
+  type: l.MUTATION,
+  handler: (i, r) => {
+    const { unitId: e, sheetId: n, row: t, col: s, silent: o } = r;
+    return i.get(u).toggleNotePopup(e, n, t, s, o), !0;
+  }
+}, C = {
+  id: "sheet.mutation.update-note-position",
+  type: l.MUTATION,
+  handler: (i, r) => {
+    const { unitId: e, sheetId: n, row: t, col: s, newPosition: o, silent: a } = r;
+    return i.get(u).updateNotePosition(e, n, t, s, o.row, o.col, a), !0;
+  }
+};
+var X = Object.getOwnPropertyDescriptor, Y = (i, r, e, n) => {
+  for (var t = n > 1 ? void 0 : n ? X(r, e) : r, s = i.length - 1, o; s >= 0; s--)
+    (o = i[s]) && (t = o(t) || t);
+  return t;
+}, m = (i, r) => (e, n) => r(e, n, i);
+let N = class extends S {
+  constructor(r, e, n, t) {
+    super();
+    d(this, "_disposableMap", /* @__PURE__ */ new Map());
+    d(this, "_watcherMap", /* @__PURE__ */ new Map());
+    d(this, "_handleRangeChange", (r, e, n, t, s, o, a) => o ? {
+      redos: [{
+        id: C.id,
+        params: {
+          unitId: r,
+          sheetId: e,
+          row: t,
+          col: s,
+          newPosition: {
+            row: o.startRow,
+            col: o.startColumn
+          },
+          silent: a
+        }
+      }],
+      undos: [{
+        id: C.id,
+        params: {
+          unitId: r,
+          sheetId: e,
+          row: o.startRow,
+          col: o.startColumn,
+          newPosition: {
+            row: t,
+            col: s
+          },
+          note: n,
+          silent: a
+        }
+      }]
+    } : {
+      redos: [{
+        id: P.id,
+        params: {
+          unitId: r,
+          sheetId: e,
+          row: t,
+          col: s
+        }
+      }],
+      undos: [{
+        id: I.id,
+        params: {
+          unitId: r,
+          sheetId: e,
+          row: t,
+          col: s,
+          note: n
+        }
+      }]
+    });
+    this._refRangeService = r, this._sheetsNoteModel = e, this._selectionManagerService = n, this._commandService = t, this._initData(), this._initRefRange();
+  }
+  _getIdWithUnitId(r, e, n, t) {
+    return `${r}-${e}-${n}-${t}`;
+  }
+  _register(r, e, n, t, s) {
+    const o = {
+      startColumn: s,
+      endColumn: s,
+      startRow: t,
+      endRow: t
+    };
+    this._disposableMap.set(
+      this._getIdWithUnitId(r, e, t, s),
+      this._refRangeService.registerRefRange(o, (a) => {
+        const c = B(o, a, { selectionManagerService: this._selectionManagerService }), h = Array.isArray(c) ? c[0] : c;
+        return h && h.startColumn === o.startColumn && h.startRow === o.startRow ? {
+          undos: [],
+          redos: []
+        } : this._handleRangeChange(r, e, n, t, s, h, !1);
+      }, r, e)
+    );
+  }
+  _watch(r, e, n, t, s) {
+    const o = {
+      startColumn: s,
+      endColumn: s,
+      startRow: t,
+      endRow: t
+    };
+    this._watcherMap.set(
+      this._getIdWithUnitId(r, e, t, s),
+      this._refRangeService.watchRange(r, e, o, (a, c) => {
+        const { redos: h } = this._handleRangeChange(r, e, n, a.startRow, a.startColumn, c, !0);
+        L(h, this._commandService, { onlyLocal: !0 });
+      }, !0)
+    );
+  }
+  _unwatch(r, e, n, t) {
+    var o;
+    const s = this._getIdWithUnitId(r, e, n, t);
+    (o = this._watcherMap.get(s)) == null || o.dispose(), this._watcherMap.delete(s);
+  }
+  _unregister(r, e, n, t) {
+    var o;
+    const s = this._getIdWithUnitId(r, e, n, t);
+    (o = this._disposableMap.get(s)) == null || o.dispose(), this._disposableMap.delete(s);
+  }
+  _initData() {
+    const r = this._sheetsNoteModel.getNotes();
+    for (const [e, n] of r)
+      for (const [t, s] of n)
+        s.forValue((o, a, c) => (c && (this._register(e, t, c, o, a), this._watch(e, t, c, o, a)), !0));
+  }
+  _initRefRange() {
+    this.disposeWithMe(
+      this._sheetsNoteModel.change$.subscribe((r) => {
+        switch (r.type) {
+          case "update": {
+            const { unitId: e, sheetId: n, row: t, col: s, note: o } = r, a = this._getIdWithUnitId(e, n, t, s);
+            o ? this._disposableMap.has(a) || (this._register(e, n, o, t, s), this._watch(e, n, o, t, s)) : (this._unregister(e, n, t, s), this._unwatch(e, n, t, s));
+            break;
+          }
+          case "ref": {
+            const { unitId: e, sheetId: n, row: t, col: s, newPosition: o, note: a, silent: c } = r;
+            this._unregister(e, n, t, s), c || (this._unwatch(e, n, t, s), this._watch(e, n, a, o.row, o.col)), this._register(e, n, a, o.row, o.col);
+            break;
+          }
+        }
+      })
+    );
+  }
+};
+N = Y([
+  m(0, _(F)),
+  m(1, _(u)),
+  m(2, _(R)),
+  m(3, g)
+], N);
+var Z = Object.getOwnPropertyDescriptor, k = (i, r, e, n) => {
+  for (var t = n > 1 ? void 0 : n ? Z(r, e) : r, s = i.length - 1, o; s >= 0; s--)
+    (o = i[s]) && (t = o(t) || t);
+  return t;
+}, w = (i, r) => (e, n) => r(e, n, i);
+let M = class extends S {
+  constructor(i, r, e) {
+    super(), this._resourceManagerService = i, this._univerInstanceService = r, this._sheetsNoteModel = e, this._initSnapshot();
+  }
+  _initSnapshot() {
+    const i = (e) => {
+      const n = this._sheetsNoteModel.getUnitNotes(e);
+      if (!n)
+        return "";
+      const t = {};
+      return n.forEach((s, o) => {
+        const a = {};
+        s.forValue((c, h, p) => {
+          a[c] || (a[c] = {}), a[c][h] = p;
+        }), Object.keys(a).length > 0 && (t[o] = a);
+      }), JSON.stringify(t);
+    }, r = (e) => {
+      if (!e)
+        return {};
+      try {
+        return JSON.parse(e);
+      } catch {
+        return {};
+      }
+    };
+    this.disposeWithMe(
+      this._resourceManagerService.registerPluginResource({
+        pluginName: V,
+        businesses: [U.UNIVER_SHEET],
+        toJson: (e) => i(e),
+        parseJson: (e) => r(e),
+        onUnLoad: (e) => {
+          this._sheetsNoteModel.deleteUnitNotes(e);
+        },
+        onLoad: (e, n) => {
+          Object.entries(n).forEach(([t, s]) => {
+            Object.entries(s).forEach(([o, a]) => {
+              Object.entries(a).forEach(([c, h]) => {
+                this._sheetsNoteModel.updateNote(
+                  e,
+                  t,
+                  Number(o),
+                  Number(c),
+                  h
+                );
+              });
+            });
+          });
+        }
+      })
+    );
+  }
+};
+M = k([
+  w(0, J),
+  w(1, x),
+  w(2, _(u))
+], M);
+const ee = {
+  id: "sheet.command.delete-note",
+  type: l.COMMAND,
+  handler: (i, r) => {
+    const e = i.get(x), n = D(e);
+    if (!n) return !1;
+    const s = i.get(R).getCurrentLastSelection();
+    if (!(s != null && s.primary)) return !1;
+    const { actualColumn: o, actualRow: a } = s.primary;
+    return i.get(g).executeCommand(P.id, {
+      unitId: n.unitId,
+      sheetId: n.subUnitId,
+      row: a,
+      col: o
+    });
+  }
+}, te = {
+  id: "sheet.command.toggle-note-popup",
+  type: l.COMMAND,
+  handler: (i, r) => {
+    const e = i.get(x), n = D(e);
+    if (!n) return !1;
+    const s = i.get(R).getCurrentLastSelection();
+    if (!(s != null && s.primary)) return !1;
+    const { actualColumn: o, actualRow: a } = s.primary;
+    return i.get(g).executeCommand(E.id, {
+      unitId: n.unitId,
+      sheetId: n.subUnitId,
+      row: a,
+      col: o
+    });
+  }
+}, se = {
+  id: "sheet.command.update-note",
+  type: l.COMMAND,
+  handler: (i, r) => i.get(g).syncExecuteCommand(I.id, r)
+};
+var ne = Object.getOwnPropertyDescriptor, re = (i, r, e, n) => {
+  for (var t = n > 1 ? void 0 : n ? ne(r, e) : r, s = i.length - 1, o; s >= 0; s--)
+    (o = i[s]) && (t = o(t) || t);
+  return t;
+}, oe = (i, r) => (e, n) => r(e, n, i);
+let f = class extends S {
+  constructor(i) {
+    super(), this._commandService = i, this._initialize();
+  }
+  _initialize() {
+    [
+      C,
+      E,
+      I,
+      P,
+      ee,
+      te,
+      se
+    ].forEach((i) => {
+      this.disposeWithMe(
+        this._commandService.registerCommand(i)
+      );
+    });
+  }
+};
+f = re([
+  oe(0, g)
+], f);
+var ie = Object.defineProperty, ae = Object.getOwnPropertyDescriptor, ce = (i, r, e) => r in i ? ie(i, r, { enumerable: !0, configurable: !0, writable: !0, value: e }) : i[r] = e, he = (i, r, e, n) => {
+  for (var t = n > 1 ? void 0 : n ? ae(r, e) : r, s = i.length - 1, o; s >= 0; s--)
+    (o = i[s]) && (t = o(t) || t);
+  return t;
+}, b = (i, r) => (e, n) => r(e, n, i), T = (i, r, e) => ce(i, typeof r != "symbol" ? r + "" : r, e);
+const V = "SHEET_NOTE_PLUGIN";
+let v = class extends q {
+  constructor(i, r) {
+    super(), this._configService = i, this._injector = r;
+  }
+  onStarting() {
+    [
+      [u],
+      [f],
+      [M],
+      [N]
+    ].forEach((i) => {
+      this._injector.add(i);
+    }), y(this._injector, [
+      [u],
+      [f],
+      [M]
+    ]);
+  }
+  onReady() {
+    y(this._injector, [
+      [N]
+    ]);
+  }
+};
+T(v, "pluginName", V);
+T(v, "type", U.UNIVER_SHEET);
+v = he([
+  H(K),
+  b(0, z),
+  b(1, _(G))
+], v);
+export {
+  P as RemoveNoteMutation,
+  ee as SheetDeleteNoteCommand,
+  te as SheetToggleNotePopupCommand,
+  se as SheetUpdateNoteCommand,
+  u as SheetsNoteModel,
+  M as SheetsNoteResourceController,
+  E as ToggleNotePopupMutation,
+  v as UniverSheetsNotePlugin,
+  I as UpdateNoteMutation,
+  C as UpdateNotePositionMutation
+};

package/lib/types/commands/commands/note.command.d.ts

@@ -0,0 +1,5 @@
+import { ICommand } from '@univerjs/core';
+import { IUpdateNoteMutationParams } from '../mutations/note.mutation';
+export declare const SheetDeleteNoteCommand: ICommand;
+export declare const SheetToggleNotePopupCommand: ICommand;
+export declare const SheetUpdateNoteCommand: ICommand<IUpdateNoteMutationParams>;

package/lib/types/commands/mutations/note.mutation.d.ts

@@ -0,0 +1,39 @@
+import { IMutation } from '@univerjs/core';
+import { ISheetNote } from '../../models/sheets-note.model';
+export interface IUpdateNoteMutationParams {
+    unitId: string;
+    sheetId: string;
+    row: number;
+    col: number;
+    note: ISheetNote;
+    silent?: boolean;
+}
+export declare const UpdateNoteMutation: IMutation<IUpdateNoteMutationParams>;
+export interface IRemoveNoteMutationParams {
+    unitId: string;
+    sheetId: string;
+    row: number;
+    col: number;
+    silent?: boolean;
+}
+export declare const RemoveNoteMutation: IMutation<IRemoveNoteMutationParams>;
+export interface IToggleNotePopupMutationParams {
+    unitId: string;
+    sheetId: string;
+    row: number;
+    col: number;
+    silent?: boolean;
+}
+export declare const ToggleNotePopupMutation: IMutation<IToggleNotePopupMutationParams>;
+export interface IUpdateNotePositionMutationParams {
+    unitId: string;
+    sheetId: string;
+    row: number;
+    col: number;
+    newPosition: {
+        row: number;
+        col: number;
+    };
+    silent?: boolean;
+}
+export declare const UpdateNotePositionMutation: IMutation<IUpdateNotePositionMutationParams>;

package/lib/types/controllers/sheets-note-ref-range.controller.d.ts

@@ -0,0 +1,20 @@
+import { Disposable, ICommandService } from '@univerjs/core';
+import { RefRangeService, SheetsSelectionsService } from '@univerjs/sheets';
+import { SheetsNoteModel } from '../models/sheets-note.model';
+export declare class SheetsNoteRefRangeController extends Disposable {
+    private readonly _refRangeService;
+    private readonly _sheetsNoteModel;
+    private readonly _selectionManagerService;
+    private readonly _commandService;
+    private _disposableMap;
+    private _watcherMap;
+    constructor(_refRangeService: RefRangeService, _sheetsNoteModel: SheetsNoteModel, _selectionManagerService: SheetsSelectionsService, _commandService: ICommandService);
+    private _getIdWithUnitId;
+    private _handleRangeChange;
+    private _register;
+    private _watch;
+    private _unwatch;
+    private _unregister;
+    private _initData;
+    private _initRefRange;
+}

package/lib/types/controllers/sheets-note-resource.controller.d.ts

@@ -0,0 +1,9 @@
+import { Disposable, IResourceManagerService, IUniverInstanceService } from '@univerjs/core';
+import { SheetsNoteModel } from '../models/sheets-note.model';
+export declare class SheetsNoteResourceController extends Disposable {
+    private readonly _resourceManagerService;
+    private readonly _univerInstanceService;
+    private readonly _sheetsNoteModel;
+    constructor(_resourceManagerService: IResourceManagerService, _univerInstanceService: IUniverInstanceService, _sheetsNoteModel: SheetsNoteModel);
+    private _initSnapshot;
+}

package/lib/types/controllers/sheets.note.controller.d.ts

@@ -0,0 +1,6 @@
+import { Disposable, ICommandService } from '@univerjs/core';
+export declare class SheetsNoteController extends Disposable {
+    private readonly _commandService;
+    constructor(_commandService: ICommandService);
+    private _initialize;
+}