@univerjs/sheets-note 0.7.0-beta.1

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

@@ -0,0 +1,218 @@
+import { ISheetNote } from '@univerjs/sheets-note';
+import { FWorkbook, FWorksheet } from '@univerjs/sheets/facade';
+export interface ISheetNoteAddEventParmas {
+    workbook: FWorkbook;
+    worksheet: FWorksheet;
+    row: number;
+    col: number;
+    note: ISheetNote;
+    cancel?: boolean;
+}
+export interface ISheetNoteDeleteEventParmas {
+    workbook: FWorkbook;
+    worksheet: FWorksheet;
+    row: number;
+    col: number;
+    oldNote: ISheetNote;
+    cancel?: boolean;
+}
+export interface ISheetNoteUpdateEventParmas {
+    workbook: FWorkbook;
+    worksheet: FWorksheet;
+    row: number;
+    col: number;
+    note: ISheetNote;
+    oldNote: ISheetNote;
+    cancel?: boolean;
+}
+export interface ISheetNoteShowEventParmas {
+    workbook: FWorkbook;
+    worksheet: FWorksheet;
+    row: number;
+    col: number;
+    cancel?: boolean;
+}
+export interface ISheetNoteHideEventParmas {
+    workbook: FWorkbook;
+    worksheet: FWorksheet;
+    row: number;
+    col: number;
+    cancel?: boolean;
+}
+/**
+ * @ignore
+ */
+export interface ISheetsNoteEventParamConfig {
+    SheetNoteAdd: ISheetNoteAddEventParmas;
+    SheetNoteDelete: ISheetNoteDeleteEventParmas;
+    SheetNoteUpdate: ISheetNoteUpdateEventParmas;
+    SheetNoteShow: ISheetNoteShowEventParmas;
+    SheetNoteHide: ISheetNoteHideEventParmas;
+    BeforeSheetNoteAdd: ISheetNoteAddEventParmas;
+    BeforeSheetNoteDelete: ISheetNoteDeleteEventParmas;
+    BeforeSheetNoteUpdate: ISheetNoteUpdateEventParmas;
+    BeforeSheetNoteShow: ISheetNoteShowEventParmas;
+    BeforeSheetNoteHide: ISheetNoteHideEventParmas;
+}
+/**
+ * @ignore
+ */
+interface ISheetNoteEvent {
+    /**
+     * Event fired when a note is added
+     * @see {@link ISheetNoteAddEventParmas}
+     * @example
+     * ```ts
+     * const disposable = univerAPI.addEvent(univerAPI.Event.SheetNoteAdd, (params) => {
+     *   const { workbook, worksheet, row, col, note } = params;
+     *   console.log(params);
+     * });
+     * ```
+     */
+    SheetNoteAdd: 'SheetNoteAdd';
+    /**
+     * Event fired when a note is deleted
+     * @see {@link ISheetNoteDeleteEventParmas}
+     * @example
+     * ```ts
+     * const disposable = univerAPI.addEvent(univerAPI.Event.SheetNoteDelete, (params) => {
+     *   const { workbook, worksheet, row, col, oldNote } = params;
+     *   console.log(params);
+     * });
+     * ```
+     */
+    SheetNoteDelete: 'SheetNoteDelete';
+    /**
+     * Event fired when a note is updated
+     * @see {@link ISheetNoteUpdateEventParmas}
+     * @example
+     * ```ts
+     * const disposable = univerAPI.addEvent(univerAPI.Event.SheetNoteUpdate, (params) => {
+     *   const { workbook, worksheet, row, col, note, oldNote } = params;
+     *   console.log(params);
+     * });
+     * ```
+     */
+    SheetNoteUpdate: 'SheetNoteUpdate';
+    /**
+     * Event fired when a note is shown
+     * @see {@link ISheetNoteShowEventParmas}
+     * @example
+     * ```ts
+     * const disposable = univerAPI.addEvent(univerAPI.Event.SheetNoteShow, (params) => {
+     *   const { workbook, worksheet, row, col } = params;
+     *   console.log(params);
+     * });
+     * ```
+     */
+    SheetNoteShow: 'SheetNoteShow';
+    /**
+     * Event fired when a note is hidden
+     * @see {@link ISheetNoteHideEventParmas}
+     * @example
+     * ```ts
+     * const disposable = univerAPI.addEvent(univerAPI.Event.SheetNoteHide, (params) => {
+     *   const { workbook, worksheet, row, col } = params;
+     *   console.log(params);
+     * });
+     * ```
+     */
+    SheetNoteHide: 'SheetNoteHide';
+    /**
+     * Event fired before a note is added
+     * @see {@link ISheetNoteAddEventParmas}
+     * @example
+     * ```ts
+     * const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetNoteAdd, (params) => {
+     *   const { workbook, worksheet, row, col, note } = params;
+     *   console.log(params);
+     * });
+     * ```
+     */
+    BeforeSheetNoteAdd: 'BeforeSheetNoteAdd';
+    /**
+     * Event fired before a note is deleted
+     * @see {@link ISheetNoteDeleteEventParmas}
+     * @example
+     * ```ts
+     * const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetNoteDelete, (params) => {
+     *   const { workbook, worksheet, row, col, oldNote } = params;
+     *   console.log(params);
+     * });
+     * ```
+     */
+    BeforeSheetNoteDelete: 'BeforeSheetNoteDelete';
+    /**
+     * Event fired before a note is updated
+     * @see {@link ISheetNoteUpdateEventParmas}
+     * @example
+     * ```ts
+     * const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetNoteUpdate, (params) => {
+     *   const { workbook, worksheet, row, col, note, oldNote } = params;
+     *   console.log(params);
+     * });
+     * ```
+     */
+    BeforeSheetNoteUpdate: 'BeforeSheetNoteUpdate';
+    /**
+     * Event fired before a note is shown
+     * @see {@link ISheetNoteShowEventParmas}
+     * @example
+     * ```ts
+     * const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetNoteShow, (params) => {
+     *   const { workbook, worksheet, row, col } = params;
+     *   console.log(params);
+     * });
+     * ```
+     */
+    BeforeSheetNoteShow: 'BeforeSheetNoteShow';
+    /**
+     * Event fired before a note is hidden
+     * @see {@link ISheetNoteHideEventParmas}
+     * @example
+     * ```ts
+     * const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetNoteHide, (params) => {
+     *   const { workbook, worksheet, row, col } = params;
+     *   console.log(params);
+     * });
+     * ```
+     */
+    BeforeSheetNoteHide: 'BeforeSheetNoteHide';
+}
+/**
+ * @ignore
+ */
+export declare class FSheetNoteEvent implements ISheetNoteEvent {
+    get SheetNoteAdd(): 'SheetNoteAdd';
+    get SheetNoteDelete(): 'SheetNoteDelete';
+    get SheetNoteUpdate(): 'SheetNoteUpdate';
+    get SheetNoteShow(): 'SheetNoteShow';
+    get SheetNoteHide(): 'SheetNoteHide';
+    get BeforeSheetNoteAdd(): 'BeforeSheetNoteAdd';
+    get BeforeSheetNoteDelete(): 'BeforeSheetNoteDelete';
+    get BeforeSheetNoteUpdate(): 'BeforeSheetNoteUpdate';
+    get BeforeSheetNoteShow(): 'BeforeSheetNoteShow';
+    get BeforeSheetNoteHide(): 'BeforeSheetNoteHide';
+}
+/**
+ * @ignore
+ */
+export interface ISheetNoteEventConfig {
+    SheetNoteAdd: ISheetNoteAddEventParmas;
+    SheetNoteDelete: ISheetNoteDeleteEventParmas;
+    SheetNoteUpdate: ISheetNoteUpdateEventParmas;
+    SheetNoteShow: ISheetNoteShowEventParmas;
+    SheetNoteHide: ISheetNoteHideEventParmas;
+    BeforeSheetNoteAdd: ISheetNoteAddEventParmas;
+    BeforeSheetNoteDelete: ISheetNoteDeleteEventParmas;
+    BeforeSheetNoteUpdate: ISheetNoteUpdateEventParmas;
+    BeforeSheetNoteShow: ISheetNoteShowEventParmas;
+    BeforeSheetNoteHide: ISheetNoteHideEventParmas;
+}
+declare module '@univerjs/core/facade' {
+    interface FEventName extends ISheetNoteEvent {
+    }
+    interface IEventParamConfig extends ISheetNoteEventConfig {
+    }
+}
+export {};

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

@@ -0,0 +1,51 @@
+import { Nullable } from '@univerjs/core';
+import { ISheetNote } from '@univerjs/sheets-note';
+import { FRange } from '@univerjs/sheets/facade';
+export interface IFSheetsNoteRange {
+    /**
+     * get the note of the primary cell
+     * @returns {Nullable<ISheetNote>} the note of the primary cell
+     * @example
+     * ```ts
+     * const fWorkbook = univerAPI.getWorkbook();
+     * const fWorksheet = fWorkbook.getWorksheet();
+     * const fRange = fWorksheet.getRange(0, 0, 1, 1);
+     * const note = fRange.getNote();
+     * ```
+     */
+    getNote(): Nullable<ISheetNote>;
+    /**
+     * create a new note and attach to the primary cell
+     * @param {ISheetNote} note the note to create
+     * @returns {FRange} the range
+     * @example
+     * ```ts
+     * const fWorkbook = univerAPI.getWorkbook();
+     * const fWorksheet = fWorkbook.getWorksheet();
+     * const fRange = fWorksheet.getRange(0, 0, 1, 1);
+     * const note = fRange.createOrUpdateNote({});
+     * ```
+     */
+    createOrUpdateNote(note: ISheetNote): FRange;
+    /**
+     * delete the note of the primary cell
+     * @returns {FRange} the range
+     * @example
+     * ```ts
+     * const fWorkbook = univerAPI.getWorkbook();
+     * const fWorksheet = fWorkbook.getWorksheet();
+     * const fRange = fWorksheet.getRange(0, 0, 1, 1);
+     * fRange.deleteNote();
+     * ```
+     */
+    deleteNote(): FRange;
+}
+export declare class FSheetsNoteRange extends FRange implements IFSheetsNoteRange {
+    createOrUpdateNote(note: ISheetNote): FRange;
+    deleteNote(): FRange;
+    getNote(): Nullable<ISheetNote>;
+}
+declare module '@univerjs/sheets/facade' {
+    interface IRange extends FSheetsNoteRange {
+    }
+}

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

@@ -0,0 +1,14 @@
+import { Injector } from '@univerjs/core';
+import { FUniver } from '@univerjs/core/facade';
+/**
+ * @ignore
+ */
+export interface IFUniverSheetNoteMixin {
+}
+export declare class FUniverSheetNoteMixin extends FUniver implements IFUniverSheetNoteMixin {
+    _initialize(injector: Injector): void;
+}
+declare module '@univerjs/core/facade' {
+    interface FUniver extends IFUniverSheetNoteMixin {
+    }
+}

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

@@ -0,0 +1,19 @@
+import { ISheetNote } from '@univerjs/sheets-note';
+import { FWorksheet } from '@univerjs/sheets/facade';
+export interface ISheetNoteInfo extends ISheetNote {
+    row: number;
+    col: number;
+}
+export interface IFSheetsNoteWorksheet {
+    /**
+     * get the note of the primary cell
+     */
+    getNotes(): ISheetNoteInfo[];
+}
+export declare class FSheetsNoteWorksheet extends FWorksheet implements IFSheetsNoteWorksheet {
+    getNotes(): ISheetNoteInfo[];
+}
+declare module '@univerjs/sheets/facade' {
+    interface IWorksheet extends FSheetsNoteWorksheet {
+    }
+}

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

@@ -0,0 +1,23 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import './f-event';
+import './f-range';
+import './f-univer';
+import './f-worksheet';
+export * from './f-event';
+export * from './f-range';
+export * from './f-univer';
+export * from './f-worksheet';

package/lib/types/index.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export { UniverSheetsNotePlugin } from './plugin';
+export * from './models/sheets-note.model';
+export * from './controllers/sheets-note-resource.controller';
+export * from './commands/mutations/note.mutation';
+export * from './commands/commands/note.command';

package/lib/types/models/sheets-note.model.d.ts

@@ -0,0 +1,46 @@
+import { Nullable, Disposable, ObjectMatrix } from '@univerjs/core';
+import { ISheetLocationBase } from '@univerjs/sheets';
+export interface ISheetNote {
+    width: number;
+    height: number;
+    note: string;
+    show?: boolean;
+}
+export type ISheetNoteChange = {
+    unitId: string;
+    sheetId: string;
+    row: number;
+    col: number;
+    silent?: boolean;
+} & ({
+    type: 'update';
+    note: Nullable<ISheetNote>;
+    oldNote: Nullable<ISheetNote>;
+} | {
+    type: 'ref';
+    newPosition: {
+        row: number;
+        col: number;
+    };
+    note: ISheetNote;
+});
+export declare class SheetsNoteModel extends Disposable {
+    private _noteMatrix;
+    private readonly _change$;
+    readonly change$: import('rxjs').Observable<ISheetNoteChange>;
+    private _ensureNoteMatrix;
+    getSheetShowNotes$(unitId: string, sheetId: string): import('rxjs').Observable<{
+        loc: ISheetLocationBase;
+        note: ISheetNote;
+    }[]>;
+    getCellNoteChange$(unitId: string, sheetId: string, row: number, col: number): import('rxjs').Observable<Nullable<ISheetNote>>;
+    updateNote(unitId: string, sheetId: string, row: number, col: number, note: ISheetNote, silent?: boolean): void;
+    removeNote(unitId: string, sheetId: string, row: number, col: number, silent?: boolean): void;
+    toggleNotePopup(unitId: string, sheetId: string, row: number, col: number, silent?: boolean): void;
+    updateNotePosition(unitId: string, sheetId: string, row: number, col: number, newRow: number, newCol: number, silent?: boolean): void;
+    getNote(unitId: string, sheetId: string, row: number, col: number): Nullable<ISheetNote>;
+    getUnitNotes(unitId: string): Map<string, ObjectMatrix<ISheetNote>> | undefined;
+    getSheetNotes(unitId: string, sheetId: string): ObjectMatrix<ISheetNote> | undefined;
+    getNotes(): Map<string, Map<string, ObjectMatrix<ISheetNote>>>;
+    deleteUnitNotes(unitId: string): void;
+}

package/lib/types/plugin.d.ts

@@ -0,0 +1,11 @@
+import { IConfigService, Injector, Plugin, UniverInstanceType } from '@univerjs/core';
+export declare const PLUGIN_NAME = "SHEET_NOTE_PLUGIN";
+export declare class UniverSheetsNotePlugin extends Plugin {
+    private readonly _configService;
+    protected readonly _injector: Injector;
+    static pluginName: string;
+    static type: UniverInstanceType;
+    constructor(_configService: IConfigService, _injector: Injector);
+    onStarting(): void;
+    onReady(): void;
+}

package/lib/umd/facade.js

@@ -0,0 +1 @@
+(function(a,m){typeof exports=="object"&&typeof module<"u"?m(exports,require("@univerjs/core/facade"),require("@univerjs/sheets-note"),require("@univerjs/sheets/facade"),require("@univerjs/core")):typeof define=="function"&&define.amd?define(["exports","@univerjs/core/facade","@univerjs/sheets-note","@univerjs/sheets/facade","@univerjs/core"],m):(a=typeof globalThis<"u"?globalThis:a||self,m(a.UniverSheetsNoteFacade={},a.UniverCoreFacade,a.UniverSheetsNote,a.UniverSheetsFacade,a.UniverCore))})(this,function(a,m,h,f,g){"use strict";class w{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"}}m.FEventName.extend(w);class E extends f.FRange{createOrUpdateNote(c){return this._commandService.syncExecuteCommand(h.UpdateNoteMutation.id,{unitId:this.getUnitId(),sheetId:this.getSheetId(),row:this.getRow(),col:this.getColumn(),note:c}),this}deleteNote(){return this._injector.get(h.SheetsNoteModel),this._commandService.syncExecuteCommand(h.RemoveNoteMutation.id,{unitId:this.getUnitId(),sheetId:this.getSheetId(),row:this.getRow(),col:this.getColumn()}),this}getNote(){return this._injector.get(h.SheetsNoteModel).getNote(this.getUnitId(),this.getSheetId(),this.getRow(),this.getColumn())}}f.FRange.extend(E);class I extends m.FUniver{_initialize(c){this.registerEventHandler(this.Event.SheetNoteAdd,()=>c.get(h.SheetsNoteModel).change$.subscribe(e=>{if(e.type==="update"&&!e.oldNote&&e.note){const{unitId:d,sheetId:t,row:o,col:i,note:r,oldNote:s}=e,n=this.getSheetTarget(d,t);if(!n)return;const{workbook:S,worksheet:l}=n;this.fireEvent(this.Event.SheetNoteAdd,{workbook:S,worksheet:l,row:o,col:i,note:r})}})),this.registerEventHandler(this.Event.SheetNoteDelete,()=>c.get(h.SheetsNoteModel).change$.subscribe(e=>{if(e.type==="update"&&e.oldNote&&!e.note){const{unitId:d,sheetId:t,row:o,col:i,note:r,oldNote:s}=e,n=this.getSheetTarget(d,t);if(!n)return;const{workbook:S,worksheet:l}=n;this.fireEvent(this.Event.SheetNoteDelete,{workbook:S,worksheet:l,row:o,col:i,oldNote:s})}})),this.registerEventHandler(this.Event.SheetNoteUpdate,()=>c.get(h.SheetsNoteModel).change$.subscribe(e=>{if(e.type==="update"&&e.oldNote&&e.note){const{unitId:d,sheetId:t,row:o,col:i,note:r,oldNote:s}=e,n=this.getSheetTarget(d,t);if(!n)return;const{workbook:S,worksheet:l}=n;this.fireEvent(this.Event.SheetNoteUpdate,{workbook:S,worksheet:l,row:o,col:i,note:r,oldNote:s})}})),this.registerEventHandler(this.Event.SheetNoteShow,()=>c.get(h.SheetsNoteModel).change$.subscribe(e=>{if(e.type==="update"&&e.oldNote&&e.note&&!e.oldNote.show&&e.note.show){const{unitId:d,sheetId:t,row:o,col:i}=e,r=this.getSheetTarget(d,t);if(!r)return;const{workbook:s,worksheet:n}=r;this.fireEvent(this.Event.SheetNoteShow,{workbook:s,worksheet:n,row:o,col:i})}})),this.registerEventHandler(this.Event.SheetNoteHide,()=>c.get(h.SheetsNoteModel).change$.subscribe(e=>{if(e.type==="update"&&e.oldNote&&e.note&&e.oldNote.show&&!e.note.show){const{unitId:d,sheetId:t,row:o,col:i}=e,r=this.getSheetTarget(d,t);if(!r)return;const{workbook:s,worksheet:n}=r;this.fireEvent(this.Event.SheetNoteHide,{workbook:s,worksheet:n,row:o,col:i})}})),this.registerEventHandler(this.Event.BeforeSheetNoteAdd,()=>c.get(g.ICommandService).beforeCommandExecuted(e=>{if(e.id===h.SheetUpdateNoteCommand.id){const d=c.get(h.SheetsNoteModel),{unitId:t,sheetId:o,row:i,col:r,note:s}=e.params;if(d.getNote(t,o,i,r))return;const S=this.getSheetTarget(t,o);if(!S)return;const{workbook:l,worksheet:v}=S;if(this.fireEvent(this.Event.BeforeSheetNoteAdd,{workbook:l,worksheet:v,row:i,col:r,note:s}))throw new g.CanceledError}})),this.registerEventHandler(this.Event.BeforeSheetNoteDelete,()=>c.get(g.ICommandService).beforeCommandExecuted(e=>{if(e.id===h.SheetDeleteNoteCommand.id){const d=c.get(h.SheetsNoteModel),{unitId:t,sheetId:o,row:i,col:r}=e.params,s=d.getNote(t,o,i,r);if(!s)return;const n=this.getSheetTarget(t,o);if(!n)return;const{workbook:S,worksheet:l}=n;if(this.fireEvent(this.Event.BeforeSheetNoteDelete,{workbook:S,worksheet:l,row:i,col:r,oldNote:s}))throw new g.CanceledError}})),this.registerEventHandler(this.Event.BeforeSheetNoteUpdate,()=>c.get(g.ICommandService).beforeCommandExecuted(e=>{if(e.id===h.SheetUpdateNoteCommand.id){const d=c.get(h.SheetsNoteModel),{unitId:t,sheetId:o,row:i,col:r,note:s}=e.params,n=d.getNote(t,o,i,r);if(!n)return;const S=this.getSheetTarget(t,o);if(!S)return;const{workbook:l,worksheet:v}=S;if(this.fireEvent(this.Event.BeforeSheetNoteUpdate,{workbook:l,worksheet:v,row:i,col:r,note:s,oldNote:n}))throw new g.CanceledError}})),this.registerEventHandler(this.Event.BeforeSheetNoteShow,()=>c.get(g.ICommandService).beforeCommandExecuted(e=>{if(e.id===h.SheetToggleNotePopupCommand.id){const d=c.get(h.SheetsNoteModel),{unitId:t,sheetId:o,row:i,col:r}=e.params,s=d.getNote(t,o,i,r);if(s!=null&&s.show)return;const n=this.getSheetTarget(t,o);if(!n)return;const{workbook:S,worksheet:l}=n;if(this.fireEvent(this.Event.BeforeSheetNoteShow,{workbook:S,worksheet:l,row:i,col:r}))throw new g.CanceledError}})),this.registerEventHandler(this.Event.BeforeSheetNoteHide,()=>c.get(g.ICommandService).beforeCommandExecuted(e=>{if(e.id===h.SheetToggleNotePopupCommand.id){const d=c.get(h.SheetsNoteModel),{unitId:t,sheetId:o,row:i,col:r}=e.params,s=d.getNote(t,o,i,r);if(!(s!=null&&s.show))return;const n=this.getSheetTarget(t,o);if(!n)return;const{workbook:S,worksheet:l}=n;if(this.fireEvent(this.Event.BeforeSheetNoteHide,{workbook:S,worksheet:l,row:i,col:r}))throw new g.CanceledError}}))}}m.FUniver.extend(I);class k extends f.FWorksheet{getNotes(){const u=this._injector.get(h.SheetsNoteModel).getSheetNotes(this.getWorkbook().getUnitId(),this.getSheetId()),e=[];return u==null||u.forValue((d,t,o)=>{e.push({...o,row:d,col:t})}),e}}f.FWorksheet.extend(k),a.FSheetNoteEvent=w,a.FSheetsNoteRange=E,a.FSheetsNoteWorksheet=k,a.FUniverSheetNoteMixin=I,Object.defineProperty(a,Symbol.toStringTag,{value:"Module"})});

package/lib/umd/index.js

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

package/package.json

@@ -0,0 +1,77 @@
+{
+  "name": "@univerjs/sheets-note",
+  "version": "0.7.0-beta.1",
+  "private": false,
+  "description": "Univer sheets note base plugin",
+  "author": "DreamNum <developer@univer.ai>",
+  "license": "Apache-2.0",
+  "funding": {
+    "type": "opencollective",
+    "url": "https://opencollective.com/univer"
+  },
+  "homepage": "https://univer.ai",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dream-num/univer"
+  },
+  "bugs": {
+    "url": "https://github.com/dream-num/univer/issues"
+  },
+  "keywords": [],
+  "exports": {
+    ".": {
+      "import": "./lib/es/index.js",
+      "require": "./lib/cjs/index.js",
+      "types": "./lib/types/index.d.ts"
+    },
+    "./*": {
+      "import": "./lib/es/*",
+      "require": "./lib/cjs/*",
+      "types": "./lib/types/index.d.ts"
+    },
+    "./facade": {
+      "import": "./lib/es/facade.js",
+      "require": "./lib/cjs/facade.js",
+      "types": "./lib/types/facade/index.d.ts"
+    },
+    "./lib/facade": {
+      "import": "./lib/es/facade.js",
+      "require": "./lib/cjs/facade.js",
+      "types": "./lib/types/facade/index.d.ts"
+    },
+    "./lib/*": "./lib/*"
+  },
+  "main": "./lib/es/index.js",
+  "types": "./lib/types/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "directories": {
+    "lib": "lib"
+  },
+  "files": [
+    "lib"
+  ],
+  "peerDependencies": {
+    "rxjs": ">=7.0.0"
+  },
+  "dependencies": {
+    "@univerjs/core": "0.7.0-beta.1",
+    "@univerjs/sheets": "0.7.0-beta.1"
+  },
+  "devDependencies": {
+    "rxjs": "^7.8.1",
+    "typescript": "^5.8.3",
+    "vite": "^6.3.5",
+    "vitest": "^3.1.3",
+    "@univerjs-infra/shared": "0.7.0-beta.1"
+  },
+  "scripts": {
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "coverage": "vitest run --coverage",
+    "lint:types": "tsc --noEmit",
+    "build": "univer-cli build"
+  },
+  "module": "./lib/es/index.js"
+}