@homeostate/crdt-loro 0.1.1 → 0.1.3

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # @homeostate/crdt-loro
 
+## 0.1.3
+
+### Patch Changes
+
+- 33c7b14: Mark the package side-effect free, so bundlers can drop modules that are not imported.
+- fb76f77: Preserve complete Unicode code points when diffing and applying string edits. Deleting or
+  replacing supplementary characters such as emoji no longer corrupts text, deletes adjacent
+  characters, or throws in the supplied CRDT backends.
+
+  String `Change` offsets remain UTF-16 code units. A string deletion can now carry a numeric
+  UTF-16 deletion length in its third tuple entry; `undefined` still means one unit. Custom
+  backends consuming `getChanges` must honor this length in one operation rather than delete
+  one code unit per step. Array and object deletion semantics are unchanged.
+
+- Updated dependencies [a643bbe]
+- Updated dependencies [0bbf653]
+- Updated dependencies [fb76f77]
+  - @homeostate/core@0.2.0
+
+## 0.1.2
+
+### Patch Changes
+
+- 30abf27: Remove draft release warnings, update docs links
+- Updated dependencies [30abf27]
+  - @homeostate/core@0.1.2
+
 ## 0.1.1
 
 ### Patch Changes

package/README.md

@@ -1,8 +1,5 @@
 # @homeostate/crdt-loro
 
-> **Draft / placeholder release.** `0.0.0` reserves the name while the API is still
-> being designed. Nothing here is stable — do not depend on it yet.
-
 [Loro](https://github.com/loro-dev/loro) backend for
 [`@homeostate/core`](https://github.com/mixedrays/homeostate/tree/main/packages/core).
 It maps the synced state onto a `LoroMap` (nested objects become `LoroMap`, arrays

package/dist/patching.js

@@ -49,6 +49,6 @@ const applyToText = (text, type, index, value) => {
     if (type === ChangeType.INSERT)
         text.insert(index, value);
     else if (type === ChangeType.DELETE)
-        text.delete(index, 1);
+        text.delete(index, typeof value === "number" ? value : 1);
 };
 //# sourceMappingURL=patching.js.map

package/dist/patching.js.map

@@ -1 +1 @@
-{"version":3,"file":"patching.js","sourceRoot":"","sources":["../src/patching.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAY,MAAM,WAAW,CAAC;AACxD,OAAO,EACL,UAAU,EACV,UAAU,GAGX,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACL,cAAc,EACd,WAAW,GAEZ,MAAM,cAAc,CAAC;AAEtB,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,SAA0B,EAC1B,QAAiB,EACX,EAAE;IACR,YAAY,CACV,SAAS,EACT,UAAU,CAAC,SAAS,CAAC,MAAM,EAAc,EAAE,QAAoB,CAAC,CACjE,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,SAA0B,EAAE,OAAiB,EAAQ,EAAE;IAC3E,KAAK,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,IAAI,OAAO,EAAE,CAAC;QACzC,IAAI,SAAS,YAAY,OAAO;YAC9B,UAAU,CAAC,SAAS,EAAE,IAAI,EAAE,GAAa,EAAE,KAAK,CAAC,CAAC;aAC/C,IAAI,SAAS,YAAY,QAAQ;YACpC,WAAW,CAAC,SAAS,EAAE,IAAI,EAAE,GAAa,EAAE,KAAK,CAAC,CAAC;;YAChD,WAAW,CAAC,SAAS,EAAE,IAAI,EAAE,GAAa,EAAE,KAAK,CAAC,CAAC;IAC1D,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CACjB,GAAY,EACZ,IAAgB,EAChB,GAAW,EACX,KAAc,EACR,EAAE;IACR,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,UAAU,CAAC,MAAM,CAAC;QACvB,KAAK,UAAU,CAAC,MAAM;YACpB,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;YAC7B,MAAM;QAER,KAAK,UAAU,CAAC,MAAM;YACpB,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAChB,MAAM;QAER,KAAK,UAAU,CAAC,OAAO;YACrB,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAoB,EAAE,KAAiB,CAAC,CAAC;YACjE,MAAM;IACV,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAClB,IAAc,EACd,IAAgB,EAChB,KAAa,EACb,KAAc,EACR,EAAE;IACR,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,UAAU,CAAC,MAAM;YACpB,cAAc,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;YACnC,MAAM;QAER,KAAK,UAAU,CAAC,MAAM;YACpB,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YACtB,cAAc,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;YACnC,MAAM;QAER,KAAK,UAAU,CAAC,MAAM;YACpB,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YACtB,MAAM;QAER,KAAK,UAAU,CAAC,OAAO;YACrB,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAoB,EAAE,KAAiB,CAAC,CAAC;YACpE,MAAM;IACV,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAClB,IAAc,EACd,IAAgB,EAChB,KAAa,EACb,KAAc,EACR,EAAE;IACR,IAAI,IAAI,KAAK,UAAU,CAAC,MAAM;QAAE,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,KAAe,CAAC,CAAC;SAC/D,IAAI,IAAI,KAAK,UAAU,CAAC,MAAM;QAAE,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;AAC7D,CAAC,CAAC"}
+{"version":3,"file":"patching.js","sourceRoot":"","sources":["../src/patching.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAY,MAAM,WAAW,CAAC;AACxD,OAAO,EACL,UAAU,EACV,UAAU,GAGX,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACL,cAAc,EACd,WAAW,GAEZ,MAAM,cAAc,CAAC;AAEtB,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,SAA0B,EAC1B,QAAiB,EACX,EAAE;IACR,YAAY,CACV,SAAS,EACT,UAAU,CAAC,SAAS,CAAC,MAAM,EAAc,EAAE,QAAoB,CAAC,CACjE,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,SAA0B,EAAE,OAAiB,EAAQ,EAAE;IAC3E,KAAK,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,IAAI,OAAO,EAAE,CAAC;QACzC,IAAI,SAAS,YAAY,OAAO;YAC9B,UAAU,CAAC,SAAS,EAAE,IAAI,EAAE,GAAa,EAAE,KAAK,CAAC,CAAC;aAC/C,IAAI,SAAS,YAAY,QAAQ;YACpC,WAAW,CAAC,SAAS,EAAE,IAAI,EAAE,GAAa,EAAE,KAAK,CAAC,CAAC;;YAChD,WAAW,CAAC,SAAS,EAAE,IAAI,EAAE,GAAa,EAAE,KAAK,CAAC,CAAC;IAC1D,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CACjB,GAAY,EACZ,IAAgB,EAChB,GAAW,EACX,KAAc,EACR,EAAE;IACR,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,UAAU,CAAC,MAAM,CAAC;QACvB,KAAK,UAAU,CAAC,MAAM;YACpB,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;YAC7B,MAAM;QAER,KAAK,UAAU,CAAC,MAAM;YACpB,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAChB,MAAM;QAER,KAAK,UAAU,CAAC,OAAO;YACrB,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAoB,EAAE,KAAiB,CAAC,CAAC;YACjE,MAAM;IACV,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAClB,IAAc,EACd,IAAgB,EAChB,KAAa,EACb,KAAc,EACR,EAAE;IACR,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,UAAU,CAAC,MAAM;YACpB,cAAc,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;YACnC,MAAM;QAER,KAAK,UAAU,CAAC,MAAM;YACpB,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YACtB,cAAc,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;YACnC,MAAM;QAER,KAAK,UAAU,CAAC,MAAM;YACpB,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YACtB,MAAM;QAER,KAAK,UAAU,CAAC,OAAO;YACrB,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAoB,EAAE,KAAiB,CAAC,CAAC;YACpE,MAAM;IACV,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAClB,IAAc,EACd,IAAgB,EAChB,KAAa,EACb,KAAc,EACR,EAAE;IACR,IAAI,IAAI,KAAK,UAAU,CAAC,MAAM;QAAE,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,KAAe,CAAC,CAAC;SAC/D,IAAI,IAAI,KAAK,UAAU,CAAC,MAAM;QACjC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC9D,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@homeostate/crdt-loro",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Loro CRDT backend for @homeostate/core",
   "license": "MIT",
   "type": "module",
@@ -9,7 +9,7 @@
     "url": "git+https://github.com/mixedrays/homeostate.git",
     "directory": "packages/crdt-loro"
   },
-  "homepage": "https://github.com/mixedrays/homeostate#readme",
+  "homepage": "https://homeostate.pages.dev",
   "bugs": {
     "url": "https://github.com/mixedrays/homeostate/issues"
   },
@@ -28,8 +28,11 @@
       "default": "./dist/index.js"
     }
   },
+  "sideEffects": false,
   "files": [
     "dist",
+    "src",
+    "!src/**/__tests__",
     "README.md",
     "LICENSE",
     "THIRD_PARTY_NOTICES.md",
@@ -39,7 +42,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@homeostate/core": "^0.1.1"
+    "@homeostate/core": "^0.2.0"
   },
   "peerDependencies": {
     "loro-crdt": "^1.0.0"

package/src/index.ts

@@ -0,0 +1 @@
+export { createLoroBackend } from "./loro-backend.js";

package/src/loro-backend.ts

@@ -0,0 +1,24 @@
+import type { LoroDoc } from "loro-crdt";
+import type { CrdtBackend, Unsubscribe } from "@homeostate/core";
+import { patchContainer } from "./patching.js";
+
+let instances = 0;
+
+export const createLoroBackend = (doc: LoroDoc, name: string): CrdtBackend => {
+  const map = doc.getMap(name);
+  const origin = `homeostate:${name}#${instances++}`;
+
+  return {
+    read: () => map.toJSON(),
+
+    write: (next) => {
+      patchContainer(map, next);
+      doc.commit({ origin });
+    },
+
+    subscribe: (onRemoteChange): Unsubscribe =>
+      map.subscribe((event) => {
+        if (event.origin !== origin) onRemoteChange();
+      }),
+  };
+};

package/src/mapping.ts

@@ -0,0 +1,46 @@
+import { LoroList, LoroMap, LoroText } from "loro-crdt";
+
+export type SharedContainer = LoroMap | LoroList | LoroText;
+
+const isRecord = (value: unknown): value is Record<string, unknown> =>
+  value !== null && typeof value === "object" && !Array.isArray(value);
+
+export const setMapEntry = (
+  map: LoroMap,
+  key: string,
+  value: unknown,
+): void => {
+  if (Array.isArray(value))
+    fillList(map.setContainer(key, new LoroList()), value);
+  else if (typeof value === "string")
+    map.setContainer(key, new LoroText()).insert(0, value);
+  else if (isRecord(value))
+    fillMap(map.setContainer(key, new LoroMap()), value);
+  else map.set(key, value);
+};
+
+export const insertListItem = (
+  list: LoroList,
+  index: number,
+  value: unknown,
+): void => {
+  if (Array.isArray(value))
+    fillList(list.insertContainer(index, new LoroList()), value);
+  else if (typeof value === "string")
+    list.insertContainer(index, new LoroText()).insert(0, value);
+  else if (isRecord(value))
+    fillMap(list.insertContainer(index, new LoroMap()), value);
+  else list.insert(index, value);
+};
+
+export const fillMap = (
+  map: LoroMap,
+  object: Record<string, unknown>,
+): void => {
+  for (const [key, value] of Object.entries(object))
+    setMapEntry(map, key, value);
+};
+
+export const fillList = (list: LoroList, array: unknown[]): void => {
+  array.forEach((value, index) => insertListItem(list, index, value));
+};

package/src/patching.ts

@@ -0,0 +1,91 @@
+import { LoroList, LoroMap, LoroText } from "loro-crdt";
+import {
+  ChangeType,
+  getChanges,
+  type Change,
+  type Diffable,
+} from "@homeostate/core";
+import {
+  insertListItem,
+  setMapEntry,
+  type SharedContainer,
+} from "./mapping.js";
+
+export const patchContainer = (
+  container: SharedContainer,
+  newState: unknown,
+): void => {
+  applyChanges(
+    container,
+    getChanges(container.toJSON() as Diffable, newState as Diffable),
+  );
+};
+
+const applyChanges = (container: SharedContainer, changes: Change[]): void => {
+  for (const [type, key, value] of changes) {
+    if (container instanceof LoroMap)
+      applyToMap(container, type, key as string, value);
+    else if (container instanceof LoroList)
+      applyToList(container, type, key as number, value);
+    else applyToText(container, type, key as number, value);
+  }
+};
+
+const applyToMap = (
+  map: LoroMap,
+  type: ChangeType,
+  key: string,
+  value: unknown,
+): void => {
+  switch (type) {
+    case ChangeType.INSERT:
+    case ChangeType.UPDATE:
+      setMapEntry(map, key, value);
+      break;
+
+    case ChangeType.DELETE:
+      map.delete(key);
+      break;
+
+    case ChangeType.PENDING:
+      applyChanges(map.get(key) as SharedContainer, value as Change[]);
+      break;
+  }
+};
+
+const applyToList = (
+  list: LoroList,
+  type: ChangeType,
+  index: number,
+  value: unknown,
+): void => {
+  switch (type) {
+    case ChangeType.INSERT:
+      insertListItem(list, index, value);
+      break;
+
+    case ChangeType.UPDATE:
+      list.delete(index, 1);
+      insertListItem(list, index, value);
+      break;
+
+    case ChangeType.DELETE:
+      list.delete(index, 1);
+      break;
+
+    case ChangeType.PENDING:
+      applyChanges(list.get(index) as SharedContainer, value as Change[]);
+      break;
+  }
+};
+
+const applyToText = (
+  text: LoroText,
+  type: ChangeType,
+  index: number,
+  value: unknown,
+): void => {
+  if (type === ChangeType.INSERT) text.insert(index, value as string);
+  else if (type === ChangeType.DELETE)
+    text.delete(index, typeof value === "number" ? value : 1);
+};