@univerjs/sheets-note 0.20.1 → 0.21.0

package/lib/facade.js

@@ -1 +1,305 @@
-import{FEventName as e,FUniver as t}from"@univerjs/core/facade";import{RemoveNoteMutation as n,SheetDeleteNoteCommand as r,SheetToggleNotePopupCommand as i,SheetUpdateNoteCommand as a,SheetsNoteModel as o,UpdateNoteMutation as s}from"@univerjs/sheets-note";import{FRange as c,FWorksheet as l}from"@univerjs/sheets/facade";import{CanceledError as u,ICommandService as d,IUniverInstanceService as f}from"@univerjs/core";import{SheetsSelectionsService as p,getSheetCommandTarget as m}from"@univerjs/sheets";var h=class extends e{get SheetNoteAdd(){return`SheetNoteAdd`}get SheetNoteDelete(){return`SheetNoteDelete`}get SheetNoteUpdate(){return`SheetNoteUpdate`}get SheetNoteShow(){return`SheetNoteShow`}get SheetNoteHide(){return`SheetNoteHide`}get BeforeSheetNoteAdd(){return`BeforeSheetNoteAdd`}get BeforeSheetNoteDelete(){return`BeforeSheetNoteDelete`}get BeforeSheetNoteUpdate(){return`BeforeSheetNoteUpdate`}get BeforeSheetNoteShow(){return`BeforeSheetNoteShow`}get BeforeSheetNoteHide(){return`BeforeSheetNoteHide`}};e.extend(h);var g=class extends c{createOrUpdateNote(e){return this._commandService.syncExecuteCommand(s.id,{unitId:this.getUnitId(),sheetId:this.getSheetId(),row:this.getRow(),col:this.getColumn(),note:e}),this}deleteNote(){return this._commandService.syncExecuteCommand(n.id,{unitId:this.getUnitId(),sheetId:this.getSheetId(),row:this.getRow(),col:this.getColumn()}),this}getNote(){return this._injector.get(o).getNote(this.getUnitId(),this.getSheetId(),{row:this.getRow(),col:this.getColumn()})}};c.extend(g);var _=class extends t{_initialize(e){let t=e.get(d);this.disposeWithMe(this.registerEventHandler(this.Event.SheetNoteAdd,()=>e.get(o).change$.subscribe(e=>{if(e.type===`update`&&!e.oldNote&&e.newNote){let{unitId:t,subUnitId:n,newNote:r}=e,i=this.getSheetTarget(t,n);if(!i)return;let{workbook:a,worksheet:o}=i,s={workbook:a,worksheet:o,row:r.row,col:r.col,note:r};this.fireEvent(this.Event.SheetNoteAdd,s)}}))),this.disposeWithMe(this.registerEventHandler(this.Event.SheetNoteDelete,()=>e.get(o).change$.subscribe(e=>{if(e.type===`update`&&e.oldNote&&!e.newNote){let{unitId:t,subUnitId:n,oldNote:r}=e,i=this.getSheetTarget(t,n);if(!i)return;let{workbook:a,worksheet:o}=i,s={workbook:a,worksheet:o,row:r.row,col:r.col,oldNote:r};this.fireEvent(this.Event.SheetNoteDelete,s)}}))),this.disposeWithMe(this.registerEventHandler(this.Event.SheetNoteUpdate,()=>e.get(o).change$.subscribe(e=>{if(e.type===`update`&&e.oldNote&&e.newNote){let{unitId:t,subUnitId:n,oldNote:r,newNote:i}=e,a=this.getSheetTarget(t,n);if(!a)return;let{workbook:o,worksheet:s}=a,c={workbook:o,worksheet:s,row:i.row,col:i.col,note:i,oldNote:r};this.fireEvent(this.Event.SheetNoteUpdate,c)}}))),this.disposeWithMe(this.registerEventHandler(this.Event.SheetNoteShow,()=>e.get(o).change$.subscribe(e=>{if(e.type===`update`&&e.oldNote&&e.newNote&&!e.oldNote.show&&e.newNote.show){let{unitId:t,subUnitId:n,newNote:r}=e,i=this.getSheetTarget(t,n);if(!i)return;let{workbook:a,worksheet:o}=i,s={workbook:a,worksheet:o,row:r.row,col:r.col};this.fireEvent(this.Event.SheetNoteShow,s)}}))),this.disposeWithMe(this.registerEventHandler(this.Event.SheetNoteHide,()=>e.get(o).change$.subscribe(e=>{if(e.type===`update`&&e.oldNote&&e.newNote&&e.oldNote.show&&!e.newNote.show){let{unitId:t,subUnitId:n,newNote:r}=e,i=this.getSheetTarget(t,n);if(!i)return;let{workbook:a,worksheet:o}=i,s={workbook:a,worksheet:o,row:r.row,col:r.col};this.fireEvent(this.Event.SheetNoteHide,s)}}))),this.disposeWithMe(this.registerEventHandler(this.Event.BeforeSheetNoteAdd,()=>t.beforeCommandExecuted(t=>{if(t.id===a.id){let{unitId:n,sheetId:r,row:i,col:a,note:s}=t.params,c=this.getSheetTarget(n,r);if(!c||e.get(o).getNote(n,r,{noteId:s.id,row:i,col:a}))return;let{workbook:l,worksheet:d}=c,f={workbook:l,worksheet:d,row:i,col:a,note:s};if(this.fireEvent(this.Event.BeforeSheetNoteAdd,f))throw new u}}))),this.disposeWithMe(this.registerEventHandler(this.Event.BeforeSheetNoteDelete,()=>t.beforeCommandExecuted(t=>{if(t.id===r.id){let{unitId:n,sheetId:r,row:i,col:a}=t.params,s=this.getSheetTarget(n,r);if(!s||i===void 0||a===void 0)return;let c=e.get(o).getNote(n,r,{row:i,col:a});if(!c)return;let{workbook:l,worksheet:d}=s,f={workbook:l,worksheet:d,row:i,col:a,oldNote:c};if(this.fireEvent(this.Event.BeforeSheetNoteDelete,f))throw new u}}))),this.disposeWithMe(this.registerEventHandler(this.Event.BeforeSheetNoteUpdate,()=>t.beforeCommandExecuted(t=>{if(t.id===a.id){let{unitId:n,sheetId:r,row:i,col:a,note:s}=t.params,c=this.getSheetTarget(n,r);if(!c)return;let l=e.get(o).getNote(n,r,{row:i,col:a});if(!l)return;let{workbook:d,worksheet:f}=c,p={workbook:d,worksheet:f,row:i,col:a,note:s,oldNote:l};if(this.fireEvent(this.Event.BeforeSheetNoteUpdate,p))throw new u}}))),this.disposeWithMe(this.registerEventHandler(this.Event.BeforeSheetNoteShow,()=>t.beforeCommandExecuted(t=>{if(t.id===i.id){let t=m(e.get(f));if(!t)return;let{unitId:n,subUnitId:r}=t,i=this.getUniverSheet(n);if(!i)return;let a=i.getSheetBySheetId(r);if(!a)return;let s=e.get(p).getCurrentLastSelection();if(!(s!=null&&s.primary))return;let c=e.get(o),{actualColumn:l,actualRow:d}=s.primary,h=c.getNote(n,r,{row:d,col:l});if(!h||h.show)return;let g={workbook:i,worksheet:a,row:d,col:l};if(this.fireEvent(this.Event.BeforeSheetNoteShow,g))throw new u}}))),this.disposeWithMe(this.registerEventHandler(this.Event.BeforeSheetNoteHide,()=>t.beforeCommandExecuted(t=>{if(t.id===i.id){let t=m(e.get(f));if(!t)return;let{unitId:n,subUnitId:r}=t,i=this.getUniverSheet(n);if(!i)return;let a=i.getSheetBySheetId(r);if(!a)return;let s=e.get(p).getCurrentLastSelection();if(!(s!=null&&s.primary))return;let c=e.get(o),{actualColumn:l,actualRow:d}=s.primary,h=c.getNote(n,r,{row:d,col:l});if(!h||!h.show)return;let g={workbook:i,worksheet:a,row:d,col:l};if(this.fireEvent(this.Event.BeforeSheetNoteHide,g))throw new u}})))}};t.extend(_);var v=class extends l{getNotes(){let e=this._injector.get(o).getSheetNotes(this.getWorkbook().getUnitId(),this.getSheetId());return e?Array.from(e.values()).map(e=>({...e})):[]}};l.extend(v);export{g as FRangeSheetsNoteMixin,h as FSheetsNoteEventNameMixin,_ as FUniverSheetsNoteMixin,v as FWorksheetNoteMixin};
+import { FEventName, FUniver } from "@univerjs/core/facade";
+import { RemoveNoteMutation, SheetDeleteNoteCommand, SheetToggleNotePopupCommand, SheetUpdateNoteCommand, SheetsNoteModel, UpdateNoteMutation } from "@univerjs/sheets-note";
+import { FRange, FWorksheet } from "@univerjs/sheets/facade";
+import { CanceledError, ICommandService, IUniverInstanceService } from "@univerjs/core";
+import { SheetsSelectionsService, getSheetCommandTarget } from "@univerjs/sheets";
+
+//#region src/facade/f-event.ts
+/**
+* @ignore
+*/
+var FSheetsNoteEventNameMixin = class extends FEventName {
+	get SheetNoteAdd() {
+		return "SheetNoteAdd";
+	}
+	get SheetNoteDelete() {
+		return "SheetNoteDelete";
+	}
+	get SheetNoteUpdate() {
+		return "SheetNoteUpdate";
+	}
+	get SheetNoteShow() {
+		return "SheetNoteShow";
+	}
+	get SheetNoteHide() {
+		return "SheetNoteHide";
+	}
+	get BeforeSheetNoteAdd() {
+		return "BeforeSheetNoteAdd";
+	}
+	get BeforeSheetNoteDelete() {
+		return "BeforeSheetNoteDelete";
+	}
+	get BeforeSheetNoteUpdate() {
+		return "BeforeSheetNoteUpdate";
+	}
+	get BeforeSheetNoteShow() {
+		return "BeforeSheetNoteShow";
+	}
+	get BeforeSheetNoteHide() {
+		return "BeforeSheetNoteHide";
+	}
+};
+FEventName.extend(FSheetsNoteEventNameMixin);
+
+//#endregion
+//#region src/facade/f-range.ts
+var FRangeSheetsNoteMixin = class extends FRange {
+	createOrUpdateNote(note) {
+		this._commandService.syncExecuteCommand(UpdateNoteMutation.id, {
+			unitId: this.getUnitId(),
+			sheetId: this.getSheetId(),
+			row: this.getRow(),
+			col: this.getColumn(),
+			note
+		});
+		return this;
+	}
+	deleteNote() {
+		this._commandService.syncExecuteCommand(RemoveNoteMutation.id, {
+			unitId: this.getUnitId(),
+			sheetId: this.getSheetId(),
+			row: this.getRow(),
+			col: this.getColumn()
+		});
+		return this;
+	}
+	getNote() {
+		return this._injector.get(SheetsNoteModel).getNote(this.getUnitId(), this.getSheetId(), {
+			row: this.getRow(),
+			col: this.getColumn()
+		});
+	}
+};
+FRange.extend(FRangeSheetsNoteMixin);
+
+//#endregion
+//#region src/facade/f-univer.ts
+var FUniverSheetsNoteMixin = class extends FUniver {
+	_initialize(injector) {
+		const commandService = injector.get(ICommandService);
+		this.disposeWithMe(this.registerEventHandler(this.Event.SheetNoteAdd, () => {
+			return injector.get(SheetsNoteModel).change$.subscribe((change) => {
+				if (change.type === "update" && !change.oldNote && change.newNote) {
+					const { unitId, subUnitId, newNote } = change;
+					const target = this.getSheetTarget(unitId, subUnitId);
+					if (!target) return;
+					const { workbook, worksheet } = target;
+					const eventParams = {
+						workbook,
+						worksheet,
+						row: newNote.row,
+						col: newNote.col,
+						note: newNote
+					};
+					this.fireEvent(this.Event.SheetNoteAdd, eventParams);
+				}
+			});
+		}));
+		this.disposeWithMe(this.registerEventHandler(this.Event.SheetNoteDelete, () => {
+			return injector.get(SheetsNoteModel).change$.subscribe((change) => {
+				if (change.type === "update" && change.oldNote && !change.newNote) {
+					const { unitId, subUnitId, oldNote } = change;
+					const target = this.getSheetTarget(unitId, subUnitId);
+					if (!target) return;
+					const { workbook, worksheet } = target;
+					const eventParams = {
+						workbook,
+						worksheet,
+						row: oldNote.row,
+						col: oldNote.col,
+						oldNote
+					};
+					this.fireEvent(this.Event.SheetNoteDelete, eventParams);
+				}
+			});
+		}));
+		this.disposeWithMe(this.registerEventHandler(this.Event.SheetNoteUpdate, () => {
+			return injector.get(SheetsNoteModel).change$.subscribe((change) => {
+				if (change.type === "update" && change.oldNote && change.newNote) {
+					const { unitId, subUnitId, oldNote, newNote } = change;
+					const target = this.getSheetTarget(unitId, subUnitId);
+					if (!target) return;
+					const { workbook, worksheet } = target;
+					const eventParams = {
+						workbook,
+						worksheet,
+						row: newNote.row,
+						col: newNote.col,
+						note: newNote,
+						oldNote
+					};
+					this.fireEvent(this.Event.SheetNoteUpdate, eventParams);
+				}
+			});
+		}));
+		this.disposeWithMe(this.registerEventHandler(this.Event.SheetNoteShow, () => {
+			return injector.get(SheetsNoteModel).change$.subscribe((change) => {
+				if (change.type === "update" && change.oldNote && change.newNote && !change.oldNote.show && change.newNote.show) {
+					const { unitId, subUnitId, newNote } = change;
+					const target = this.getSheetTarget(unitId, subUnitId);
+					if (!target) return;
+					const { workbook, worksheet } = target;
+					const eventParams = {
+						workbook,
+						worksheet,
+						row: newNote.row,
+						col: newNote.col
+					};
+					this.fireEvent(this.Event.SheetNoteShow, eventParams);
+				}
+			});
+		}));
+		this.disposeWithMe(this.registerEventHandler(this.Event.SheetNoteHide, () => {
+			return injector.get(SheetsNoteModel).change$.subscribe((change) => {
+				if (change.type === "update" && change.oldNote && change.newNote && change.oldNote.show && !change.newNote.show) {
+					const { unitId, subUnitId, newNote } = change;
+					const target = this.getSheetTarget(unitId, subUnitId);
+					if (!target) return;
+					const { workbook, worksheet } = target;
+					const eventParams = {
+						workbook,
+						worksheet,
+						row: newNote.row,
+						col: newNote.col
+					};
+					this.fireEvent(this.Event.SheetNoteHide, eventParams);
+				}
+			});
+		}));
+		this.disposeWithMe(this.registerEventHandler(this.Event.BeforeSheetNoteAdd, () => commandService.beforeCommandExecuted((command) => {
+			if (command.id === SheetUpdateNoteCommand.id) {
+				const { unitId, sheetId, row, col, note } = command.params;
+				const target = this.getSheetTarget(unitId, sheetId);
+				if (!target) return;
+				if (injector.get(SheetsNoteModel).getNote(unitId, sheetId, {
+					noteId: note.id,
+					row,
+					col
+				})) return;
+				const { workbook, worksheet } = target;
+				const eventParams = {
+					workbook,
+					worksheet,
+					row,
+					col,
+					note
+				};
+				if (this.fireEvent(this.Event.BeforeSheetNoteAdd, eventParams)) throw new CanceledError();
+			}
+		})));
+		this.disposeWithMe(this.registerEventHandler(this.Event.BeforeSheetNoteDelete, () => commandService.beforeCommandExecuted((command) => {
+			if (command.id === SheetDeleteNoteCommand.id) {
+				const { unitId, sheetId, row, col } = command.params;
+				const target = this.getSheetTarget(unitId, sheetId);
+				if (!target) return;
+				if (row === void 0 || col === void 0) return;
+				const oldNote = injector.get(SheetsNoteModel).getNote(unitId, sheetId, {
+					row,
+					col
+				});
+				if (!oldNote) return;
+				const { workbook, worksheet } = target;
+				const eventParams = {
+					workbook,
+					worksheet,
+					row,
+					col,
+					oldNote
+				};
+				if (this.fireEvent(this.Event.BeforeSheetNoteDelete, eventParams)) throw new CanceledError();
+			}
+		})));
+		this.disposeWithMe(this.registerEventHandler(this.Event.BeforeSheetNoteUpdate, () => commandService.beforeCommandExecuted((command) => {
+			if (command.id === SheetUpdateNoteCommand.id) {
+				const { unitId, sheetId, row, col, note } = command.params;
+				const target = this.getSheetTarget(unitId, sheetId);
+				if (!target) return;
+				const oldNote = injector.get(SheetsNoteModel).getNote(unitId, sheetId, {
+					row,
+					col
+				});
+				if (!oldNote) return;
+				const { workbook, worksheet } = target;
+				const eventParams = {
+					workbook,
+					worksheet,
+					row,
+					col,
+					note,
+					oldNote
+				};
+				if (this.fireEvent(this.Event.BeforeSheetNoteUpdate, eventParams)) throw new CanceledError();
+			}
+		})));
+		this.disposeWithMe(this.registerEventHandler(this.Event.BeforeSheetNoteShow, () => commandService.beforeCommandExecuted((command) => {
+			if (command.id === SheetToggleNotePopupCommand.id) {
+				const target = getSheetCommandTarget(injector.get(IUniverInstanceService));
+				if (!target) return;
+				const { unitId, subUnitId } = target;
+				const workbook = this.getUniverSheet(unitId);
+				if (!workbook) return;
+				const worksheet = workbook.getSheetBySheetId(subUnitId);
+				if (!worksheet) return;
+				const selection = injector.get(SheetsSelectionsService).getCurrentLastSelection();
+				if (!(selection === null || selection === void 0 ? void 0 : selection.primary)) return;
+				const sheetsNoteModel = injector.get(SheetsNoteModel);
+				const { actualColumn, actualRow } = selection.primary;
+				const note = sheetsNoteModel.getNote(unitId, subUnitId, {
+					row: actualRow,
+					col: actualColumn
+				});
+				if (!note || note.show) return;
+				const eventParams = {
+					workbook,
+					worksheet,
+					row: actualRow,
+					col: actualColumn
+				};
+				if (this.fireEvent(this.Event.BeforeSheetNoteShow, eventParams)) throw new CanceledError();
+			}
+		})));
+		this.disposeWithMe(this.registerEventHandler(this.Event.BeforeSheetNoteHide, () => commandService.beforeCommandExecuted((command) => {
+			if (command.id === SheetToggleNotePopupCommand.id) {
+				const target = getSheetCommandTarget(injector.get(IUniverInstanceService));
+				if (!target) return;
+				const { unitId, subUnitId } = target;
+				const workbook = this.getUniverSheet(unitId);
+				if (!workbook) return;
+				const worksheet = workbook.getSheetBySheetId(subUnitId);
+				if (!worksheet) return;
+				const selection = injector.get(SheetsSelectionsService).getCurrentLastSelection();
+				if (!(selection === null || selection === void 0 ? void 0 : selection.primary)) return;
+				const sheetsNoteModel = injector.get(SheetsNoteModel);
+				const { actualColumn, actualRow } = selection.primary;
+				const note = sheetsNoteModel.getNote(unitId, subUnitId, {
+					row: actualRow,
+					col: actualColumn
+				});
+				if (!note || !note.show) return;
+				const eventParams = {
+					workbook,
+					worksheet,
+					row: actualRow,
+					col: actualColumn
+				};
+				if (this.fireEvent(this.Event.BeforeSheetNoteHide, eventParams)) throw new CanceledError();
+			}
+		})));
+	}
+};
+FUniver.extend(FUniverSheetsNoteMixin);
+
+//#endregion
+//#region src/facade/f-worksheet.ts
+var FWorksheetNoteMixin = class extends FWorksheet {
+	getNotes() {
+		const notes = this._injector.get(SheetsNoteModel).getSheetNotes(this.getWorkbook().getUnitId(), this.getSheetId());
+		if (!notes) return [];
+		return Array.from(notes.values()).map((note) => ({ ...note }));
+	}
+};
+FWorksheet.extend(FWorksheetNoteMixin);
+
+//#endregion
+export { FRangeSheetsNoteMixin, FSheetsNoteEventNameMixin, FUniverSheetsNoteMixin, FWorksheetNoteMixin };