rhine-var 0.4.2 → 0.4.5

package/README.md

@@ -146,22 +146,25 @@ More information about server develop: [https://docs.yjs.dev/ecosystem/connectio
 
 ## Develop
 
+### Preparation (Only needed for the first-time setup)
 ```bash
-# start watch and build by typescript
-yarn run watch
-yarn link
-
-# start a easy websocket server
-cd test/server
+# Install dependencies
 yarn install
-yarn start
+# Install dependencies for the NextJs environment debugging project
+yarn run install-next
+# Link this library to the NextJs environment debugging project
+yarn run link-next
+```
 
-# start a nextjs playground for develop debug
-cd test/debug/next-app
-yarn link rhine-var  # Install rhine-var from local
-yarn install
-yarn start
-# Open http://localhost:3000 in browser
+### Start Debugging
+```bash
+# Enable real-time TypeScript compilation
+yarn run watch
+# Start the temporary local server, default port is 6600
+yarn run server
+# Start the NextJs environment debugging project, default port is 6700
+yarn run next
+# The browser will navigate to http://localhost:6700
 ```
 
 <br/>

package/README_zh.md

@@ -163,23 +163,26 @@ yarn start
 
 欢迎参与 RHINE-VAR 库的共同开发。本库内有基本的服务端，和调试用 NextJS 项目，可以满足大部分开发过程基本需求。
 
-```bash
-# 开始 typescript 自动构建更新
-yarn run watch
-yarn link
-
-# 开启临时服务端
-cd test/server
-yarn install
-yarn start
 
-# 开始 NextJS 的热环境调试测试项目
-cd test/debug/next-app
-yarn link rhine-var  # 从本地目录安装 rhine-var 以用于实时开发
+### 准备工作 仅初次使用时需执行
+```bash
+# 安装依赖
 yarn install
-yarn start
-# 浏览器访问 http://localhost:3000
+# 安装 NextJs 环境调试项目的依赖
+yarn run install-next
+# 链接本库到 NextJs 环境调试项目
+yarn run link-next
+```
 
+### 开始调试
+```bash
+# 启用 typescript 实时编译
+yarn run watch
+# 启用临时本地服务端 默认端口6600 
+yarn run server
+# 启动 NextJs 环境调试项目 默认端口6700
+yarn run next
+# 浏览器将跳转至 http://localhost:6700
 ```
 
 <br/>

package/dist/core/native/NativeUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"NativeUtils.d.ts","sourceRoot":"","sources":["../../../src/core/native/NativeUtils.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,MAAM,EAAC,iBAA6B;AAI5C,wBAAgB,QAAQ,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CAE5C;AAED,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,OAAO,CAuBnF;AAED,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAkBvE;AAED,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAYtD;AAED,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAwB1E;AAED,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,GAAG,GAAG,SAAS,CAgB/E;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,GAAG,GAAG,MAAM,GAAG,GAAG,CAgBpD"}
+{"version":3,"file":"NativeUtils.d.ts","sourceRoot":"","sources":["../../../src/core/native/NativeUtils.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,MAAM,EAAC,iBAA6B;AAK5C,wBAAgB,QAAQ,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CAE5C;AAED,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,OAAO,CA0BnF;AAED,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAkBvE;AAED,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAYtD;AAED,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAwB1E;AAED,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,GAAG,GAAG,SAAS,CAgB/E;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,GAAG,GAAG,MAAM,GAAG,GAAG,CAgBpD"}

package/dist/core/native/NativeUtils.js

@@ -1,4 +1,7 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isNative = isNative;
 exports.nativeSet = nativeSet;
@@ -9,6 +12,7 @@ exports.nativeGet = nativeGet;
 exports.jsonToNative = jsonToNative;
 const yjs_1 = require("yjs");
 const DataUtils_1 = require("../utils/DataUtils");
+const RhineVarItem_1 = __importDefault(require("../proxy/RhineVarItem"));
 function isNative(value) {
     return (value instanceof yjs_1.Map) || (value instanceof yjs_1.Array);
 }
@@ -16,6 +20,9 @@ function nativeSet(target, key, value) {
     if (typeof key !== 'string') {
         return false;
     }
+    if (value instanceof RhineVarItem_1.default) {
+        value = value.native;
+    }
     try {
         if (target instanceof yjs_1.Map) {
             target.set(key, value);

package/dist/core/proxy/Proxy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Proxy.d.ts","sourceRoot":"","sources":["../../../src/core/proxy/Proxy.ts"],"names":[],"mappings":"AACA,OAAO,uBAAgD,6CAAiD;AACxG,OAAO,YAA+C,uBAAkC;AAIxF,OAAO,EAAC,eAAe,EAAE,mBAAmB,EAAC,0BAAqC;AAClF,OAAO,EAAC,MAAM,EAAC,yBAA6B;AAS5C,OAAO,QAAQ,mBAA8B;AAG7C,eAAO,MAAM,aAAa,UAAsB,CAAA;AAChD,eAAO,MAAM,qBAAqB,QAAmB,CAAA;AAGrD,wBAAgB,UAAU,CAAC,CAAC,SAAS,MAAM,EACzC,YAAY,EAAE,CAAC,GAAG,MAAM,EACxB,SAAS,EAAE,uBAAuB,GAAG,MAAM,EAC3C,SAAS,GAAE,OAAO,GAAG,MAAc,GAClC,eAAe,CAAC,CAAC,CAAC,CA6CpB;AAGD,wBAAgB,cAAc,CAAC,CAAC,SAAS,MAAM,EAC7C,IAAI,EAAE,CAAC,GAAG,MAAM,EAChB,MAAM,GAAE,QAAQ,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,GAAG,CAAC,GAAG,IAAW,GACtD,mBAAmB,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,CAgG7C"}
+{"version":3,"file":"Proxy.d.ts","sourceRoot":"","sources":["../../../src/core/proxy/Proxy.ts"],"names":[],"mappings":"AACA,OAAO,uBAAgD,6CAAiD;AACxG,OAAO,YAA+C,uBAAkC;AAIxF,OAAO,EAAC,eAAe,EAAE,mBAAmB,EAAC,0BAAqC;AAClF,OAAO,EAAC,MAAM,EAAC,yBAA6B;AAS5C,OAAO,QAAQ,mBAA8B;AAG7C,eAAO,MAAM,aAAa,UAAsB,CAAA;AAChD,eAAO,MAAM,qBAAqB,QAAmB,CAAA;AAGrD,wBAAgB,UAAU,CAAC,CAAC,SAAS,MAAM,EACzC,YAAY,EAAE,CAAC,GAAG,MAAM,EACxB,SAAS,EAAE,uBAAuB,GAAG,MAAM,EAC3C,SAAS,GAAE,OAAO,GAAG,MAAc,GAClC,eAAe,CAAC,CAAC,CAAC,CA+CpB;AAGD,wBAAgB,cAAc,CAAC,CAAC,SAAS,MAAM,EAC7C,IAAI,EAAE,CAAC,GAAG,MAAM,EAChB,MAAM,GAAE,QAAQ,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,GAAG,CAAC,GAAG,IAAW,GACtD,mBAAmB,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,CA2F7C"}

package/dist/core/proxy/Proxy.js

@@ -70,6 +70,9 @@ function rhineProxy(defaultValue, connector, overwrite = false) {
                         if ((0, NativeUtils_1.isNative)(value)) {
                             Reflect.set(object.origin, key, rhineProxyItem(value, object));
                         }
+                        else {
+                            Reflect.set(object.origin, key, value);
+                        }
                     });
                 }
                 else {
@@ -139,13 +142,7 @@ function rhineProxyItem(data, parent = null) {
                 return Reflect.set(object, p, value, receiver);
             (0, Logger_1.log)('Proxy.handler.set:', p, 'to', value, '  ', object, receiver);
             value = (0, DataUtils_1.ensureRhineVar)(value, object);
-            let result = false;
-            if ((0, DataUtils_1.isObjectOrArray)(value)) {
-                result = (0, NativeUtils_1.nativeSet)(object.native, p, value.native);
-            }
-            else {
-                result = (0, NativeUtils_1.nativeSet)(object.native, p, value);
-            }
+            let result = (0, NativeUtils_1.nativeSet)(object.native, p, value);
             if (!result)
                 console.error('Failed to set value');
             return result;

package/dist/core/proxy/RhineVarItem.js

@@ -154,14 +154,14 @@ class RhineVarItem {
                     if (action === 'add' || action === 'update') {
                         value = target.get(key);
                         if ((0, DataUtils_1.isObjectOrArray)(value)) {
-                            Reflect.set(this, key, (0, Proxy_1.rhineProxyItem)(value, this));
+                            Reflect.set(this.origin, key, (0, Proxy_1.rhineProxyItem)(value, this));
                         }
                         else {
-                            Reflect.set(this, key, value);
+                            Reflect.set(this.origin, key, value);
                         }
                     }
                     else if (action === 'delete') {
-                        Reflect.deleteProperty(this, key);
+                        Reflect.deleteProperty(this.origin, key);
                     }
                     const newValue = key in this ? Reflect.get(this, key) : value;
                     (0, Logger_1.log)('Proxy.event: Map', action, key + ':', oldValue, '->', newValue);
@@ -184,11 +184,11 @@ class RhineVarItem {
                             if (oldValue instanceof RhineVarItem) {
                                 oldValue = oldValue.frozenJson();
                             }
-                            Reflect.deleteProperty(this, i);
+                            Reflect.deleteProperty(this.origin, i);
                             for (let k = i + 1; k < target.length + deltaItem.delete; k++) {
                                 const value = Reflect.get(this, k);
-                                Reflect.set(this, k - 1, value);
-                                Reflect.deleteProperty(this, k);
+                                Reflect.set(this.origin, k - 1, value);
+                                Reflect.deleteProperty(this.origin, k);
                             }
                             (0, Logger_1.log)('Proxy.event: Array delete', i + ':', oldValue, '->', undefined);
                             this.emit(i, undefined, oldValue, ChangeType_1.ChangeType.Delete, event, transaction);
@@ -200,13 +200,13 @@ class RhineVarItem {
                             i++;
                             for (let k = target.length - 1; k >= i; k--) {
                                 const existingValue = Reflect.get(this, k);
-                                Reflect.set(this, k + 1, existingValue);
+                                Reflect.set(this.origin, k + 1, existingValue);
                             }
                             if ((0, DataUtils_1.isObjectOrArray)(value)) {
-                                Reflect.set(this, i, (0, Proxy_1.rhineProxyItem)(value, this));
+                                Reflect.set(this.origin, i, (0, Proxy_1.rhineProxyItem)(value, this));
                             }
                             else {
-                                Reflect.set(this, i, value);
+                                Reflect.set(this.origin, i, value);
                             }
                             const newValue = i in this ? Reflect.get(this, i) : target.get(i);
                             (0, Logger_1.log)('Proxy.event: Array add', i, ':', undefined, '->', newValue);

package/dist/react/hooks/useRhine.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useRhine.d.ts","sourceRoot":"","sources":["../../../src/react/hooks/useRhine.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,eAAe,EAAC,yCAAqC;AAE7D,MAAM,CAAC,OAAO,UAAU,QAAQ,CAAC,CAAC,SAAS,MAAM,EAAE,KAAK,EAAE,eAAe,CAAC,CAAC,CAAC,KAe3E"}
+{"version":3,"file":"useRhine.d.ts","sourceRoot":"","sources":["../../../src/react/hooks/useRhine.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,eAAe,EAAC,yCAAqC;AAE7D,MAAM,CAAC,OAAO,UAAU,QAAQ,CAAC,CAAC,SAAS,MAAM,EAAE,KAAK,EAAE,eAAe,CAAC,CAAC,CAAC,KAgB3E"}

package/dist/react/hooks/useRhine.js

@@ -4,15 +4,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = useRhine;
 const react_1 = require("react");
 function useRhine(proxy) {
-    const [state, setState] = (0, react_1.useState)(proxy.json());
+    const getState = () => proxy.json();
+    const [state, setState] = (0, react_1.useState)(getState);
     (0, react_1.useEffect)(() => {
         var _a;
         proxy.subscribe(() => {
             // TODO: 提高性能
-            setState(proxy.json());
+            setState(getState);
         });
         (_a = proxy.connector) === null || _a === void 0 ? void 0 : _a.addSyncedListener(() => {
-            setState(proxy.json());
+            setState(getState);
         });
     }, []);
     return state;

package/package.json

@@ -1,14 +1,20 @@
 {
   "name": "rhine-var",
-  "version": "0.4.2",
+  "version": "0.4.5",
   "description": "Variables that support multi-user collaboration and persistence, making collaboration and variable operations as simple as possible, with strict and well-defined type hints.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "prepare": "ts-patch install -s",
-    "build": "tsc",
+    "install-next": "npm install --prefix ./test/debug/next-app",
+    "link-next": "npm link && npm link rhine-var --prefix ./test/debug/next-app",
+
     "watch": "tsc --watch",
+    "server": "npm run start --prefix ./test/server",
+    "next": "npm run dev --prefix ./test/debug/next-app",
+
     "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "tsc",
     "publish": "npm publish"
   },
   "author": "RhineAI",
@@ -40,8 +46,11 @@
     "typescript-transform-paths": "^3.5.0"
   },
   "dependencies": {
-    "react": "^18.3.1",
     "y-websocket": "^2.0.4",
     "yjs": "^13.6.18"
+  },
+  "peerDependencies": {
+    "react": ">=16.8.0",
+    "react-dom": ">=16.8.0"
   }
 }