@univerjs/sheets-source-binding 0.5.4-nightly.202501150735

package/README.md

@@ -0,0 +1,16 @@
+# @univerjs/sheets-source-binding
+
+[![npm version](https://img.shields.io/npm/v/@univerjs/sheets-source-binding)](https://npmjs.org/packages/@univerjs/sheets-source-binding)
+[![license](https://img.shields.io/npm/l/@univerjs/sheets-source-binding)](https://img.shields.io/npm/l/@univerjs/sheets-source-binding)
+
+## Introduction
+
+> TODO: Introduction
+
+## Usage
+
+### Installation
+
+```shell
+npm i @univerjs/sheets-source-binding
+```

package/lib/cjs/facade.js

@@ -0,0 +1 @@
+"use strict";const d=require("@univerjs/core"),n=require("@univerjs/sheets-source-binding"),r=require("@univerjs/sheets/facade");class S extends d.FEnum{get DataBindingNodeTypeEnum(){return n.DataBindingNodeTypeEnum}get BindModeEnum(){return n.BindModeEnum}}d.FEnum.extend(S);class u extends r.FWorkbook{createSource(e,t){return this._injector.get(n.SheetsSourceBindService).createSource(this.getId(),e,t)}getSource(e){return this._injector.get(n.SheetsSourceBindService).getSource(this.getId(),e)}usePathMode(){this._injector.get(n.SheetsSourceBindService).usePathMode()}useValueMode(){this._injector.get(n.SheetsSourceBindService).useValueMode()}}r.FWorkbook.extend(u);class h extends r.FWorksheet{setBindingNode(e){const o=this._injector.get(n.SheetsSourceBindService),i=this._workbook.getUnitId();o.setBindingNode(i,this.getSheetId(),e)}removeBindingNode(e,t){const i=this._injector.get(n.SheetsSourceBindService),c=this._workbook.getUnitId();i.removeBindingNode(c,this.getSheetId(),e,t)}getBindingNode(e,t){const i=this._injector.get(n.SheetsSourceBindService),c=this._workbook.getUnitId();return i.getBindingNode(c,this.getSheetId(),e,t)}}r.FWorksheet.extend(h);

package/lib/cjs/index.js

@@ -0,0 +1 @@
+"use strict";var j=Object.defineProperty;var O=(d,r,e)=>r in d?j(d,r,{enumerable:!0,configurable:!0,writable:!0,value:e}):d[r]=e;var u=(d,r,e)=>O(d,typeof r!="symbol"?r+"":r,e);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const h=require("@univerjs/core"),U=require("rxjs"),y=require("@univerjs/sheets");class w{constructor(r){u(this,"_matrix",{});u(this,"_nodeMap",new Map);u(this,"_sourceIdMap",new Map);r&&this._init(r)}_init(r){this.fromJSON()}getBindingNodesBySourceId(r){const e=this._sourceIdMap.get(r);if(e)return e.map(t=>this._nodeMap.get(t))}setBindingNode(r,e,t){this._matrix[r]||(this._matrix[r]={}),this._matrix[r][e]||(this._matrix[r][e]=t),this._nodeMap.set(t.nodeId,t);const n=this._sourceIdMap.get(t.sourceId);n?n.push(t.nodeId):this._sourceIdMap.set(t.sourceId,[t.nodeId])}getBindingNode(r,e){var t;return(t=this._matrix[r])==null?void 0:t[e]}removeBindingNode(r,e){var n;const t=(n=this._matrix[r])==null?void 0:n[e];if(t){this._matrix[r][e]=void 0,this._nodeMap.delete(t.nodeId);const o=this._sourceIdMap.get(t.sourceId);if(o){const s=o.indexOf(t.nodeId);s>=0&&o.splice(s,1),o.length===0&&this._sourceIdMap.delete(t.sourceId)}}}getBindingNodeById(r){return this._nodeMap.get(r)}fromJSON(){}toJSON(){}}var S=(d=>(d.List="list",d.Object="object",d))(S||{}),m=(d=>(d.Path="path",d.Value="value",d))(m||{}),M=(d=>(d.Add="add",d.Remove="remove",d.Update="update",d))(M||{});class b{constructor(r){u(this,"_data");u(this,"id");u(this,"_hasData",!1);u(this,"type");this.id=r}getId(){return this.id}getType(){return this.type}hasData(){return this._hasData}setSourceData(r){this._data=r,this._hasData=!0}}class $ extends b{constructor(e,t){super(e);u(this,"type",S.List);u(this,"_isListObject");u(this,"_fieldIndexMap",new Map);u(this,"_data",{fields:[],records:[]});this._isListObject=t!=null?t:!0}toggleListObject(e){this._isListObject=e}getData(e,t){const{path:n,row:o}=e,s=this._fieldIndexMap.get(n),i=t-o;return i===0?this._data.fields[s]:this._isListObject?this._data.records[i-1][n]:this._data.records[i-1][s]}setSourceData(e){super.setSourceData(e);const{fields:t}=e;this._fieldIndexMap.clear(),t.forEach((n,o)=>{this._fieldIndexMap.set(n,o)})}getSourceInfo(){return{sourceId:this.id,sourceType:this.type,fields:this._data.fields,recordCount:this._data.records.length}}}class E extends b{constructor(e){super(e);u(this,"type",S.Object)}getData(e){const n=e.path.split(".");let o=this._data;for(const s of n)if(o=o[s],o===void 0)return null;return o}getSourceInfo(){return{sourceId:this.id,sourceType:S.Object}}}class T extends h.Disposable{constructor(){super();u(this,"modelMap",new Map);u(this,"_cellBindInfoUpdate$",new U.Subject);u(this,"cellBindInfoUpdate$",this._cellBindInfoUpdate$.asObservable())}getBindingModelBySourceId(e){const t=[];return this.modelMap.forEach((n,o)=>{n.forEach((s,i)=>{const c=s.getBindingNodesBySourceId(e);if(c)for(const a of c)t.push({unitId:o,subunitId:i,sourceId:e,nodeId:a.nodeId,row:a.row,column:a.column})})}),t}addModel(e,t,n){var o;this.modelMap.has(e)||this.modelMap.set(e,new Map),(o=this.modelMap.get(e))==null||o.set(t,n)}getModel(e,t){var n;return(n=this.modelMap.get(e))==null?void 0:n.get(t)}setBindingNode(e,t,n){let o=this.getModel(e,t);o||(o=new w,this.addModel(e,t,o)),n.nodeId||(n.nodeId=h.generateRandomId());const{row:s,column:i}=n;if(s===void 0||i===void 0)throw new Error("row and column is required");const c=o.getBindingNode(s,i);o.setBindingNode(s,i,{...n,row:s,column:i}),this._cellBindInfoUpdate$.next({unitId:e,subunitId:t,sourceId:n.sourceId,nodeId:n.nodeId,row:s,column:i,changeType:c?M.Update:M.Add,oldSourceId:c==null?void 0:c.sourceId})}removeBindingNode(e,t,n,o){const s=this.getModel(e,t);if(s){const i=s.getBindingNode(n,o);i&&(s.removeBindingNode(n,o),this._cellBindInfoUpdate$.next({unitId:e,subunitId:t,sourceId:i.sourceId,nodeId:i.nodeId,row:n,column:o,changeType:M.Remove}))}}getBindingNode(e,t,n,o){const s=this.getModel(e,t);if(s)return s.getBindingNode(n,o)}createModel(e,t,n){const o=new w(n);return this.addModel(e,t,o),o}dispose(){this.modelMap.clear()}}class N extends h.Disposable{constructor(){super();u(this,"sourceMap",new Map);u(this,"_sourceDataUpdate$",new U.Subject);u(this,"sourceDataUpdate$",this._sourceDataUpdate$.asObservable())}_ensureUnitMap(e){let t=this.sourceMap.get(e);return t||(t=new Map,this.sourceMap.set(e,t)),t}_getUnitMap(e){return this.sourceMap.get(e)}getSource(e,t){const n=this._getUnitMap(e);return n==null?void 0:n.get(t)}createSource(e,t,n,o){const s=o===void 0?h.generateRandomId():o;let i;switch(t){case S.List:i=new $(s,n);break;case S.Object:i=new E(s);break;default:throw new Error(`Invalid source type: ${t}`)}return this._ensureUnitMap(e).set(s,i),i}updateSourceData(e,t,n){const o=this._getUnitMap(e),s=t instanceof b?t.getId():t,i=o==null?void 0:o.get(s);if(i)i.setSourceData(n),this._sourceDataUpdate$.next({...i.getSourceInfo(),unitId:e,changeType:M.Add});else throw new Error(`Source not found: ${s}`)}removeSource(e,t){const n=this._getUnitMap(e),o=n==null?void 0:n.get(t);o&&(n==null||n.delete(t),this._sourceDataUpdate$.next({...o.getSourceInfo(),unitId:e,changeType:M.Remove}))}}var V=Object.defineProperty,L=Object.getOwnPropertyDescriptor,A=(d,r,e,t)=>{for(var n=t>1?void 0:t?L(r,e):r,o=d.length-1,s;o>=0;o--)(s=d[o])&&(n=(t?s(r,e,n):s(n))||n);return t&&n&&V(r,e,n),n},R=(d,r)=>(e,t)=>r(e,t,d);exports.SheetsSourceBindService=class extends h.Disposable{constructor(e,t,n){super();u(this,"_bindingModel",m.Value);u(this,"_bindModelRTreeCollection",new Map);this._sheetInterceptorService=e,this._sheetsBindingManager=t,this._sheetsSourceManager=n,this._registerInterceptor(),this._registerSourceChange()}usePathMode(){this._bindingModel=m.Path}useValueMode(){this._bindingModel=m.Value}getBindingModel(){return this._bindingModel}createBindModel(e,t){return this._sheetsBindingManager.createModel(e,t)}setBindingNode(e,t,n){this._sheetsBindingManager.setBindingNode(e,t,n)}removeBindingNode(e,t,n,o){this._sheetsBindingManager.removeBindingNode(e,t,n,o)}getBindingNode(e,t,n,o){return this._sheetsBindingManager.getBindingNode(e,t,n,o)}getSource(e,t){return this._sheetsSourceManager.getSource(e,t)}createSource(e,t,n,o){return this._sheetsSourceManager.createSource(e,t,n,o)}_ensureRTreeCollection(e){return this._bindModelRTreeCollection.has(e)||this._bindModelRTreeCollection.set(e,new h.RTree),this._bindModelRTreeCollection.get(e)}_getRTeeCollection(e){return this._bindModelRTreeCollection.get(e)}_registerSourceChange(){this.disposeWithMe(this._sheetsSourceManager.sourceDataUpdate$.subscribe(e=>{const{sourceId:t,sourceType:n,unitId:o,changeType:s}=e;if(n===S.List){if(s===M.Remove){const c=this._sheetsBindingManager.getBindingModelBySourceId(t),a=e.recordCount;for(const{unitId:l,subunitId:f,nodeId:g,row:p,column:_}of c){const I=this._getRTeeCollection(o);if(I){const B={startRow:p,startColumn:_,endRow:p+a,endColumn:_};I.remove({unitId:l,sheetId:f,id:g,range:B})}}return}if(s===M.Update){const c=e.oldRecordCount,a=this._sheetsBindingManager.getBindingModelBySourceId(t);for(const{unitId:l,subunitId:f,nodeId:g,row:p,column:_}of a){const I=this._getRTeeCollection(o);if(I){const B={startRow:p,startColumn:_,endRow:p+c,endColumn:_},v={startRow:p,startColumn:_,endRow:p+e.recordCount,endColumn:_};I.remove({unitId:l,sheetId:f,id:g,range:B}),I.insert({unitId:l,sheetId:f,id:g,range:v})}}return}const i=this._sheetsSourceManager.getSource(o,t);if(i&&i.hasData()){const a=i.getSourceInfo().recordCount,l=this._sheetsBindingManager.getBindingModelBySourceId(t);for(const{unitId:f,subunitId:g,nodeId:p,row:_,column:I}of l){const B=this._ensureRTreeCollection(f),v={startRow:_,startColumn:I,endRow:_+a,endColumn:I};B.insert({unitId:f,sheetId:g,id:p,range:v})}}}})),this.disposeWithMe(this._sheetsBindingManager.cellBindInfoUpdate$.subscribe(e=>{const{unitId:t,subunitId:n,sourceId:o,nodeId:s,row:i,column:c,changeType:a}=e,l=this._ensureRTreeCollection(t),f=this._sheetsSourceManager.getSource(t,o);if(f&&f.hasData()){const g=f.getSourceInfo();if(g.sourceType===S.List){const p=g.recordCount,_={startRow:i,startColumn:c,endRow:i+p,endColumn:c};if(a===M.Add)l.insert({unitId:t,sheetId:n,id:s,range:_});else if(a===M.Remove)l.remove({unitId:t,sheetId:n,id:s,range:_});else if(a===M.Update){const I=e.oldSourceId,B=this._sheetsSourceManager.getSource(t,I);if(B&&B.hasData()){const x=B.getSourceInfo().recordCount,P={startRow:i,startColumn:c,endRow:i+x,endColumn:c};l.remove({unitId:t,sheetId:n,id:s,range:P})}l.insert({unitId:t,sheetId:n,id:s,range:_})}}}}))}_getPathModeCellValue(e,t,n,o){const s=this._sheetsBindingManager.getModel(e,t),i=s==null?void 0:s.getBindingNode(n,o);if(i){const c=i.type;if(c===S.List)return{v:`#{${i.path}}`,s:{cl:{rgb:"blue"}}};if(c===S.Object)return{v:`[${i.path}]`,s:{cl:{rgb:"blue"}}}}}_getValueModeCellValue(e,t,n,o){const s=this._sheetsBindingManager.getModel(e,t);if(s){const c=s.getBindingNode(n,o);if(c){const{sourceId:a}=c,l=this._sheetsSourceManager.getSource(e,a);if(l&&l.hasData())return{v:(l==null?void 0:l.getData(c,n,o))||""}}}const i=this._getRTeeCollection(e);if(s&&i){const c={startRow:n,startColumn:o,endRow:n,endColumn:o},a=Array.from(i.bulkSearch([{unitId:e,sheetId:t,range:c}]));if(a.length>0){const l=s.getBindingNodeById(a[0]);if(l){const{sourceId:f}=l,g=this._sheetsSourceManager.getSource(e,f);if(g&&g.hasData())return{v:(g==null?void 0:g.getData(l,n,o))||""}}}}}_registerInterceptor(){this.disposeWithMe(this._sheetInterceptorService.intercept(y.INTERCEPTOR_POINT.CELL_CONTENT,{effect:h.InterceptorEffectEnum.Value,handler:(e,t,n)=>{const{row:o,col:s,unitId:i,subUnitId:c}=t;let a=null;return this._bindingModel===m.Path?a=this._getPathModeCellValue(i,c,o,s):a=this._getValueModeCellValue(i,c,o,s),n(a!==null?{...e,...a}:e)}}))}};exports.SheetsSourceBindService=A([R(0,h.Inject(y.SheetInterceptorService)),R(1,h.Inject(T)),R(2,h.Inject(N))],exports.SheetsSourceBindService);var q=Object.defineProperty,J=Object.getOwnPropertyDescriptor,W=(d,r,e,t)=>{for(var n=t>1?void 0:t?J(r,e):r,o=d.length-1,s;o>=0;o--)(s=d[o])&&(n=(t?s(r,e,n):s(n))||n);return t&&n&&q(r,e,n),n},D=(d,r)=>(e,t)=>r(e,t,d),C;exports.UniverSheetsBindingSourcePlugin=(C=class extends h.Plugin{constructor(r={},e,t){super(),this._config=r,this._injector=e,this._configService=t}onStarting(){[[T],[N],[exports.SheetsSourceBindService]].forEach(r=>this._injector.add(r))}onReady(){h.touchDependencies(this._injector,[[T],[N],[exports.SheetsSourceBindService]])}},u(C,"type",h.UniverInstanceType.UNIVER_SHEET),u(C,"pluginName","SHEET_BINDING_SOURCE_PLUGIN"),C);exports.UniverSheetsBindingSourcePlugin=W([D(1,h.Inject(h.Injector)),D(2,h.IConfigService)],exports.UniverSheetsBindingSourcePlugin);exports.BindModeEnum=m;exports.BindingModel=w;exports.DataBindingNodeTypeEnum=S;exports.SourceModelBase=b;

package/lib/es/facade.js

@@ -0,0 +1,42 @@
+import { FEnum as s } from "@univerjs/core";
+import { DataBindingNodeTypeEnum as S, BindModeEnum as h, SheetsSourceBindService as n } from "@univerjs/sheets-source-binding";
+import { FWorkbook as d, FWorksheet as u } from "@univerjs/sheets/facade";
+class g extends s {
+  get DataBindingNodeTypeEnum() {
+    return S;
+  }
+  get BindModeEnum() {
+    return h;
+  }
+}
+s.extend(g);
+class B extends d {
+  createSource(e, t) {
+    return this._injector.get(n).createSource(this.getId(), e, t);
+  }
+  getSource(e) {
+    return this._injector.get(n).getSource(this.getId(), e);
+  }
+  usePathMode() {
+    this._injector.get(n).usePathMode();
+  }
+  useValueMode() {
+    this._injector.get(n).useValueMode();
+  }
+}
+d.extend(B);
+class j extends u {
+  setBindingNode(e) {
+    const i = this._injector.get(n), o = this._workbook.getUnitId();
+    i.setBindingNode(o, this.getSheetId(), e);
+  }
+  removeBindingNode(e, t) {
+    const o = this._injector.get(n), r = this._workbook.getUnitId();
+    o.removeBindingNode(r, this.getSheetId(), e, t);
+  }
+  getBindingNode(e, t) {
+    const o = this._injector.get(n), r = this._workbook.getUnitId();
+    return o.getBindingNode(r, this.getSheetId(), e, t);
+  }
+}
+u.extend(j);

package/lib/es/index.js

@@ -0,0 +1,461 @@
+var j = Object.defineProperty;
+var E = (d, o, e) => o in d ? j(d, o, { enumerable: !0, configurable: !0, writable: !0, value: e }) : d[o] = e;
+var u = (d, o, e) => E(d, typeof o != "symbol" ? o + "" : o, e);
+import { Disposable as T, generateRandomId as x, Inject as C, RTree as V, InterceptorEffectEnum as L, Plugin as A, UniverInstanceType as J, touchDependencies as W, Injector as G, IConfigService as H } from "@univerjs/core";
+import { Subject as O } from "rxjs";
+import { SheetInterceptorService as q, INTERCEPTOR_POINT as z } from "@univerjs/sheets";
+class D {
+  constructor(o) {
+    u(this, "_matrix", {});
+    u(this, "_nodeMap", /* @__PURE__ */ new Map());
+    u(this, "_sourceIdMap", /* @__PURE__ */ new Map());
+    o && this._init(o);
+  }
+  _init(o) {
+    this.fromJSON();
+  }
+  getBindingNodesBySourceId(o) {
+    const e = this._sourceIdMap.get(o);
+    if (e)
+      return e.map((t) => this._nodeMap.get(t));
+  }
+  setBindingNode(o, e, t) {
+    this._matrix[o] || (this._matrix[o] = {}), this._matrix[o][e] || (this._matrix[o][e] = t), this._nodeMap.set(t.nodeId, t);
+    const n = this._sourceIdMap.get(t.sourceId);
+    n ? n.push(t.nodeId) : this._sourceIdMap.set(t.sourceId, [t.nodeId]);
+  }
+  getBindingNode(o, e) {
+    var t;
+    return (t = this._matrix[o]) == null ? void 0 : t[e];
+  }
+  removeBindingNode(o, e) {
+    var n;
+    const t = (n = this._matrix[o]) == null ? void 0 : n[e];
+    if (t) {
+      this._matrix[o][e] = void 0, this._nodeMap.delete(t.nodeId);
+      const s = this._sourceIdMap.get(t.sourceId);
+      if (s) {
+        const r = s.indexOf(t.nodeId);
+        r >= 0 && s.splice(r, 1), s.length === 0 && this._sourceIdMap.delete(t.sourceId);
+      }
+    }
+  }
+  getBindingNodeById(o) {
+    return this._nodeMap.get(o);
+  }
+  fromJSON() {
+  }
+  toJSON() {
+  }
+}
+var M = /* @__PURE__ */ ((d) => (d.List = "list", d.Object = "object", d))(M || {}), S = /* @__PURE__ */ ((d) => (d.Path = "path", d.Value = "value", d))(S || {}), p = /* @__PURE__ */ ((d) => (d.Add = "add", d.Remove = "remove", d.Update = "update", d))(p || {});
+class N {
+  constructor(o) {
+    u(this, "_data");
+    u(this, "id");
+    u(this, "_hasData", !1);
+    u(this, "type");
+    this.id = o;
+  }
+  getId() {
+    return this.id;
+  }
+  getType() {
+    return this.type;
+  }
+  hasData() {
+    return this._hasData;
+  }
+  setSourceData(o) {
+    this._data = o, this._hasData = !0;
+  }
+}
+class F extends N {
+  constructor(e, t) {
+    super(e);
+    u(this, "type", M.List);
+    u(this, "_isListObject");
+    u(this, "_fieldIndexMap", /* @__PURE__ */ new Map());
+    u(this, "_data", { fields: [], records: [] });
+    this._isListObject = t != null ? t : !0;
+  }
+  /**
+   * Toggle the list object mode. The default value is true.
+   * In the list object mode, the records is an array of objects. Such as [{name: 'Tom', age: 20}, {name: 'Jerry', age: 18}].
+   * In the list array mode, the records is an array of arrays. Such as [['Tom', 20], ['Jerry', 18]].
+   */
+  toggleListObject(e) {
+    this._isListObject = e;
+  }
+  getData(e, t) {
+    const { path: n, row: s } = e, r = this._fieldIndexMap.get(n), i = t - s;
+    return i === 0 ? this._data.fields[r] : this._isListObject ? this._data.records[i - 1][n] : this._data.records[i - 1][r];
+  }
+  setSourceData(e) {
+    super.setSourceData(e);
+    const { fields: t } = e;
+    this._fieldIndexMap.clear(), t.forEach((n, s) => {
+      this._fieldIndexMap.set(n, s);
+    });
+  }
+  getSourceInfo() {
+    return {
+      sourceId: this.id,
+      sourceType: this.type,
+      fields: this._data.fields,
+      recordCount: this._data.records.length
+    };
+  }
+}
+class K extends N {
+  constructor(e) {
+    super(e);
+    u(this, "type", M.Object);
+  }
+  getData(e) {
+    const n = e.path.split(".");
+    let s = this._data;
+    for (const r of n)
+      if (s = s[r], s === void 0)
+        return null;
+    return s;
+  }
+  getSourceInfo() {
+    return {
+      sourceId: this.id,
+      sourceType: M.Object
+    };
+  }
+}
+class w extends T {
+  constructor() {
+    super();
+    u(this, "modelMap", /* @__PURE__ */ new Map());
+    u(this, "_cellBindInfoUpdate$", new O());
+    u(this, "cellBindInfoUpdate$", this._cellBindInfoUpdate$.asObservable());
+  }
+  getBindingModelBySourceId(e) {
+    const t = [];
+    return this.modelMap.forEach((n, s) => {
+      n.forEach((r, i) => {
+        const a = r.getBindingNodesBySourceId(e);
+        if (a)
+          for (const c of a)
+            t.push({
+              unitId: s,
+              subunitId: i,
+              sourceId: e,
+              nodeId: c.nodeId,
+              row: c.row,
+              column: c.column
+            });
+      });
+    }), t;
+  }
+  addModel(e, t, n) {
+    var s;
+    this.modelMap.has(e) || this.modelMap.set(e, /* @__PURE__ */ new Map()), (s = this.modelMap.get(e)) == null || s.set(t, n);
+  }
+  getModel(e, t) {
+    var n;
+    return (n = this.modelMap.get(e)) == null ? void 0 : n.get(t);
+  }
+  setBindingNode(e, t, n) {
+    let s = this.getModel(e, t);
+    s || (s = new D(), this.addModel(e, t, s)), n.nodeId || (n.nodeId = x());
+    const { row: r, column: i } = n;
+    if (r === void 0 || i === void 0)
+      throw new Error("row and column is required");
+    const a = s.getBindingNode(r, i);
+    s.setBindingNode(r, i, { ...n, row: r, column: i }), this._cellBindInfoUpdate$.next({
+      unitId: e,
+      subunitId: t,
+      sourceId: n.sourceId,
+      nodeId: n.nodeId,
+      row: r,
+      column: i,
+      changeType: a ? p.Update : p.Add,
+      oldSourceId: a == null ? void 0 : a.sourceId
+    });
+  }
+  removeBindingNode(e, t, n, s) {
+    const r = this.getModel(e, t);
+    if (r) {
+      const i = r.getBindingNode(n, s);
+      i && (r.removeBindingNode(n, s), this._cellBindInfoUpdate$.next({
+        unitId: e,
+        subunitId: t,
+        sourceId: i.sourceId,
+        nodeId: i.nodeId,
+        row: n,
+        column: s,
+        changeType: p.Remove
+      }));
+    }
+  }
+  getBindingNode(e, t, n, s) {
+    const r = this.getModel(e, t);
+    if (r)
+      return r.getBindingNode(n, s);
+  }
+  createModel(e, t, n) {
+    const s = new D(n);
+    return this.addModel(e, t, s), s;
+  }
+  dispose() {
+    this.modelMap.clear();
+  }
+}
+class b extends T {
+  constructor() {
+    super();
+    u(this, "sourceMap", /* @__PURE__ */ new Map());
+    u(this, "_sourceDataUpdate$", new O());
+    u(this, "sourceDataUpdate$", this._sourceDataUpdate$.asObservable());
+  }
+  _ensureUnitMap(e) {
+    let t = this.sourceMap.get(e);
+    return t || (t = /* @__PURE__ */ new Map(), this.sourceMap.set(e, t)), t;
+  }
+  _getUnitMap(e) {
+    return this.sourceMap.get(e);
+  }
+  getSource(e, t) {
+    const n = this._getUnitMap(e);
+    return n == null ? void 0 : n.get(t);
+  }
+  createSource(e, t, n, s) {
+    const r = s === void 0 ? x() : s;
+    let i;
+    switch (t) {
+      case M.List:
+        i = new F(r, n);
+        break;
+      case M.Object:
+        i = new K(r);
+        break;
+      default:
+        throw new Error(`Invalid source type: ${t}`);
+    }
+    return this._ensureUnitMap(e).set(r, i), i;
+  }
+  updateSourceData(e, t, n) {
+    const s = this._getUnitMap(e), r = t instanceof N ? t.getId() : t, i = s == null ? void 0 : s.get(r);
+    if (i)
+      i.setSourceData(n), this._sourceDataUpdate$.next({ ...i.getSourceInfo(), unitId: e, changeType: p.Add });
+    else
+      throw new Error(`Source not found: ${r}`);
+  }
+  removeSource(e, t) {
+    const n = this._getUnitMap(e), s = n == null ? void 0 : n.get(t);
+    s && (n == null || n.delete(t), this._sourceDataUpdate$.next({ ...s.getSourceInfo(), unitId: e, changeType: p.Remove }));
+  }
+}
+var Q = Object.defineProperty, X = Object.getOwnPropertyDescriptor, Y = (d, o, e, t) => {
+  for (var n = t > 1 ? void 0 : t ? X(o, e) : o, s = d.length - 1, r; s >= 0; s--)
+    (r = d[s]) && (n = (t ? r(o, e, n) : r(n)) || n);
+  return t && n && Q(o, e, n), n;
+}, R = (d, o) => (e, t) => o(e, t, d);
+let v = class extends T {
+  constructor(o, e, t) {
+    super();
+    u(this, "_bindingModel", S.Value);
+    u(this, "_bindModelRTreeCollection", /* @__PURE__ */ new Map());
+    this._sheetInterceptorService = o, this._sheetsBindingManager = e, this._sheetsSourceManager = t, this._registerInterceptor(), this._registerSourceChange();
+  }
+  /**
+   * Set the binding model to path mode, in this mode, the binding path will show in the cell.
+   */
+  usePathMode() {
+    this._bindingModel = S.Path;
+  }
+  /**
+   * Set the binding model to value mode, in this mode, the value of source will show in the cell.
+   */
+  useValueMode() {
+    this._bindingModel = S.Value;
+  }
+  /**
+   * Get the current binding model.
+   * @returns the current binding model
+   */
+  getBindingModel() {
+    return this._bindingModel;
+  }
+  createBindModel(o, e) {
+    return this._sheetsBindingManager.createModel(o, e);
+  }
+  setBindingNode(o, e, t) {
+    this._sheetsBindingManager.setBindingNode(o, e, t);
+  }
+  removeBindingNode(o, e, t, n) {
+    this._sheetsBindingManager.removeBindingNode(o, e, t, n);
+  }
+  getBindingNode(o, e, t, n) {
+    return this._sheetsBindingManager.getBindingNode(o, e, t, n);
+  }
+  getSource(o, e) {
+    return this._sheetsSourceManager.getSource(o, e);
+  }
+  createSource(o, e, t, n) {
+    return this._sheetsSourceManager.createSource(o, e, t, n);
+  }
+  _ensureRTreeCollection(o) {
+    return this._bindModelRTreeCollection.has(o) || this._bindModelRTreeCollection.set(o, new V()), this._bindModelRTreeCollection.get(o);
+  }
+  _getRTeeCollection(o) {
+    return this._bindModelRTreeCollection.get(o);
+  }
+  // eslint-disable-next-line max-lines-per-function
+  _registerSourceChange() {
+    this.disposeWithMe(this._sheetsSourceManager.sourceDataUpdate$.subscribe((o) => {
+      const { sourceId: e, sourceType: t, unitId: n, changeType: s } = o;
+      if (t === M.List) {
+        if (s === p.Remove) {
+          const i = this._sheetsBindingManager.getBindingModelBySourceId(e), a = o.recordCount;
+          for (const { unitId: c, subunitId: g, nodeId: l, row: _, column: h } of i) {
+            const f = this._getRTeeCollection(n);
+            if (f) {
+              const I = { startRow: _, startColumn: h, endRow: _ + a, endColumn: h };
+              f.remove({ unitId: c, sheetId: g, id: l, range: I });
+            }
+          }
+          return;
+        }
+        if (s === p.Update) {
+          const i = o.oldRecordCount, a = this._sheetsBindingManager.getBindingModelBySourceId(e);
+          for (const { unitId: c, subunitId: g, nodeId: l, row: _, column: h } of a) {
+            const f = this._getRTeeCollection(n);
+            if (f) {
+              const I = { startRow: _, startColumn: h, endRow: _ + i, endColumn: h }, m = { startRow: _, startColumn: h, endRow: _ + o.recordCount, endColumn: h };
+              f.remove({ unitId: c, sheetId: g, id: l, range: I }), f.insert({ unitId: c, sheetId: g, id: l, range: m });
+            }
+          }
+          return;
+        }
+        const r = this._sheetsSourceManager.getSource(n, e);
+        if (r && r.hasData()) {
+          const a = r.getSourceInfo().recordCount, c = this._sheetsBindingManager.getBindingModelBySourceId(e);
+          for (const { unitId: g, subunitId: l, nodeId: _, row: h, column: f } of c) {
+            const I = this._ensureRTreeCollection(g), m = { startRow: h, startColumn: f, endRow: h + a, endColumn: f };
+            I.insert({ unitId: g, sheetId: l, id: _, range: m });
+          }
+        }
+      }
+    })), this.disposeWithMe(this._sheetsBindingManager.cellBindInfoUpdate$.subscribe((o) => {
+      const { unitId: e, subunitId: t, sourceId: n, nodeId: s, row: r, column: i, changeType: a } = o, c = this._ensureRTreeCollection(e), g = this._sheetsSourceManager.getSource(e, n);
+      if (g && g.hasData()) {
+        const l = g.getSourceInfo();
+        if (l.sourceType === M.List) {
+          const _ = l.recordCount, h = { startRow: r, startColumn: i, endRow: r + _, endColumn: i };
+          if (a === p.Add)
+            c.insert({ unitId: e, sheetId: t, id: s, range: h });
+          else if (a === p.Remove)
+            c.remove({ unitId: e, sheetId: t, id: s, range: h });
+          else if (a === p.Update) {
+            const f = o.oldSourceId, I = this._sheetsSourceManager.getSource(e, f);
+            if (I && I.hasData()) {
+              const P = I.getSourceInfo().recordCount, $ = { startRow: r, startColumn: i, endRow: r + P, endColumn: i };
+              c.remove({ unitId: e, sheetId: t, id: s, range: $ });
+            }
+            c.insert({ unitId: e, sheetId: t, id: s, range: h });
+          }
+        }
+      }
+    }));
+  }
+  _getPathModeCellValue(o, e, t, n) {
+    const s = this._sheetsBindingManager.getModel(o, e), r = s == null ? void 0 : s.getBindingNode(t, n);
+    if (r) {
+      const i = r.type;
+      if (i === M.List)
+        return {
+          v: `#{${r.path}}`,
+          s: { cl: { rgb: "blue" } }
+        };
+      if (i === M.Object)
+        return {
+          v: `[${r.path}]`,
+          s: { cl: { rgb: "blue" } }
+        };
+    }
+  }
+  _getValueModeCellValue(o, e, t, n) {
+    const s = this._sheetsBindingManager.getModel(o, e);
+    if (s) {
+      const i = s.getBindingNode(t, n);
+      if (i) {
+        const { sourceId: a } = i, c = this._sheetsSourceManager.getSource(o, a);
+        if (c && c.hasData())
+          return {
+            v: (c == null ? void 0 : c.getData(i, t, n)) || ""
+          };
+      }
+    }
+    const r = this._getRTeeCollection(o);
+    if (s && r) {
+      const i = { startRow: t, startColumn: n, endRow: t, endColumn: n }, a = Array.from(r.bulkSearch([{ unitId: o, sheetId: e, range: i }]));
+      if (a.length > 0) {
+        const c = s.getBindingNodeById(a[0]);
+        if (c) {
+          const { sourceId: g } = c, l = this._sheetsSourceManager.getSource(o, g);
+          if (l && l.hasData())
+            return {
+              v: (l == null ? void 0 : l.getData(c, t, n)) || ""
+            };
+        }
+      }
+    }
+  }
+  _registerInterceptor() {
+    this.disposeWithMe(this._sheetInterceptorService.intercept(z.CELL_CONTENT, {
+      effect: L.Value,
+      handler: (o, e, t) => {
+        const { row: n, col: s, unitId: r, subUnitId: i } = e;
+        let a = null;
+        return this._bindingModel === S.Path ? a = this._getPathModeCellValue(r, i, n, s) : a = this._getValueModeCellValue(r, i, n, s), t(a !== null ? { ...o, ...a } : o);
+      }
+    }));
+  }
+};
+v = Y([
+  R(0, C(q)),
+  R(1, C(w)),
+  R(2, C(b))
+], v);
+var Z = Object.defineProperty, k = Object.getOwnPropertyDescriptor, ee = (d, o, e, t) => {
+  for (var n = t > 1 ? void 0 : t ? k(o, e) : o, s = d.length - 1, r; s >= 0; s--)
+    (r = d[s]) && (n = (t ? r(o, e, n) : r(n)) || n);
+  return t && n && Z(o, e, n), n;
+}, U = (d, o) => (e, t) => o(e, t, d), B;
+let y = (B = class extends A {
+  constructor(d = {}, o, e) {
+    super(), this._config = d, this._injector = o, this._configService = e;
+  }
+  onStarting() {
+    [
+      [w],
+      [b],
+      [v]
+    ].forEach((d) => this._injector.add(d));
+  }
+  onReady() {
+    W(this._injector, [
+      [w],
+      [b],
+      [v]
+    ]);
+  }
+}, u(B, "type", J.UNIVER_SHEET), u(B, "pluginName", "SHEET_BINDING_SOURCE_PLUGIN"), B);
+y = ee([
+  U(1, C(G)),
+  U(2, H)
+], y);
+export {
+  S as BindModeEnum,
+  D as BindingModel,
+  M as DataBindingNodeTypeEnum,
+  v as SheetsSourceBindService,
+  N as SourceModelBase,
+  y as UniverSheetsBindingSourcePlugin
+};

package/lib/types/controllers/binding-manager.d.ts

@@ -0,0 +1,29 @@
+import { ICellBindingNode, ICellBindingNodeParam, BindingSourceChangeTypeEnum } from '../types';
+import { Disposable } from '@univerjs/core';
+import { SheetBindingModel } from '../model/binding-model';
+interface IBindingNodeInfo {
+    unitId: string;
+    subunitId: string;
+    sourceId: string;
+    nodeId: string;
+    row: number;
+    column: number;
+}
+export declare class SheetsBindingManager extends Disposable {
+    modelMap: Map<string, Map<string, SheetBindingModel>>;
+    private _cellBindInfoUpdate$;
+    cellBindInfoUpdate$: import('rxjs').Observable<IBindingNodeInfo & {
+        changeType: BindingSourceChangeTypeEnum;
+        oldSourceId?: string;
+    }>;
+    constructor();
+    getBindingModelBySourceId(sourceId: string): IBindingNodeInfo[];
+    addModel(unitId: string, subunitId: string, model: SheetBindingModel): void;
+    getModel(unitId: string, subunitId: string): SheetBindingModel | undefined;
+    setBindingNode(unitId: string, subunitId: string, node: ICellBindingNodeParam): void;
+    removeBindingNode(unitId: string, subunitId: string, row: number, column: number): void;
+    getBindingNode(unitId: string, subunitId: string, row: number, column: number): ICellBindingNode | undefined;
+    createModel(unitId: string, subunitId: string, json?: any): SheetBindingModel;
+    dispose(): void;
+}
+export {};

package/lib/types/controllers/source-manager.d.ts

@@ -0,0 +1,15 @@
+import { ISourceEvent, DataBindingNodeTypeEnum } from '../types';
+import { Disposable } from '@univerjs/core';
+import { SourceModelBase } from '../model/source-model';
+export declare class SheetsSourceManager extends Disposable {
+    sourceMap: Map<string, Map<string, SourceModelBase>>;
+    private _sourceDataUpdate$;
+    sourceDataUpdate$: import('rxjs').Observable<ISourceEvent>;
+    constructor();
+    private _ensureUnitMap;
+    private _getUnitMap;
+    getSource(unitId: string, id: string): SourceModelBase | undefined;
+    createSource(unitId: string, type: DataBindingNodeTypeEnum, isListObject?: boolean, id?: string): SourceModelBase;
+    updateSourceData(unitId: string, idOrInstance: string | SourceModelBase, data: any): void;
+    removeSource(unitId: string, id: string): void;
+}

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

@@ -0,0 +1,15 @@
+import { BindModeEnum, DataBindingNodeTypeEnum } from '@univerjs/sheets-source-binding';
+export interface ISourceBindingEnumMixin {
+    /**
+     * Represents the type of data binding node.{@link DataBindingNodeTypeEnum}
+     */
+    DataBindingNodeTypeEnum: typeof DataBindingNodeTypeEnum;
+    /**
+     * Represents the type of data binding node. {@link BindModeEnum}
+     */
+    BindModeEnum: typeof BindModeEnum;
+}
+declare module '@univerjs/core' {
+    interface FEnum extends ISourceBindingEnumMixin {
+    }
+}

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

@@ -0,0 +1,34 @@
+import { DataBindingNodeTypeEnum, SourceModelBase } from '@univerjs/sheets-source-binding';
+import { FWorkbook } from '@univerjs/sheets/facade';
+export interface IFWorkbookSourceBindingMixin {
+    /**
+     * Create a source model with the specified type.
+     * @param {DataBindingNodeTypeEnum} type The source type.
+     * @param {boolean} [isListObject] Whether the source is a list object.
+     * @returns {SourceModelBase} The source data of sheet.
+     */
+    createSource(type: DataBindingNodeTypeEnum, isListObject?: boolean): SourceModelBase;
+    /**
+     * Switch to path mode.In this mode, the path will show in cell.
+     */
+    usePathMode(): void;
+    /**
+     * Switch to value mode.This is the default mode. In this mode, the cell value will fulfill by source values.
+     */
+    useValueMode(): void;
+    /**
+     * Get the source model by the specified source id.
+     * @param {string} sourceId The source id.
+     */
+    getSource(sourceId: string): SourceModelBase | undefined;
+}
+export declare class FWorkbookSourceBinding extends FWorkbook implements IFWorkbookSourceBindingMixin {
+    createSource(type: DataBindingNodeTypeEnum, isListObject?: boolean): SourceModelBase;
+    getSource(sourceId: string): SourceModelBase | undefined;
+    usePathMode(): void;
+    useValueMode(): void;
+}
+declare module '@univerjs/sheets/facade' {
+    interface FWorkbook extends IFWorkbookSourceBindingMixin {
+    }
+}

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

@@ -0,0 +1,31 @@
+import { ICellBindingNode, ICellBindingNodeParam } from '@univerjs/sheets-source-binding';
+import { FWorksheet } from '@univerjs/sheets/facade';
+export interface IFworksheetSourceBindingMixin {
+    /**
+     * Set the binding node for the specified cell.
+     * @param bindingNode The binding node to set. {@link ICellBindingNodeParam}
+     */
+    setBindingNode(bindingNode: ICellBindingNodeParam): void;
+    /**
+     * Remove the binding node for the specified cell.
+     * @param {number} row The row index of the cell.
+     * @param {number} column The column index of the cell.
+     */
+    removeBindingNode(row: number, column: number): void;
+    /**
+     * Get the binding node for the specified cell.
+     * @param {number} row The row index of the cell.
+     * @param {number} column The column index of the cell.
+     * @returns The binding node of the cell. {@link ICellBindingNode} or undefined if not found.
+     */
+    getBindingNode(row: number, column: number): ICellBindingNode | undefined;
+}
+export declare class FWorksheetSourceBinding extends FWorksheet implements IFworksheetSourceBindingMixin {
+    setBindingNode(bindingNode: ICellBindingNodeParam): void;
+    removeBindingNode(row: number, column: number): void;
+    getBindingNode(row: number, column: number): ICellBindingNode | undefined;
+}
+declare module '@univerjs/sheets/facade' {
+    interface FWorksheet extends IFworksheetSourceBindingMixin {
+    }
+}

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

@@ -0,0 +1,18 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * 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-enum';
+import './f-workbook';
+import './f-worksheet';

package/lib/types/index.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * 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 { SheetBindingModel as BindingModel } from './model/binding-model';
+export { SourceModelBase } from './model/source-model';
+export { UniverSheetsBindingSourcePlugin } from './plugin';
+export { BindModeEnum, DataBindingNodeTypeEnum } from './types';
+export { SheetsSourceBindService } from './services/source-binding-service';
+export type { ICellBindingNode, ICellBindingNodeParam } from './types';

package/lib/types/model/binding-model.d.ts

@@ -0,0 +1,15 @@
+import { ICellBindingNode } from '../types';
+export declare class SheetBindingModel {
+    private _matrix;
+    private _nodeMap;
+    private _sourceIdMap;
+    constructor(json?: any);
+    _init(json: any): void;
+    getBindingNodesBySourceId(sourceId: string): ICellBindingNode[] | undefined;
+    setBindingNode(row: number, column: number, node: ICellBindingNode): void;
+    getBindingNode(row: number, column: number): ICellBindingNode;
+    removeBindingNode(row: number, column: number): void;
+    getBindingNodeById(nodeId: string): ICellBindingNode | undefined;
+    fromJSON(): void;
+    toJSON(): void;
+}

package/lib/types/model/source-model.d.ts

@@ -0,0 +1,36 @@
+import { ICellBindingNode, IListDataBindingNode, IListSourceData, IListSourceInfo, IObjectSourceInfo, DataBindingNodeTypeEnum } from '../types';
+export declare abstract class SourceModelBase {
+    protected _data: any;
+    readonly id: string;
+    private _hasData;
+    readonly type: DataBindingNodeTypeEnum;
+    constructor(id: string);
+    getId(): string;
+    getType(): DataBindingNodeTypeEnum;
+    hasData(): boolean;
+    setSourceData(data: any): void;
+    abstract getSourceInfo(): any;
+    abstract getData(node: ICellBindingNode, row: number, col: number): string | number | boolean | null;
+}
+export declare class ListSourceModel extends SourceModelBase {
+    readonly type = DataBindingNodeTypeEnum.List;
+    private _isListObject;
+    private _fieldIndexMap;
+    protected _data: IListSourceData;
+    constructor(id: string, isListObject?: boolean);
+    /**
+     * Toggle the list object mode. The default value is true.
+     * In the list object mode, the records is an array of objects. Such as [{name: 'Tom', age: 20}, {name: 'Jerry', age: 18}].
+     * In the list array mode, the records is an array of arrays. Such as [['Tom', 20], ['Jerry', 18]].
+     */
+    toggleListObject(isListObject: boolean): void;
+    getData(node: IListDataBindingNode, row: number): string | number | boolean | null;
+    setSourceData(data: IListSourceData): void;
+    getSourceInfo(): IListSourceInfo;
+}
+export declare class ObjectSourceModel extends SourceModelBase {
+    readonly type = DataBindingNodeTypeEnum.Object;
+    constructor(id: string);
+    getData(node: ICellBindingNode): string | number | boolean | null;
+    getSourceInfo(): IObjectSourceInfo;
+}

package/lib/types/plugin.d.ts

@@ -0,0 +1,14 @@
+import { IConfigService, Injector, Plugin, UniverInstanceType } from '@univerjs/core';
+interface IUniverSheetsBindingSourceConfig {
+}
+export declare class UniverSheetsBindingSourcePlugin extends Plugin {
+    private readonly _config;
+    readonly _injector: Injector;
+    private readonly _configService;
+    static type: UniverInstanceType;
+    static pluginName: string;
+    constructor(_config: Partial<IUniverSheetsBindingSourceConfig> | undefined, _injector: Injector, _configService: IConfigService);
+    onStarting(): void;
+    onReady(): void;
+}
+export {};

package/lib/types/services/source-binding-service.d.ts

@@ -0,0 +1,38 @@
+import { ICellBindingNodeParam, BindModeEnum, DataBindingNodeTypeEnum } from '../types';
+import { Disposable } from '@univerjs/core';
+import { SheetInterceptorService } from '@univerjs/sheets';
+import { SheetsBindingManager } from '../controllers/binding-manager';
+import { SheetsSourceManager } from '../controllers/source-manager';
+export declare class SheetsSourceBindService extends Disposable {
+    private _sheetInterceptorService;
+    private _sheetsBindingManager;
+    private _sheetsSourceManager;
+    private _bindingModel;
+    private _bindModelRTreeCollection;
+    constructor(_sheetInterceptorService: SheetInterceptorService, _sheetsBindingManager: SheetsBindingManager, _sheetsSourceManager: SheetsSourceManager);
+    /**
+     * Set the binding model to path mode, in this mode, the binding path will show in the cell.
+     */
+    usePathMode(): void;
+    /**
+     * Set the binding model to value mode, in this mode, the value of source will show in the cell.
+     */
+    useValueMode(): void;
+    /**
+     * Get the current binding model.
+     * @returns the current binding model
+     */
+    getBindingModel(): BindModeEnum;
+    createBindModel(unitId: string, subUnitId: string): import('..').BindingModel;
+    setBindingNode(unitId: string, subUnitId: string, node: ICellBindingNodeParam): void;
+    removeBindingNode(unitId: string, subUnitId: string, row: number, column: number): void;
+    getBindingNode(unitId: string, subUnitId: string, row: number, column: number): import('..').ICellBindingNode | undefined;
+    getSource(unitId: string, id: string): import('..').SourceModelBase | undefined;
+    createSource(unitId: string, type: DataBindingNodeTypeEnum, isListObject?: boolean, id?: string): import('..').SourceModelBase;
+    private _ensureRTreeCollection;
+    private _getRTeeCollection;
+    private _registerSourceChange;
+    private _getPathModeCellValue;
+    private _getValueModeCellValue;
+    private _registerInterceptor;
+}

package/lib/types/types.d.ts

@@ -0,0 +1,146 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * 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.
+ */
+/**
+ * Represents the type of data binding node.Which config the array or object like data source or path.
+ */
+export declare enum DataBindingNodeTypeEnum {
+    /**
+     * The array like data source.
+     */
+    List = "list",
+    /**
+     * The object like data source.
+     */
+    Object = "object"
+}
+export declare enum ListDataBindingNodeDirectionEnum {
+    Horizontal = "horizontal",
+    Vertical = "vertical"
+}
+/**
+ * Represents the type of data binding node.Which config show Binding path or value.
+ */
+export declare enum BindModeEnum {
+    /**
+     * The path mode, show the binding path.
+     */
+    Path = "path",
+    /**
+     * The value mode, show the binding value.
+     */
+    Value = "value"
+}
+export type sourceDataType = string | number | boolean | object | null;
+export interface IDataSource {
+    id: string;
+    getData(row: number, column: number): sourceDataType;
+}
+export interface IListDataSource extends IDataSource {
+    getLength(): number;
+    getColumns(): string[];
+}
+export interface IDataBindingModelMatrix {
+    [row: number]: {
+        [column: number]: ICellBindingNode;
+    };
+}
+export interface IDataBindingModel {
+    themeName?: string;
+    matrix: IDataBindingModelMatrix;
+    setBindingNode(row: number, column: number, node: ICellBindingNode): void;
+}
+/**
+ * The binding node of cell, which config the source id, path, row, column.
+ */
+export interface ICellBindingNodeParam {
+    /**
+     * The binding node type, the node type should be same as provide source type.
+     */
+    type: DataBindingNodeTypeEnum;
+    /**
+     * The path of the binding node, the path should be same as provide source path.
+     * @example
+     * for object type : the source is :{user: {name :'Tom'}}, we can set path 'user.name' to represent the Tom.
+     * for list type : the source is :{fields:['name', 'age'], records:[['Tom', 18],['Jerry', 20]]}, we can set path 'name' to represent the all names in data.
+     */
+    path: string;
+    /**
+     * The source id of the binding node, the source id should be same as provide source id.
+     */
+    sourceId: string;
+    /**
+     * The target row of the binding node.
+     */
+    row: number;
+    /**
+     * The target column of the binding node.
+     */
+    column: number;
+    nodeId?: string;
+}
+export interface ICellBindingNode extends ICellBindingNodeParam {
+    /**
+     * The node id of ICellBindingNode, if not provide, will generate a random id.
+     */
+    nodeId: string;
+}
+export interface IListDataBindingNode extends ICellBindingNode {
+    type: DataBindingNodeTypeEnum.List;
+    limit?: number;
+    direction?: ListDataBindingNodeDirectionEnum;
+    range?: {
+        startRow: number;
+        startColumn: number;
+        endRow: number;
+        endColumn: number;
+    };
+    displayName?: string;
+}
+export interface IDataBindingService {
+    /**
+     * A flag to control show path or show value
+     */
+    isBindingMode: boolean;
+    /**
+     * Change the binding mode
+     * @param {BindModeEnum} mode Update the binding mode
+     */
+    setBindingMode(mode: BindModeEnum): void;
+}
+export interface IListSourceInfo {
+    sourceId: string;
+    sourceType: DataBindingNodeTypeEnum.List;
+    fields: string[];
+    recordCount: number;
+}
+export interface IObjectSourceInfo {
+    sourceId: string;
+    sourceType: DataBindingNodeTypeEnum.Object;
+}
+export type ISourceEvent = (IListSourceInfo | IObjectSourceInfo) & {
+    unitId: string;
+    changeType: BindingSourceChangeTypeEnum;
+    oldRecordCount?: number;
+};
+export interface IListSourceData {
+    fields: string[];
+    records: any[][] | Record<string | number, any>[];
+}
+export declare enum BindingSourceChangeTypeEnum {
+    Add = "add",
+    Remove = "remove",
+    Update = "update"
+}

package/lib/umd/facade.js

@@ -0,0 +1 @@
+(function(n,e){typeof exports=="object"&&typeof module<"u"?e(require("@univerjs/core"),require("@univerjs/sheets-source-binding"),require("@univerjs/sheets/facade")):typeof define=="function"&&define.amd?define(["@univerjs/core","@univerjs/sheets-source-binding","@univerjs/sheets/facade"],e):(n=typeof globalThis<"u"?globalThis:n||self,e(n.UniverCore,n.UniverSheetsSourceBinding,n.UniverSheetsFacade))})(this,function(n,e,s){"use strict";class u extends n.FEnum{get DataBindingNodeTypeEnum(){return e.DataBindingNodeTypeEnum}get BindModeEnum(){return e.BindModeEnum}}n.FEnum.extend(u);class S extends s.FWorkbook{createSource(t,i){return this._injector.get(e.SheetsSourceBindService).createSource(this.getId(),t,i)}getSource(t){return this._injector.get(e.SheetsSourceBindService).getSource(this.getId(),t)}usePathMode(){this._injector.get(e.SheetsSourceBindService).usePathMode()}useValueMode(){this._injector.get(e.SheetsSourceBindService).useValueMode()}}s.FWorkbook.extend(S);class h extends s.FWorksheet{setBindingNode(t){const r=this._injector.get(e.SheetsSourceBindService),o=this._workbook.getUnitId();r.setBindingNode(o,this.getSheetId(),t)}removeBindingNode(t,i){const o=this._injector.get(e.SheetsSourceBindService),c=this._workbook.getUnitId();o.removeBindingNode(c,this.getSheetId(),t,i)}getBindingNode(t,i){const o=this._injector.get(e.SheetsSourceBindService),c=this._workbook.getUnitId();return o.getBindingNode(c,this.getSheetId(),t,i)}}s.FWorksheet.extend(h)});

package/lib/umd/index.js

@@ -0,0 +1 @@
+(function(u,a){typeof exports=="object"&&typeof module<"u"?a(exports,require("@univerjs/core"),require("rxjs"),require("@univerjs/sheets")):typeof define=="function"&&define.amd?define(["exports","@univerjs/core","rxjs","@univerjs/sheets"],a):(u=typeof globalThis<"u"?globalThis:u||self,a(u.UniverSheetsSourceBinding={},u.UniverCore,u.rxjs,u.UniverSheets))})(this,function(u,a,v,y){"use strict";var W=Object.defineProperty;var G=(u,a,v)=>a in u?W(u,a,{enumerable:!0,configurable:!0,writable:!0,value:v}):u[a]=v;var l=(u,a,v)=>G(u,typeof a!="symbol"?a+"":a,v);var b;class T{constructor(r){l(this,"_matrix",{});l(this,"_nodeMap",new Map);l(this,"_sourceIdMap",new Map);r&&this._init(r)}_init(r){this.fromJSON()}getBindingNodesBySourceId(r){const t=this._sourceIdMap.get(r);if(t)return t.map(e=>this._nodeMap.get(e))}setBindingNode(r,t,e){this._matrix[r]||(this._matrix[r]={}),this._matrix[r][t]||(this._matrix[r][t]=e),this._nodeMap.set(e.nodeId,e);const n=this._sourceIdMap.get(e.sourceId);n?n.push(e.nodeId):this._sourceIdMap.set(e.sourceId,[e.nodeId])}getBindingNode(r,t){var e;return(e=this._matrix[r])==null?void 0:e[t]}removeBindingNode(r,t){var n;const e=(n=this._matrix[r])==null?void 0:n[t];if(e){this._matrix[r][t]=void 0,this._nodeMap.delete(e.nodeId);const o=this._sourceIdMap.get(e.sourceId);if(o){const s=o.indexOf(e.nodeId);s>=0&&o.splice(s,1),o.length===0&&this._sourceIdMap.delete(e.sourceId)}}}getBindingNodeById(r){return this._nodeMap.get(r)}fromJSON(){}toJSON(){}}var I=(d=>(d.List="list",d.Object="object",d))(I||{}),C=(d=>(d.Path="path",d.Value="value",d))(C||{}),M=(d=>(d.Add="add",d.Remove="remove",d.Update="update",d))(M||{});class R{constructor(r){l(this,"_data");l(this,"id");l(this,"_hasData",!1);l(this,"type");this.id=r}getId(){return this.id}getType(){return this.type}hasData(){return this._hasData}setSourceData(r){this._data=r,this._hasData=!0}}class P extends R{constructor(t,e){super(t);l(this,"type",I.List);l(this,"_isListObject");l(this,"_fieldIndexMap",new Map);l(this,"_data",{fields:[],records:[]});this._isListObject=e!=null?e:!0}toggleListObject(t){this._isListObject=t}getData(t,e){const{path:n,row:o}=t,s=this._fieldIndexMap.get(n),i=e-o;return i===0?this._data.fields[s]:this._isListObject?this._data.records[i-1][n]:this._data.records[i-1][s]}setSourceData(t){super.setSourceData(t);const{fields:e}=t;this._fieldIndexMap.clear(),e.forEach((n,o)=>{this._fieldIndexMap.set(n,o)})}getSourceInfo(){return{sourceId:this.id,sourceType:this.type,fields:this._data.fields,recordCount:this._data.records.length}}}class O extends R{constructor(t){super(t);l(this,"type",I.Object)}getData(t){const n=t.path.split(".");let o=this._data;for(const s of n)if(o=o[s],o===void 0)return null;return o}getSourceInfo(){return{sourceId:this.id,sourceType:I.Object}}}class N extends a.Disposable{constructor(){super();l(this,"modelMap",new Map);l(this,"_cellBindInfoUpdate$",new v.Subject);l(this,"cellBindInfoUpdate$",this._cellBindInfoUpdate$.asObservable())}getBindingModelBySourceId(t){const e=[];return this.modelMap.forEach((n,o)=>{n.forEach((s,i)=>{const c=s.getBindingNodesBySourceId(t);if(c)for(const h of c)e.push({unitId:o,subunitId:i,sourceId:t,nodeId:h.nodeId,row:h.row,column:h.column})})}),e}addModel(t,e,n){var o;this.modelMap.has(t)||this.modelMap.set(t,new Map),(o=this.modelMap.get(t))==null||o.set(e,n)}getModel(t,e){var n;return(n=this.modelMap.get(t))==null?void 0:n.get(e)}setBindingNode(t,e,n){let o=this.getModel(t,e);o||(o=new T,this.addModel(t,e,o)),n.nodeId||(n.nodeId=a.generateRandomId());const{row:s,column:i}=n;if(s===void 0||i===void 0)throw new Error("row and column is required");const c=o.getBindingNode(s,i);o.setBindingNode(s,i,{...n,row:s,column:i}),this._cellBindInfoUpdate$.next({unitId:t,subunitId:e,sourceId:n.sourceId,nodeId:n.nodeId,row:s,column:i,changeType:c?M.Update:M.Add,oldSourceId:c==null?void 0:c.sourceId})}removeBindingNode(t,e,n,o){const s=this.getModel(t,e);if(s){const i=s.getBindingNode(n,o);i&&(s.removeBindingNode(n,o),this._cellBindInfoUpdate$.next({unitId:t,subunitId:e,sourceId:i.sourceId,nodeId:i.nodeId,row:n,column:o,changeType:M.Remove}))}}getBindingNode(t,e,n,o){const s=this.getModel(t,e);if(s)return s.getBindingNode(n,o)}createModel(t,e,n){const o=new T(n);return this.addModel(t,e,o),o}dispose(){this.modelMap.clear()}}class U extends a.Disposable{constructor(){super();l(this,"sourceMap",new Map);l(this,"_sourceDataUpdate$",new v.Subject);l(this,"sourceDataUpdate$",this._sourceDataUpdate$.asObservable())}_ensureUnitMap(t){let e=this.sourceMap.get(t);return e||(e=new Map,this.sourceMap.set(t,e)),e}_getUnitMap(t){return this.sourceMap.get(t)}getSource(t,e){const n=this._getUnitMap(t);return n==null?void 0:n.get(e)}createSource(t,e,n,o){const s=o===void 0?a.generateRandomId():o;let i;switch(e){case I.List:i=new P(s,n);break;case I.Object:i=new O(s);break;default:throw new Error(`Invalid source type: ${e}`)}return this._ensureUnitMap(t).set(s,i),i}updateSourceData(t,e,n){const o=this._getUnitMap(t),s=e instanceof R?e.getId():e,i=o==null?void 0:o.get(s);if(i)i.setSourceData(n),this._sourceDataUpdate$.next({...i.getSourceInfo(),unitId:t,changeType:M.Add});else throw new Error(`Source not found: ${s}`)}removeSource(t,e){const n=this._getUnitMap(t),o=n==null?void 0:n.get(e);o&&(n==null||n.delete(e),this._sourceDataUpdate$.next({...o.getSourceInfo(),unitId:t,changeType:M.Remove}))}}var $=Object.defineProperty,x=Object.getOwnPropertyDescriptor,E=(d,r,t,e)=>{for(var n=e>1?void 0:e?x(r,t):r,o=d.length-1,s;o>=0;o--)(s=d[o])&&(n=(e?s(r,t,n):s(n))||n);return e&&n&&$(r,t,n),n},D=(d,r)=>(t,e)=>r(t,e,d);u.SheetsSourceBindService=class extends a.Disposable{constructor(t,e,n){super();l(this,"_bindingModel",C.Value);l(this,"_bindModelRTreeCollection",new Map);this._sheetInterceptorService=t,this._sheetsBindingManager=e,this._sheetsSourceManager=n,this._registerInterceptor(),this._registerSourceChange()}usePathMode(){this._bindingModel=C.Path}useValueMode(){this._bindingModel=C.Value}getBindingModel(){return this._bindingModel}createBindModel(t,e){return this._sheetsBindingManager.createModel(t,e)}setBindingNode(t,e,n){this._sheetsBindingManager.setBindingNode(t,e,n)}removeBindingNode(t,e,n,o){this._sheetsBindingManager.removeBindingNode(t,e,n,o)}getBindingNode(t,e,n,o){return this._sheetsBindingManager.getBindingNode(t,e,n,o)}getSource(t,e){return this._sheetsSourceManager.getSource(t,e)}createSource(t,e,n,o){return this._sheetsSourceManager.createSource(t,e,n,o)}_ensureRTreeCollection(t){return this._bindModelRTreeCollection.has(t)||this._bindModelRTreeCollection.set(t,new a.RTree),this._bindModelRTreeCollection.get(t)}_getRTeeCollection(t){return this._bindModelRTreeCollection.get(t)}_registerSourceChange(){this.disposeWithMe(this._sheetsSourceManager.sourceDataUpdate$.subscribe(t=>{const{sourceId:e,sourceType:n,unitId:o,changeType:s}=t;if(n===I.List){if(s===M.Remove){const c=this._sheetsBindingManager.getBindingModelBySourceId(e),h=t.recordCount;for(const{unitId:g,subunitId:p,nodeId:f,row:S,column:_}of c){const B=this._getRTeeCollection(o);if(B){const m={startRow:S,startColumn:_,endRow:S+h,endColumn:_};B.remove({unitId:g,sheetId:p,id:f,range:m})}}return}if(s===M.Update){const c=t.oldRecordCount,h=this._sheetsBindingManager.getBindingModelBySourceId(e);for(const{unitId:g,subunitId:p,nodeId:f,row:S,column:_}of h){const B=this._getRTeeCollection(o);if(B){const m={startRow:S,startColumn:_,endRow:S+c,endColumn:_},w={startRow:S,startColumn:_,endRow:S+t.recordCount,endColumn:_};B.remove({unitId:g,sheetId:p,id:f,range:m}),B.insert({unitId:g,sheetId:p,id:f,range:w})}}return}const i=this._sheetsSourceManager.getSource(o,e);if(i&&i.hasData()){const h=i.getSourceInfo().recordCount,g=this._sheetsBindingManager.getBindingModelBySourceId(e);for(const{unitId:p,subunitId:f,nodeId:S,row:_,column:B}of g){const m=this._ensureRTreeCollection(p),w={startRow:_,startColumn:B,endRow:_+h,endColumn:B};m.insert({unitId:p,sheetId:f,id:S,range:w})}}}})),this.disposeWithMe(this._sheetsBindingManager.cellBindInfoUpdate$.subscribe(t=>{const{unitId:e,subunitId:n,sourceId:o,nodeId:s,row:i,column:c,changeType:h}=t,g=this._ensureRTreeCollection(e),p=this._sheetsSourceManager.getSource(e,o);if(p&&p.hasData()){const f=p.getSourceInfo();if(f.sourceType===I.List){const S=f.recordCount,_={startRow:i,startColumn:c,endRow:i+S,endColumn:c};if(h===M.Add)g.insert({unitId:e,sheetId:n,id:s,range:_});else if(h===M.Remove)g.remove({unitId:e,sheetId:n,id:s,range:_});else if(h===M.Update){const B=t.oldSourceId,m=this._sheetsSourceManager.getSource(e,B);if(m&&m.hasData()){const q=m.getSourceInfo().recordCount,J={startRow:i,startColumn:c,endRow:i+q,endColumn:c};g.remove({unitId:e,sheetId:n,id:s,range:J})}g.insert({unitId:e,sheetId:n,id:s,range:_})}}}}))}_getPathModeCellValue(t,e,n,o){const s=this._sheetsBindingManager.getModel(t,e),i=s==null?void 0:s.getBindingNode(n,o);if(i){const c=i.type;if(c===I.List)return{v:`#{${i.path}}`,s:{cl:{rgb:"blue"}}};if(c===I.Object)return{v:`[${i.path}]`,s:{cl:{rgb:"blue"}}}}}_getValueModeCellValue(t,e,n,o){const s=this._sheetsBindingManager.getModel(t,e);if(s){const c=s.getBindingNode(n,o);if(c){const{sourceId:h}=c,g=this._sheetsSourceManager.getSource(t,h);if(g&&g.hasData())return{v:(g==null?void 0:g.getData(c,n,o))||""}}}const i=this._getRTeeCollection(t);if(s&&i){const c={startRow:n,startColumn:o,endRow:n,endColumn:o},h=Array.from(i.bulkSearch([{unitId:t,sheetId:e,range:c}]));if(h.length>0){const g=s.getBindingNodeById(h[0]);if(g){const{sourceId:p}=g,f=this._sheetsSourceManager.getSource(t,p);if(f&&f.hasData())return{v:(f==null?void 0:f.getData(g,n,o))||""}}}}}_registerInterceptor(){this.disposeWithMe(this._sheetInterceptorService.intercept(y.INTERCEPTOR_POINT.CELL_CONTENT,{effect:a.InterceptorEffectEnum.Value,handler:(t,e,n)=>{const{row:o,col:s,unitId:i,subUnitId:c}=e;let h=null;return this._bindingModel===C.Path?h=this._getPathModeCellValue(i,c,o,s):h=this._getValueModeCellValue(i,c,o,s),n(h!==null?{...t,...h}:t)}}))}},u.SheetsSourceBindService=E([D(0,a.Inject(y.SheetInterceptorService)),D(1,a.Inject(N)),D(2,a.Inject(U))],u.SheetsSourceBindService);var V=Object.defineProperty,L=Object.getOwnPropertyDescriptor,A=(d,r,t,e)=>{for(var n=e>1?void 0:e?L(r,t):r,o=d.length-1,s;o>=0;o--)(s=d[o])&&(n=(e?s(r,t,n):s(n))||n);return e&&n&&V(r,t,n),n},j=(d,r)=>(t,e)=>r(t,e,d);u.UniverSheetsBindingSourcePlugin=(b=class extends a.Plugin{constructor(r={},t,e){super(),this._config=r,this._injector=t,this._configService=e}onStarting(){[[N],[U],[u.SheetsSourceBindService]].forEach(r=>this._injector.add(r))}onReady(){a.touchDependencies(this._injector,[[N],[U],[u.SheetsSourceBindService]])}},l(b,"type",a.UniverInstanceType.UNIVER_SHEET),l(b,"pluginName","SHEET_BINDING_SOURCE_PLUGIN"),b),u.UniverSheetsBindingSourcePlugin=A([j(1,a.Inject(a.Injector)),j(2,a.IConfigService)],u.UniverSheetsBindingSourcePlugin),u.BindModeEnum=C,u.BindingModel=T,u.DataBindingNodeTypeEnum=I,u.SourceModelBase=R,Object.defineProperty(u,Symbol.toStringTag,{value:"Module"})});

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@univerjs/sheets-source-binding",
+  "version": "0.5.4-nightly.202501150735",
+  "private": false,
+  "description": "A library for connect and bind data from other sources to Univer Sheets",
+  "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/*": "./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.5.4-nightly.202501150735",
+    "@univerjs/sheets": "0.5.4-nightly.202501150735"
+  },
+  "devDependencies": {
+    "rxjs": "^7.8.1",
+    "typescript": "^5.7.2",
+    "vite": "^6.0.7",
+    "vitest": "^2.1.8",
+    "@univerjs-infra/shared": "0.5.4"
+  },
+  "scripts": {
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "coverage": "vitest run --coverage",
+    "lint:types": "tsc --noEmit",
+    "build": "univer-cli build"
+  },
+  "module": "./lib/es/index.js"
+}