@cocreate/crdt 1.23.2 → 1.24.0

package/CHANGELOG.md

@@ -1,3 +1,23 @@
+# [1.24.0](https://github.com/CoCreate-app/CoCreate-crdt/compare/v1.23.3...v1.24.0) (2023-10-24)
+
+
+### Bug Fixes
+
+* update to dotnotation ([64da6bf](https://github.com/CoCreate-app/CoCreate-crdt/commit/64da6bfd05ee3ebea1de623add45d7c4fd111aab))
+
+
+### Features
+
+* persistChange() uses crud $push operator ([7e032a7](https://github.com/CoCreate-app/CoCreate-crdt/commit/7e032a7d9c9e7d04a65a74184f04f04668cd682e))
+* replace maps() with object to make crdt objects portable ([fac31c5](https://github.com/CoCreate-app/CoCreate-crdt/commit/fac31c580a3b4ed420dc2eb2223f9198487a2b8e))
+
+## [1.23.3](https://github.com/CoCreate-app/CoCreate-crdt/compare/v1.23.2...v1.23.3) (2023-10-19)
+
+
+### Bug Fixes
+
+* removed @cocreate/message-client ([8cd41ca](https://github.com/CoCreate-app/CoCreate-crdt/commit/8cd41ca5059e0b2852aa9d0cf7038eb087eab996))
+
 ## [1.23.2](https://github.com/CoCreate-app/CoCreate-crdt/compare/v1.23.1...v1.23.2) (2023-10-17)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cocreate/crdt",
-  "version": "1.23.2",
+  "version": "1.24.0",
   "description": "CoCreate crdt",
   "author": "CoCreate LLC",
   "license": "AGPL-3.0",
@@ -42,7 +42,6 @@
   "dependencies": {
     "@cocreate/crud-client": "^1.28.4",
     "@cocreate/local-storage": "^1.10.5",
-    "@cocreate/message-client": "^1.8.3",
     "@cocreate/utils": "^1.25.3"
   }
 }

package/src/index.js

@@ -22,14 +22,13 @@
 
 /*globals config, atob, btoa, localStorage, CustomEvent*/
 import crud from '@cocreate/crud-client';
-import message from '@cocreate/message-client';
 import uuid from '@cocreate/uuid';
 import localStorage from '@cocreate/local-storage';
 
-const docs = new Map();
+const objects = {}
+const clientId = crud.socket.clientId || uuid.generate(12);
 const frameId = crud.socket.frameId || uuid.generate(12);
 const checkedDb = new Map();
-const isInit = new Map();
 
 function init(data) {
     getText(data).then(value => {
@@ -40,35 +39,34 @@ function init(data) {
     });
 }
 
-async function getDoc(data) {
+async function getObject(data) {
     try {
         if (['_id', 'organization_id'].includes(data.key))
             return
-        let docName = getDocName(data);
-        let doc = docs.get(docName);
+        let name = getName(data);
+        let object = objects[name];
 
-        if (!doc) {
-            docs.set(docName, new Map());
-            doc = docs.get(docName);
+        if (!object) {
+            objects[name] = object = {}
         }
 
-        if (!doc.has('changeLog')) {
+        if (!object.changeLog) {
             let changeLog = [];
-            doc.set('undoLog', new Map())
-            doc.set('redoLog', new Map())
+            object.undoLog = new Map()
+            object.redoLog = new Map()
+
 
             if (data.read != 'false') {
                 if (!data.newObject) {
                     let response = await crud.send({
                         method: "read.object",
-                        status: "resolve",
-                        array: "crdt-transactions",
+                        array: "crdt",
                         object: {
                             $filter: {
                                 query: [{
-                                    key: 'docName',
+                                    key: 'name',
                                     operator: "$eq",
-                                    value: docName
+                                    value: name
                                 }],
                                 limit: 1
                             }
@@ -78,13 +76,16 @@ async function getDoc(data) {
                         changeLog = response.object[0].changeLog;
                     }
                 }
-                doc.set('changeLog', changeLog);
-                await generateText(data, true);
+                object.changeLog = changeLog
+                // await generateText(data, true);
+                if (!object.text) {
+                    await generateText(data, true);
+                }
             }
-        } else if (!doc.has('text')) {
+        } else if (!object.text) {
             await generateText(data, false);
         }
-        return doc;
+        return object;
     } catch (e) {
         console.log('Invalid param', e);
     }
@@ -96,22 +97,20 @@ String.prototype.customSplice = function (index, absIndex, string) {
 
 async function generateText(data, flag) {
     try {
-        let doc = docs.get(getDocName(data))
-
-        let string = '';
-        let changeLog = doc.get('changeLog');
-        for (let change of changeLog) {
+        let name = getName(data)
+        let object = objects[name]
+        object['text'] = ''
+        for (let change of object['changeLog']) {
             if (change) {
-                string = string.customSplice(change.start, change.length, change.value);
+                object['text'] = object['text'].customSplice(change.start, change.length, change.value);
             }
         }
 
-        if (string === '' && data.read !== 'false') {
-            string = await checkDb(data, flag) || ''
+        if (object['text'] === '' && data.read !== 'false') {
+            object['text'] = await checkDb(data, flag) || ''
         }
 
-        doc.set('text', string);
-        return string;
+        return object['text'];
     } catch (e) {
         console.error(e);
     }
@@ -119,14 +118,15 @@ async function generateText(data, flag) {
 
 async function checkDb(data, flag) {
     let { array, object, key } = data;
-    if (checkedDb.get(`${array}${object}${key}`)) return;
+    if (checkedDb.get(`${array}${object}${key}`))
+        return;
     checkedDb.set(`${array}${object}${key}`, true);
 
     let string = ''
     if (data.newObject)
         string = data.newObject
     else {
-        let response = await crud.send({ method: 'read.object', status: "resolve", array, object: { _id: object, key } });
+        let response = await crud.send({ method: 'read.object', array, object: { _id: object, key } });
         string = crud.getValueFromObject(response.object[0], key);
     }
 
@@ -139,16 +139,18 @@ async function checkDb(data, flag) {
         insertChange(data);
     }
 
-    return string;
+    return string || '';
 }
 
 function insertChange(data, flag) {
-    let docName = getDocName(data);
-    let doc = docs.get(docName);
-    let changeLog = doc.get('changeLog');
+    let name = getName(data);
+    let object = objects[name];
+    let changeLog = object.changeLog;
     if (!changeLog)
         return
 
+    object.text = object.text || ''
+
     let type = 'insert';
     if (data.start == undefined) return;
     if (!data.value)
@@ -160,6 +162,7 @@ function insertChange(data, flag) {
         start: data.start,
         end: data.end,
         length: data.length || 0,
+        clientId: data.clientId || clientId,
         frameId: data.frameId || frameId,
         user_id: data.user_id || localStorage.getItem("user_id"),
         type
@@ -193,43 +196,41 @@ function insertChange(data, flag) {
         console.log('null change')
         return
     }
-    let string = doc.get('text') || '';
     if (change.length > 0)
-        change.removedValue = string.substring(change.start, change.length);
+        change.removedValue = object.text.substring(change.start, change.length);
 
     if (flag == 'replace') {
         // TODO get current string and create new changeLog array then push new change
         changeLog = [change];
-        doc.set('changeLog', changeLog)
     } else {
         changeLog.push(change);
     }
 
-    doc.set('text', string.customSplice(change.start, change.length, change.value));
-    string = doc.get('text');
+    object.text = object.text.customSplice(change.start, change.length, change.value);
 
     if (!data.frameId) {
-        data['datetime'] = change.datetime;
-        data['frameId'] = change.frameId;
+        data.datetime = change.datetime;
+        data.frameId = change.frameId;
 
         broadcastChange(data);
-        localChange(data, string);
+        localChange(data, object.text);
     } else
-        localChange(data, string);
+        localChange(data, object.text);
 
     if (data.frameId == frameId && data.save != "false")
-        persistChange(data);
+        persistChange(data, change);
 }
 
 function broadcastChange(data) {
-    message.send({
+    crud.socket.send({
+        method: "crdt",
         broadcastSender: false,
         broadcastBrowser: true,
-        message: "crdt",
         data
     });
 }
 
+
 function localChange(data, string) {
     const localChange = new CustomEvent('cocreate-crdt-update', {
         detail: { ...data, string },
@@ -237,25 +238,27 @@ function localChange(data, string) {
     window.dispatchEvent(localChange);
 }
 
-function persistChange(data) {
-    let docName = getDocName(data);
-    let doc = docs.get(docName);
-    let changeLog = doc.get('changeLog');
-    let text = doc.get('text');
+
+function persistChange(data, change) {
+    let name = getName(data);
     let Data = {
         method: 'update.object',
-        array: 'crdt-transactions',
+        array: 'crdt',
         object: {
-            _id: data.object,
-            docName,
-            changeLog,
-            text,
+            name,
+            '$push.changeLog': change,
             crud: {
                 array: data.array,
                 object: data.object,
                 key: data.key
             }
         },
+        $filter: {
+            query: [
+                { key: 'name', value: name, operator: '$eq', index: true }
+            ],
+            limit: 1
+        },
         upsert: true,
         namespace: data.namespace,
         room: data.room,
@@ -268,12 +271,13 @@ function persistChange(data) {
     crud.send(Data);
 }
 
-message.listen('crdt', function (response) {
+
+crud.socket.listen('crdt', function (response) {
     let data = response.data
-    let docName = getDocName(data);
-    let doc = docs.get(docName);
+    let name = getName(data);
+    let object = objects[name]
 
-    if (doc) {
+    if (object) {
         if (data.frameId !== frameId) {
             insertChange(data);
         }
@@ -284,15 +288,15 @@ crud.listen('update.object', (data) => sync(data))
 crud.listen('delete.object', (data) => sync(data))
 
 function sync(data) {
-    if (data.frameId === frameId)
+    if (data.clientId === clientId)
         return
-    if (data.array.includes('crdt-transactions')) {
+    if (data.array.includes('crdt')) {
         if (data.object && data.object[0]) {
             let Data = data.object[0];
-            let docName = Data.docName;
-            let doc = docs.get(docName);
-            if (doc && Data.crud) {
-                // let text = doc.get('text')
+            let name = Data.name;
+            let object = objects[name];
+            if (object && Data.crud) {
+                // let text = object['text']
                 // if (!text && text !== '') {
                 //     setTimeout(function () {
                 //         console.log("text empty timout set");
@@ -301,11 +305,11 @@ function sync(data) {
                 // } else {
                 Data.crud.value = Data.text
                 Data.crud.start = 0
-                Data.crud.length = doc.get('text').length
+                Data.crud.length = object['text'].length
 
-                doc.set('changeLog', Data.changeLog)
-                doc.set('text', Data.text)
-                // TODO: compare modified dates to check if arrays need to merged and orderd by date or if we just use server
+
+                object['changeLog'] = Data.changeLog
+                object['text'] = Data.text                // TODO: compare modified dates to check if arrays need to merged and orderd by date or if we just use server
                 localChange(Data.crud, Data.text)
                 console.log('crdtSync')
                 // }
@@ -324,9 +328,9 @@ crdt.getText({
 */
 async function getText(data) {
     try {
-        let doc = await getDoc(data);
-        if (doc) {
-            let value = doc.get('text')
+        let object = await getObject(data);
+        if (object) {
+            let value = object.text
             return value;
         } else {
             console.log('undefined')
@@ -351,8 +355,8 @@ crdt.replaceText({
 */
 async function replaceText(data) {
     try {
-        let doc = await getDoc(data);
-        if (doc) {
+        let object = await getObject(data);
+        if (object) {
             let oldValue = await getText(data);
             if (oldValue)
                 data.length = oldValue.length;
@@ -379,8 +383,8 @@ crdt.updateText({
 })
 */
 async function updateText(data, flag) {
-    let doc = await getDoc(data);
-    if (doc) {
+    let object = await getObject(data);
+    if (object) {
 
         insertChange(data, flag);
 
@@ -425,10 +429,10 @@ function createChange(data, change) {
 }
 
 function undoText(data) {
-    let docName = getDocName(data);
-    let doc = docs.get(docName);
-    let changeLog = doc.get('changeLog');
-    let undoLog = doc.get('undoLog')
+    let name = getName(data);
+    let object = objects[name];
+    let changeLog = object.changeLog;
+    let undoLog = object.undoLog;
 
     for (let index = changeLog.length - 1; index >= 0; index--) {
         let change = Object.assign({}, changeLog[index]);
@@ -449,10 +453,10 @@ function undoText(data) {
 }
 
 function redoText(data) {
-    let docName = getDocName(data);
-    let doc = docs.get(docName);
-    let redoLog = doc.get('redoLog')
-    let undoLog = Array.from(doc.get('undoLog').values());
+    let name = getName(data);
+    let object = objects[name];
+    let redoLog = object.redoLog
+    let undoLog = Array.from(object.undoLog.values());
 
     for (let index = undoLog.length - 1; index >= 0; index--) {
         let change = Object.assign({}, undoLog[index]);
@@ -473,9 +477,9 @@ function redoText(data) {
 
 async function viewVersion(data) {
     try {
-        let docName = getDocName(data);
-        let doc = docs.get(docName);
-        let changeLog = doc.get('changeLog');
+        let name = getName(data);
+        let object = objects[name];
+        let changeLog = object.changeLog;
         let string = '';
 
         let log = changeLog.slice(0, data.version)
@@ -490,21 +494,14 @@ async function viewVersion(data) {
     }
 }
 
-
-
-// function deleteDoc(docName) {
-// 	if (this.docs[docName]) {
-// 		delete this.docs[docName];
+// function deleteObject(name) {
+// 	if (objects[name]) {
+// 		delete objects[name];
 // 	}
 // }
 
-// function destroyObserver(docName, typeName) {
-// 	this.docs[docName].doc.getText(typeName).unobserve((event) => {});
-// 	this.docs[docName].socket.awareness.off('change', this._awarenessListener);
-// }
-
-function getDocName(data) {
+function getName(data) {
     return `${data.array}${data.object}${data.key}`;
 }
 
-export default { init, getText, updateText, replaceText, undoText, redoText, viewVersion };
+export default { init, objects, getName, getText, updateText, replaceText, undoText, redoText, viewVersion };