rhine-var 0.1.7 → 0.3.1

package/README.md

@@ -1,46 +1,136 @@
+<div align="center">
 
-# The most concise and rigorous strongly-typed real-time collaborative editing library.
+# RHINE-VAR: Simplest and Most Powerful Collaborative Framework
 
-Variables that support multi-user collaboration and persistence, making collaboration and variable operations as simple as possible, with strict and well-defined type hints.
+Rhine Variable — A self-synchronizing variable for collaboration.
+Developing collaborative applications has never been this easy.
+
+
+[English](README.md) &nbsp; | &nbsp; [中文](README_zh.md)
+
+<img src='./assets/images/example1.png' style="border-radius: 10px; max-width: 840px"/>
+
+</div>
+
+
+## Why Choose RHINE-VAR ?
+
+#### Concise and Efficient Syntax Design
+RhineVar draws inspiration from the design philosophy of the Valtio state management library, significantly reducing the learning curve. Developers can easily manage collaborative data as if they were manipulating regular variables.
+
+#### Comprehensive Type Support
+RhineVar offers full type hints and checks, ensuring precise code completion and static analysis during development. This not only improves the development experience but also reduces potential errors, making it especially suitable for TypeScript projects, enhancing code safety and reliability.
+
+#### Distributed Real-time Collaboration Algorithm
+The underlying collaboration algorithm of RhineVar is powered by the robust Yjs library. Using the CRDT (Conflict-free Replicated Data Type) algorithm, it ensures eventual consistency even in multi-user and offline environments.
+
+#### High Performance with Low Bandwidth Requirements
+The data synchronization and conflict resolution mechanism is highly efficient. Leveraging Yjs's incremental update mechanism, only necessary data changes are transmitted rather than the entire document, making it ideal for bandwidth-constrained environments and reducing unnecessary data transfers.
+
+#### Strong Offline Support
+Users can continue to work even while offline. Once reconnected, all changes are automatically synchronized, ensuring no data is lost or conflicted. This is crucial for building offline-first applications.
+
+#### Cross-platform and Framework Agnostic
+RhineVar can be used in various environments, including browsers, Node.js, and other JavaScript platforms. It integrates with multiple frontend frameworks and libraries such as Next.js, React, Vue.js, ProseMirror, and more.
+
+#### Lightweight and Extensible
+RhineVar is a highly lightweight library, with its core package only a few KB in size, making it suitable for various frontend applications. Its modular architecture supports feature extensions, allowing developers to import or develop custom modules as needed.
+
+#### Decentralized Architecture
+With a decentralized architecture, collaborative editing becomes more scalable, efficient, and fault-tolerant. Peer-to-peer data transfer is supported without relying on a central server (currently under development).
+
+#### Native Yjs Support
+RhineVar offers full support for native Yjs object operations, providing lower-level, richer API support. Direct operations on Yjs objects automatically trigger updates in RhineVar.
+
+#### More Friendly and Complete Event System
+RhineVar offers an extensive event subscription and listening system with intuitive data change events. It also supports deep data change monitoring within objects, catering to a wide range of use cases.
+
+
+
+## Contact Us
+Welcome to join our WeChat group for communication. We look forward to having more community members participate in the creation of rhine-var.
+
+WeChat: [FNA-04]()
+
+Email: [RhineAILab@gmail.com](rhineailab@gmail.com) & [RhineAI@163.com](RhineAI@163.com)
+
+<br/>
 
 ## Install
 ```bash
-npm i rhine-var
-```
-Or with yarn:
-```bash
 yarn add rhine-var
 ```
+If you don't have `yarn`, you can install it via `npm i rhine-var`, or install `yarn` first using `npm i -g yarn` and then use the command above to install.
 
 ## Usage
 
-
 ```typescript jsx
 const defaultValue = {value: 0}
-const count = rhineProxy(defaultValue, 'RhineAI.com/ws/room-0')
-
-function EasyCounter() {
+const count = rhineProxy(defaultValue, 'localhost:6600/room-0')
 
+function Counter() {
+  
   const countSnap = useRhine(count)
-
-  return <div className='page'>
+  
+  return <div>
     <button onClick={() => count.value-- }> - 1 </button>
     <span>{countSnap.value}</span>
     <button onClick={() => count.value++ }> + 1 </button>
   </div>
 }
 ```
+#### Default Value
+
+When the room does not exist on the server, a default value will be used to create the room. If not connected to the server, data from the default value will also be returned.
+
+#### Room ID
+
+The `Same Room ID` manages the `Same State Variables`, and users who join will experience real-time multi-user collaboration.
+
+### rhineProxy
+
+Create a `RhineVariable` that anyone in the room can directly modify, and the value will be synchronized to everyone almost simultaneously.
+
+Its value is `at least an object` in javascript, `but` there is almost no upper limit. It can be an `extremely complex and large JSON structure` to accommodate all the data for a large project.
+
+### useRhine
+
+A hook for use with React. It creates a snapshot of a `RhineVariable`, and whenever someone modifies this value, the information will be `updated on everyone's screen` in real-time.
+
+Use snapshot only when data needs to be displayed on the React page. For other operations, such as modifying values, please use RhineVariable itself.
 
 <br/>
 
-## Develop With US
+## Server
+We provide a simple server as a reference, located at `/test/server` in this project. The server is fully compatible with all Yjs websocket servers.
+```
+git clone https://github.com/RhineAI-Lab/rhine-var.git
+cd test/server
+yarn install
+yarn start
+```
+It will run on `Port 6600`, and you can connect to it via `ws://localhost:6600/<room-id>`. `<room-id>` can be any text, with each room ID corresponding to a `RhineVariable`.
 
-Start Debug Mode
+More information about server develop: [https://docs.yjs.dev/ecosystem/connection-provider/y-websocket](https://docs.yjs.dev/ecosystem/connection-provider/y-websocket)
+
+<br/>
+
+## Develop
 
 ```bash
-npm run watch
+# start watch and build by typescript
+yarn run watch
+
+# start a easy websocket server
+cd test/server
+yarn install
+yarn start
+
+# start a nextjs playground for develop debug
 cd test/debug/next-app
-npm run dev
+yarn install
+yarn start
+# Open http://localhost:3000 in browser
 ```
 
 <br/>

package/README_zh.md

@@ -0,0 +1,126 @@
+<div align="center">
+
+# 最简单且强大的多人协同框架 RHINE-VAR
+
+莱茵变量 —— 会自己与他人协同的变量 &nbsp; 多人协同应用开发从未如此简单 
+
+[English](README.md) &nbsp; | &nbsp; [中文](README_zh.md)
+
+<img src='./assets/images/example1.png' style="border-radius: 10px; max-width: 840px"/>
+
+</div>
+
+
+## 为什么选择 RHINE-VAR ?
+
+**简洁高效的语法设计:** &nbsp; RhineVar 借鉴了 Valtio 状态管理库的设计理念，极大地降低了学习成本。开发者可以像操作普通变量一样轻松操控协同数据。
+
+**完备的类型支持：** &nbsp; RhineVar 提供全面的类型提示和类型检查，确保在开发过程中能够获得精确的代码补全和静态分析。这不仅改善了开发体验，还有效降低了潜在的错误风险，特别适用于 TypeScript 项目，提升了代码的安全性和可靠性。
+
+**分布式实时协作算法:** &nbsp; RhineVar 的底层协同算法基于强大的 Yjs 库。通过 CRDT (Conflict-free Replicated Data Type，无冲突复制数据类型) 算法，确保多用户同时使用，甚至离线下使用的最终一致性。
+
+**高性能和低带宽需求:** &nbsp; 数据同步和冲突解决机制非常高效，通过 Yjs 的增量更新机制，仅传输必要的数据更改，而非整个文档。这使得它在网络带宽受限的环境中表现良好，减少了不必要的数据传输。
+
+**强大的离线支持:** &nbsp; 即使在离线状态下，用户仍然可以继续使用应用。当重新联机时，所有更改将自动同步，确保数据不会出现丢失或冲突。这对于构建离线优先的应用至关重要。
+
+**跨平台和框架无关:** &nbsp; RhineVar 支持在多种环境中使用，包括浏览器、Node.js 和其他 JavaScript 环境。此外，它可以与多个前端框架和库 (如 NextJs、React、Vue.js、ProseMirror 等) 集成。
+
+**轻量级且可扩展:** &nbsp; RhineVar 是一个非常轻量的库，核心包仅几 KB，适合各种前端应用。其模块化架构也支持扩展特性，开发者可以根据需要引入或开发自定义模块。
+
+**去中心化架构:** &nbsp; 通过去中心化架构，使得协作编辑更具扩展性、更高效且更具容错能力。可通过 P2P 进行数据传输，无需依赖中央服务器（开发中）。
+
+**原生Yjs支持:** &nbsp; RhineVar 提供完好的Yjs原生对象操作支持，更底层更丰富的API支持。直接对Yjs的对象进行操作，也将自动触发 RhineVar 的更新。
+
+**更友好且完善的事件体系:** &nbsp; RhineVar 提供了丰富的事件订阅监听方式，直观的数据变更事件，更好的支持数据变更的监听和处理。以及提供了对内部深层数据变化的监听，以适用更多场景。
+
+
+## Contact Us
+
+欢迎加入我们的微信群一起讨论交流，我们期待更多的社区成员能加入到 RHINE-VAR 的创造中来！
+
+微信: [FNA-04]() (请备注来源)
+
+邮箱: [RhineAILab@gmail.com](rhineailab@gmail.com) & [RhineAI@163.com](RhineAI@163.com)
+
+<br/>
+
+## Install
+```bash
+yarn add rhine-var
+```
+如果你的电脑未安装`yarn`, 也可通过 `npm i rhine-var` 安装。或先用 `npm i -g yarn` 安装`yarn`，然后再用上方命令进行安装。
+
+## Usage
+
+```typescript jsx
+const defaultValue = {value: 0}
+const count = rhineProxy(defaultValue, 'localhost:6600/room-0')
+
+function Counter() {
+  
+  const countSnap = useRhine(count)
+  
+  return <div>
+    <button onClick={() => count.value-- }> - 1 </button>
+    <span>{countSnap.value}</span>
+    <button onClick={() => count.value++ }> + 1 </button>
+  </div>
+}
+```
+#### Default Value
+
+当服务端无信息时，将使用 DefaultValue 作为默认内容。未连接到服务器时，也将根据默认值进行返回。
+
+#### Room ID
+
+一个房间号对应一个状态变量, 加入到一个房间中的用户会参与到多人协同中。
+
+### rhineProxy
+
+用于创建一个 `RhineVariable` 他的值会和房间中的其他人共享并同步。
+
+你可以像操作 JavaScript 中的普通变量一样直接随意操作他。
+
+值的类型至少是 JavaScript 中的 object，但没有上限。它可以是一个非常复杂和庞大的 JSON 结构，以容纳大型项目的所有数据。
+
+### useRhine
+
+一个 `React` 的 `Hook` 函数. 他将为 `RhineVariable` 创建一个快照, 用于自动热重载更新页面。当任何人对值做出修改时，他会把最新的值立刻更新到所有人的屏幕上。
+
+只有页面需要数据的时候使用 `useRhine` 创造的快照。在其他操作，例如赋值时，请操作原来的 `RhineVariable`。
+
+<br/>
+
+## Server
+我们提供了一个简单的服务器例子，位于本项目中的 `/test/server` 处。 服务端完全兼容所有的 Yjs 的 Websocket 服务器，将来会支持更多。
+```
+git clone https://github.com/RhineAI-Lab/rhine-var.git
+cd test/server
+yarn install
+yarn start
+```
+默认运行在 `端口 6600`, 你可以通过连接 `ws://localhost:6600/<room-id>` 连接他，`<room-id>` 可以是任意文本，一个房间号对应一个 `RhineVariable`。
+
+更多服务端开发信息请参考: [https://docs.yjs.dev/ecosystem/connection-provider/y-websocket](https://docs.yjs.dev/ecosystem/connection-provider/y-websocket)
+
+<br/>
+
+## Develop
+
+```bash
+# 开始 typescript 自动构建更新
+yarn run watch
+
+# 开启临时服务端
+cd test/server
+yarn install
+yarn start
+
+# 开始 NextJS 的热环境调试测试项目
+cd test/debug/next-app
+yarn install
+yarn start
+# 浏览器访问 http://localhost:3000
+```
+
+<br/>

package/dist/core/class/array/RhineArray.d.ts

@@ -1,3 +1,4 @@
-export default class RhineArray<T> {
+import RhineVar from "../../proxy/RhineVar";
+export default class RhineArray<T> extends Array<T | RhineVar<T[]>> {
 }
 //# sourceMappingURL=RhineArray.d.ts.map

package/dist/core/class/array/RhineArray.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RhineArray.d.ts","sourceRoot":"","sources":["../../../../src/core/class/array/RhineArray.ts"],"names":[],"mappings":"AACA,MAAM,CAAC,OAAO,OAAO,UAAU,CAAC,CAAC;CAEhC"}
+{"version":3,"file":"RhineArray.d.ts","sourceRoot":"","sources":["../../../../src/core/class/array/RhineArray.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,6BAA8B;AAE7C,MAAM,CAAC,OAAO,OAAO,UAAU,CAAC,CAAC,CAAE,SAAQ,KAAK,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;CAElE"}

package/dist/core/class/array/RhineArray.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-class RhineArray {
+class RhineArray extends Array {
 }
 exports.default = RhineArray;

package/dist/core/class/array/RhineVarArray.d.ts

@@ -0,0 +1,4 @@
+import RhineVar from "../../proxy/RhineVar";
+export default class RhineVarArray<T> extends Array<T | RhineVar<T[]>> {
+}
+//# sourceMappingURL=RhineVarArray.d.ts.map

package/dist/core/class/array/RhineVarArray.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RhineVarArray.d.ts","sourceRoot":"","sources":["../../../../src/core/class/array/RhineVarArray.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,6BAA8B;AAE7C,MAAM,CAAC,OAAO,OAAO,aAAa,CAAC,CAAC,CAAE,SAAQ,KAAK,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;CAErE"}

package/dist/core/class/array/RhineVarArray.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class RhineVarArray extends Array {
+}
+exports.default = RhineVarArray;

package/dist/core/connector/WebsocketRhineConnector.d.ts

@@ -16,6 +16,7 @@ export default class WebsocketRhineConnector {
     addSyncedListener(listener: SyncedListener): void;
     removeSyncedListener(listener: SyncedListener): void;
     emitSynced(synced: boolean): void;
+    afterSynced(callback: () => void): void;
     waitSynced(): Promise<void>;
     constructor(url?: string);
     bind(defaultValue: Native, overwrite?: boolean): any;

package/dist/core/connector/WebsocketRhineConnector.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"WebsocketRhineConnector.d.ts","sourceRoot":"","sources":["../../../src/core/connector/WebsocketRhineConnector.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,GAAG,IAAI,IAAI,EAAmB,GAAG,IAAI,IAAI,EAAC,MAAM,KAAK,CAAC;AAC9D,OAAO,EAAC,iBAAiB,EAAC,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAC,eAAe,EAAC,0BAAyC;AAEjE,OAAO,EAAC,MAAM,EAAC,yBAA6B;AAE5C,MAAM,MAAM,cAAc,GAAG,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAA;AAEtD,MAAM,CAAC,OAAO,OAAO,uBAAuB;IAE1C,MAAM,CAAC,SAAS,SAAU;IAE1B,IAAI,EAAE,IAAI,CAAA;IACV,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,CAAA;IACnB,GAAG,EAAE,MAAM,CAAK;IAEhB,QAAQ,SAAK;IACb,MAAM,UAAQ;IAEd,QAAQ,EAAE,iBAAiB,GAAG,IAAI,CAAO;IACzC,eAAe,EAAE,eAAe,CAA+B;IAG/D,eAAe,EAAE,cAAc,EAAE,CAAK;IACtC,iBAAiB,CAAC,QAAQ,EAAE,cAAc;IAG1C,oBAAoB,CAAC,QAAQ,EAAE,cAAc;IAG7C,UAAU,CAAC,MAAM,EAAE,OAAO;IAI1B,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;gBAcf,GAAG,SAAK;IAMpB,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,SAAS,GAAE,OAAe;IAc/C,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CA4C1C;AAGD,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,MAAM,2BAMhD"}
+{"version":3,"file":"WebsocketRhineConnector.d.ts","sourceRoot":"","sources":["../../../src/core/connector/WebsocketRhineConnector.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,GAAG,IAAI,IAAI,EAAmB,GAAG,IAAI,IAAI,EAAC,MAAM,KAAK,CAAC;AAC9D,OAAO,EAAC,iBAAiB,EAAC,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAC,eAAe,EAAC,0BAAyC;AAEjE,OAAO,EAAC,MAAM,EAAC,yBAA6B;AAE5C,MAAM,MAAM,cAAc,GAAG,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAA;AAEtD,MAAM,CAAC,OAAO,OAAO,uBAAuB;IAE1C,MAAM,CAAC,SAAS,SAAU;IAE1B,IAAI,EAAE,IAAI,CAAA;IACV,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,CAAA;IACnB,GAAG,EAAE,MAAM,CAAK;IAEhB,QAAQ,SAAK;IACb,MAAM,UAAQ;IAEd,QAAQ,EAAE,iBAAiB,GAAG,IAAI,CAAO;IACzC,eAAe,EAAE,eAAe,CAA+B;IAG/D,eAAe,EAAE,cAAc,EAAE,CAAK;IACtC,iBAAiB,CAAC,QAAQ,EAAE,cAAc;IAG1C,oBAAoB,CAAC,QAAQ,EAAE,cAAc;IAG7C,UAAU,CAAC,MAAM,EAAE,OAAO;IAI1B,WAAW,CAAC,QAAQ,EAAE,MAAM,IAAI;IAahC,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;gBAOf,GAAG,SAAK;IAMpB,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,SAAS,GAAE,OAAe;IAc/C,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CA4C1C;AAGD,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,MAAM,2BAMhD"}

package/dist/core/connector/WebsocketRhineConnector.js

@@ -15,17 +15,23 @@ class WebsocketRhineConnector {
     emitSynced(synced) {
         this.syncedListeners.forEach(listener => listener(synced));
     }
-    waitSynced() {
-        return new Promise((resolve) => {
-            if (this.synced)
-                return true;
+    afterSynced(callback) {
+        if (this.synced) {
+            callback();
+        }
+        else {
             const listener = (synced) => {
                 if (synced) {
                     this.removeSyncedListener(listener);
-                    resolve();
+                    callback();
                 }
             };
             this.addSyncedListener(listener);
+        }
+    }
+    waitSynced() {
+        return new Promise((resolve) => {
+            this.afterSynced(resolve);
         });
     }
     constructor(url = '') {

package/dist/core/event/Callback.d.ts

@@ -1,4 +1,4 @@
 import { ChangeType } from "./ChangeType";
 import { Transaction, YArrayEvent, YMapEvent } from "yjs";
-export type Callback = (value: any, key: string, oldValue: any, type: ChangeType, nativeEvent: YMapEvent<any> | YArrayEvent<any>, nativeTransaction: Transaction) => void;
+export type Callback<T> = (value: T[keyof T], key: keyof T, oldValue: T[keyof T], type: ChangeType, nativeEvent: YMapEvent<any> | YArrayEvent<any>, nativeTransaction: Transaction) => void;
 //# sourceMappingURL=Callback.d.ts.map

package/dist/core/event/Callback.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Callback.d.ts","sourceRoot":"","sources":["../../../src/core/event/Callback.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,qBAAgC;AACnD,OAAO,EAAC,WAAW,EAAE,WAAW,EAAE,SAAS,EAAC,MAAM,KAAK,CAAC;AAExD,MAAM,MAAM,QAAQ,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,SAAS,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC,GAAG,CAAC,EAAE,iBAAiB,EAAE,WAAW,KAAK,IAAI,CAAA"}
+{"version":3,"file":"Callback.d.ts","sourceRoot":"","sources":["../../../src/core/event/Callback.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,qBAAgC;AACnD,OAAO,EAAC,WAAW,EAAE,WAAW,EAAE,SAAS,EAAC,MAAM,KAAK,CAAC;AAGxD,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CACxB,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,EACjB,GAAG,EAAE,MAAM,CAAC,EACZ,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,EACpB,IAAI,EAAE,UAAU,EAChB,WAAW,EAAE,SAAS,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC,GAAG,CAAC,EAC9C,iBAAiB,EAAE,WAAW,KAC3B,IAAI,CAAA"}

package/dist/core/event/ChangeType.d.ts

@@ -1,6 +1,7 @@
 export declare enum ChangeType {
     Add = "add",
     Update = "update",
-    Delete = "delete"
+    Delete = "delete",
+    Sync = "sync"
 }
 //# sourceMappingURL=ChangeType.d.ts.map

package/dist/core/event/ChangeType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ChangeType.d.ts","sourceRoot":"","sources":["../../../src/core/event/ChangeType.ts"],"names":[],"mappings":"AACA,oBAAY,UAAU;IACpB,GAAG,QAAQ;IACX,MAAM,WAAW;IACjB,MAAM,WAAW;CAClB"}
+{"version":3,"file":"ChangeType.d.ts","sourceRoot":"","sources":["../../../src/core/event/ChangeType.ts"],"names":[],"mappings":"AACA,oBAAY,UAAU;IACpB,GAAG,QAAQ;IACX,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,IAAI,SAAS;CACd"}

package/dist/core/event/ChangeType.js

@@ -6,4 +6,5 @@ var ChangeType;
     ChangeType["Add"] = "add";
     ChangeType["Update"] = "update";
     ChangeType["Delete"] = "delete";
+    ChangeType["Sync"] = "sync";
 })(ChangeType || (exports.ChangeType = ChangeType = {}));

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

@@ -1,8 +1,9 @@
-import { Map as YMap, Array as YArray } from "yjs";
 import { Native } from "./Native";
-export declare function isYMapOrYArray(value: any): value is YMap<any> | YArray<any>;
+export declare function isNative(value: any): boolean;
 export declare function nativeSet(target: Native, key: string | symbol, value: any): boolean;
+export declare function nativeHas(target: Native, key: string | symbol): boolean;
+export declare function nativeOwnKeys(target: Native): string[];
 export declare function nativeDelete(target: Native, key: string | symbol): boolean;
-export declare function nativeGet(target: Native, key: string | symbol): any;
-export declare function jsonToNative(data: any): any;
+export declare function nativeGet(target: Native, key: string | symbol): any | undefined;
+export declare function jsonToNative(data: any): Native | any;
 //# sourceMappingURL=NativeUtils.d.ts.map

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":"AAAA,OAAO,EAAC,GAAG,IAAI,IAAI,EAAE,KAAK,IAAI,MAAM,EAAC,MAAM,KAAK,CAAA;AAChD,OAAO,EAAC,MAAM,EAAC,iBAA6B;AAI5C,wBAAgB,cAAc,CAAC,KAAK,EAAE,GAAG,oCAExC;AAED,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,EAAE,GAAG,WAuBzE;AAED,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,WAwBhE;AAED,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,OAgB7D;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,GAAG,OAgBrC"}
+{"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"}

package/dist/core/native/NativeUtils.js

@@ -1,13 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isYMapOrYArray = isYMapOrYArray;
+exports.isNative = isNative;
 exports.nativeSet = nativeSet;
+exports.nativeHas = nativeHas;
+exports.nativeOwnKeys = nativeOwnKeys;
 exports.nativeDelete = nativeDelete;
 exports.nativeGet = nativeGet;
 exports.jsonToNative = jsonToNative;
 const yjs_1 = require("yjs");
 const DataUtils_1 = require("../utils/DataUtils");
-function isYMapOrYArray(value) {
+function isNative(value) {
     return (value instanceof yjs_1.Map) || (value instanceof yjs_1.Array);
 }
 function nativeSet(target, key, value) {
@@ -35,6 +37,40 @@ function nativeSet(target, key, value) {
     }
     return false;
 }
+function nativeHas(target, key) {
+    if (typeof key !== 'string') {
+        return false;
+    }
+    try {
+        if (target instanceof yjs_1.Map) {
+            return target.has(key);
+        }
+        else if (target instanceof yjs_1.Array) {
+            const index = parseInt(key);
+            if (!isNaN(index)) {
+                return index < target.length && index >= 0;
+            }
+        }
+    }
+    catch (e) {
+        console.error('RhineVar nativeHas.error:', e);
+    }
+    return false;
+}
+function nativeOwnKeys(target) {
+    let keys = [];
+    if (target instanceof yjs_1.Map) {
+        target.forEach((value, key) => {
+            keys.push(key);
+        });
+    }
+    else if (target instanceof yjs_1.Array) {
+        for (let i = 0; i < target.length; i++) {
+            keys.push(String(i));
+        }
+    }
+    return keys;
+}
 function nativeDelete(target, key) {
     if (typeof key !== 'string') {
         return false;

package/dist/core/proxy/DirectKey.d.ts

@@ -0,0 +1,5 @@
+export declare const DIRECT_KEY_PREVIOUS = "RHINE_VAR_DIRECT_PACKAGE_PREFIX_";
+export declare function directKey(key: string | number): string;
+export declare function isDirectKey(key: string | any): boolean;
+export declare function originKey(key: string | symbol | number): string | symbol | number;
+//# sourceMappingURL=DirectKey.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DirectKey.d.ts","sourceRoot":"","sources":["../../../src/core/proxy/DirectKey.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,mBAAmB,qCAAqC,CAAA;AAErE,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,UAE7C;AAED,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,WAE5C;AAED,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAajF"}

package/dist/core/proxy/DirectKey.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DIRECT_KEY_PREVIOUS = void 0;
+exports.directKey = directKey;
+exports.isDirectKey = isDirectKey;
+exports.originKey = originKey;
+exports.DIRECT_KEY_PREVIOUS = 'RHINE_VAR_DIRECT_PACKAGE_PREFIX_';
+function directKey(key) {
+    return exports.DIRECT_KEY_PREVIOUS + key;
+}
+function isDirectKey(key) {
+    return typeof key === 'string' && key.startsWith(exports.DIRECT_KEY_PREVIOUS);
+}
+function originKey(key) {
+    if (typeof key === 'number')
+        key = String(key);
+    if (typeof key !== 'string')
+        return key;
+    if (key.startsWith(exports.DIRECT_KEY_PREVIOUS)) {
+        key = key.split(exports.DIRECT_KEY_PREVIOUS)[1];
+        let kn = parseInt(key);
+        if (isNaN(kn)) {
+            return key;
+        }
+        else {
+            return kn;
+        }
+    }
+    return key;
+}

package/dist/core/proxy/DirectPackage.d.ts

@@ -1,6 +1,4 @@
-export default class DirectPackage {
-    data: any;
-    constructor(data: any);
-}
-export declare function directPackage(data: any): DirectPackage;
+export declare const DIRECT_KEY_PREVIOUS = "RHINE_VAR_DIRECT_PACKAGE_PREFIX - ";
+export declare function directKey(key: string): string;
+export declare function isDirectKey(key: string): boolean;
 //# sourceMappingURL=DirectPackage.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"DirectPackage.d.ts","sourceRoot":"","sources":["../../../src/core/proxy/DirectPackage.ts"],"names":[],"mappings":"AACA,MAAM,CAAC,OAAO,OAAO,aAAa;IAEvB,IAAI,EAAE,GAAG;gBAAT,IAAI,EAAE,GAAG;CAEnB;AAED,wBAAgB,aAAa,CAAC,IAAI,EAAE,GAAG,iBAEtC"}
+{"version":3,"file":"DirectPackage.d.ts","sourceRoot":"","sources":["../../../src/core/proxy/DirectPackage.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,mBAAmB,uCAAuC,CAAA;AAEvE,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,UAEpC;AAED,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,WAEtC"}

package/dist/core/proxy/DirectPackage.js

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.directPackage = directPackage;
-class DirectPackage {
-    constructor(data) {
-        this.data = data;
-    }
+exports.DIRECT_KEY_PREVIOUS = void 0;
+exports.directKey = directKey;
+exports.isDirectKey = isDirectKey;
+exports.DIRECT_KEY_PREVIOUS = 'RHINE_VAR_DIRECT_PACKAGE_PREFIX - ';
+function directKey(key) {
+    return exports.DIRECT_KEY_PREVIOUS + key;
 }
-exports.default = DirectPackage;
-function directPackage(data) {
-    return new DirectPackage(data);
+function isDirectKey(key) {
+    return key.startsWith(exports.DIRECT_KEY_PREVIOUS);
 }

package/dist/core/proxy/KeyWithDirectFlag.d.ts

@@ -0,0 +1,8 @@
+type keyType = string | symbol | number;
+export default class KeyWithDirectFlag {
+    value: keyType;
+    constructor(value: keyType);
+}
+export declare function directKey(value: keyType): KeyWithDirectFlag;
+export {};
+//# sourceMappingURL=KeyWithDirectFlag.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"KeyWithDirectFlag.d.ts","sourceRoot":"","sources":["../../../src/core/proxy/KeyWithDirectFlag.ts"],"names":[],"mappings":"AACA,KAAK,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;AAEvC,MAAM,CAAC,OAAO,OAAO,iBAAiB;IAE3B,KAAK,EAAE,OAAO;gBAAd,KAAK,EAAE,OAAO;CAExB;AAED,wBAAgB,SAAS,CAAC,KAAK,EAAE,OAAO,qBAEvC"}

package/dist/core/proxy/KeyWithDirectFlag.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.directKey = directKey;
+class KeyWithDirectFlag {
+    constructor(value) {
+        this.value = value;
+    }
+}
+exports.default = KeyWithDirectFlag;
+function directKey(value) {
+    return new KeyWithDirectFlag(value);
+}

package/dist/core/proxy/ProxiedRhineVar.d.ts

@@ -1,6 +1,7 @@
 import RhineVar from "./RhineVar";
 export type RecursiveCrossRhineVar<T> = {
-    [K in keyof T]: T[K] extends object ? RecursiveCrossRhineVar<T[K]> & RhineVar : T[K];
+    [K in keyof T]: T[K] extends object ? RecursiveCrossRhineVar<T[K]> & RhineVar<T[K]> : T[K];
 };
-export type ProxiedRhineVar<T> = T & RecursiveCrossRhineVar<T> & RhineVar;
+export type StoredRhineVar<T> = T & RecursiveCrossRhineVar<T> & RhineVar<T>;
+export type ProxiedRhineVar<T> = StoredRhineVar<T>;
 //# sourceMappingURL=ProxiedRhineVar.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"ProxiedRhineVar.d.ts","sourceRoot":"","sources":["../../../src/core/proxy/ProxiedRhineVar.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,mBAA8B;AAE7C,MAAM,MAAM,sBAAsB,CAAC,CAAC,IAAI;KACrC,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC;CACrF,CAAA;AAED,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,CAAC,GAAG,sBAAsB,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAA"}
+{"version":3,"file":"ProxiedRhineVar.d.ts","sourceRoot":"","sources":["../../../src/core/proxy/ProxiedRhineVar.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,mBAA8B;AAE7C,MAAM,MAAM,sBAAsB,CAAC,CAAC,IAAI;KACrC,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAC3F,CAAA;AAED,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,CAAC,GAAG,sBAAsB,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAA;AAE3E,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,cAAc,CAAC,CAAC,CAAC,CAAA"}

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

@@ -1,6 +1,8 @@
 import WebsocketRhineConnector from "../connector/WebsocketRhineConnector";
 import { ProxiedRhineVar } from "./ProxiedRhineVar";
 import { Native } from "../native/Native";
-export declare function rhineProxy<T extends object>(data: T, connector?: WebsocketRhineConnector | string | null, overwrite?: boolean): ProxiedRhineVar<T>;
+export declare const PROTOCOL_LIST: string[];
+export declare const DEFAULT_PROTOCOL_LIST: string;
+export declare function rhineProxy<T extends object>(data: T, connector?: WebsocketRhineConnector | string | null, overwrite?: boolean | number): ProxiedRhineVar<T>;
 export declare function rhineProxyNative<T extends object>(target: Native): ProxiedRhineVar<T>;
 //# sourceMappingURL=Proxy.d.ts.map

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;AAKxG,OAAO,EAAC,eAAe,EAAC,0BAAqC;AAC7D,OAAO,EAAC,MAAM,EAAC,yBAA6B;AAK5C,wBAAgB,UAAU,CAAC,CAAC,SAAS,MAAM,EACzC,IAAI,EAAE,CAAC,EACP,SAAS,GAAE,uBAAuB,GAAG,MAAM,GAAG,IAAW,EACzD,SAAS,GAAE,OAAe,GACzB,eAAe,CAAC,CAAC,CAAC,CA2CpB;AAGD,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,eAAe,CAAC,CAAC,CAAC,CA4DrF"}
+{"version":3,"file":"Proxy.d.ts","sourceRoot":"","sources":["../../../src/core/proxy/Proxy.ts"],"names":[],"mappings":"AACA,OAAO,uBAAgD,6CAAiD;AAKxG,OAAO,EAAC,eAAe,EAAC,0BAAqC;AAC7D,OAAO,EAAC,MAAM,EAAC,yBAA6B;AAY5C,eAAO,MAAM,aAAa,UAAsB,CAAA;AAChD,eAAO,MAAM,qBAAqB,QAAmB,CAAA;AAGrD,wBAAgB,UAAU,CAAC,CAAC,SAAS,MAAM,EACzC,IAAI,EAAE,CAAC,EACP,SAAS,GAAE,uBAAuB,GAAG,MAAM,GAAG,IAAW,EACzD,SAAS,GAAE,OAAO,GAAG,MAAc,GAClC,eAAe,CAAC,CAAC,CAAC,CA6CpB;AAGD,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,eAAe,CAAC,CAAC,CAAC,CAoErF"}