mobx-keystone-yjs 1.4.0 → 1.5.0

package/src/binding/convertJsonToYjsData.ts

@@ -1,72 +1,78 @@
-import * as Y from "yjs"
-import { JsonValue, JsonArray, JsonObject, JsonPrimitive } from "../jsonTypes"
-import { YjsTextModel, yjsTextModelId } from "./YjsTextModel"
-import { SnapshotOutOf } from "mobx-keystone"
-
-function isJsonPrimitive(v: JsonValue): v is JsonPrimitive {
-  const t = typeof v
-  return t === "string" || t === "number" || t === "boolean" || v === null
-}
-
-function isJsonArray(v: JsonValue): v is JsonArray {
-  return Array.isArray(v)
-}
-
-function isJsonObject(v: JsonValue): v is JsonObject {
-  return !isJsonArray(v) && typeof v === "object"
-}
-
-/**
- * Converts a JSON value to a Y.js data structure.
- * Objects are converted to Y.Maps, arrays to Y.Arrays, primitives are untouched.
- * Frozen values are a special case and they are kept as immutable plain values.
- */
-export function convertJsonToYjsData(v: JsonValue) {
-  if (v === undefined || isJsonPrimitive(v)) {
-    return v
-  }
-
-  if (isJsonArray(v)) {
-    const arr = new Y.Array()
-    applyJsonArrayToYArray(arr, v)
-    return arr
-  }
-
-  if (isJsonObject(v)) {
-    if (v.$frozen === true) {
-      // frozen value, save as immutable object
-      return v
-    }
-
-    if (v.$modelType === yjsTextModelId) {
-      const text = new Y.Text()
-      const yjsTextModel = v as SnapshotOutOf<YjsTextModel>
-      yjsTextModel.deltaList.forEach((frozenDeltas) => {
-        text.applyDelta(frozenDeltas.data)
-      })
-      return text
-    }
-
-    const map = new Y.Map()
-    applyJsonObjectToYMap(map, v)
-    return map
-  }
-
-  throw new Error(`unsupported value type: ${v}`)
-}
-
-/**
- * Applies a JSON array to a Y.Array, using the convertJsonToYjsData to convert the values.
- */
-export function applyJsonArrayToYArray(dest: Y.Array<unknown>, source: JsonArray) {
-  dest.push(source.map(convertJsonToYjsData))
-}
-
-/**
- * Applies a JSON object to a Y.Map, using the convertJsonToYjsData to convert the values.
- */
-export function applyJsonObjectToYMap(dest: Y.Map<unknown>, source: JsonObject) {
-  Object.entries(source).forEach(([k, v]) => {
-    dest.set(k, convertJsonToYjsData(v))
-  })
-}
+import * as Y from "yjs"
+import { YjsTextModel, yjsTextModelId } from "./YjsTextModel"
+import { SnapshotOutOf } from "mobx-keystone"
+import { YjsData } from "./convertYjsDataToJson"
+import {
+  JsonArrayWithUndefined,
+  JsonObjectWithUndefined,
+  JsonPrimitiveWithUndefined,
+  JsonValueWithUndefined,
+} from "jsonTypes"
+
+function isJsonPrimitiveWithUndefined(v: JsonValueWithUndefined): v is JsonPrimitiveWithUndefined {
+  const t = typeof v
+  return t === "string" || t === "number" || t === "boolean" || v === null || v === undefined
+}
+
+function isJsonArrayWithUndefined(v: JsonValueWithUndefined): v is JsonArrayWithUndefined {
+  return Array.isArray(v)
+}
+
+function isJsonObjectWithUndefined(v: JsonValueWithUndefined): v is JsonObjectWithUndefined {
+  return !isJsonArrayWithUndefined(v) && typeof v === "object"
+}
+
+/**
+ * Converts a JSON value to a Y.js data structure.
+ * Objects are converted to Y.Maps, arrays to Y.Arrays, primitives are untouched.
+ * Frozen values are a special case and they are kept as immutable plain values.
+ */
+export function convertJsonToYjsData(v: JsonValueWithUndefined | undefined): YjsData {
+  if (v === undefined || isJsonPrimitiveWithUndefined(v)) {
+    return v
+  }
+
+  if (isJsonArrayWithUndefined(v)) {
+    const arr = new Y.Array()
+    applyJsonArrayToYArray(arr, v)
+    return arr as YjsData
+  }
+
+  if (isJsonObjectWithUndefined(v)) {
+    if (v.$frozen === true) {
+      // frozen value, save as immutable object
+      return v
+    }
+
+    if (v.$modelType === yjsTextModelId) {
+      const text = new Y.Text()
+      const yjsTextModel = v as unknown as SnapshotOutOf<YjsTextModel>
+      yjsTextModel.deltaList.forEach((frozenDeltas) => {
+        text.applyDelta(frozenDeltas.data)
+      })
+      return text
+    }
+
+    const map = new Y.Map()
+    applyJsonObjectToYMap(map, v)
+    return map as YjsData
+  }
+
+  throw new Error(`unsupported value type: ${v}`)
+}
+
+/**
+ * Applies a JSON array to a Y.Array, using the convertJsonToYjsData to convert the values.
+ */
+export function applyJsonArrayToYArray(dest: Y.Array<unknown>, source: JsonArrayWithUndefined) {
+  dest.push(source.map(convertJsonToYjsData))
+}
+
+/**
+ * Applies a JSON object to a Y.Map, using the convertJsonToYjsData to convert the values.
+ */
+export function applyJsonObjectToYMap(dest: Y.Map<unknown>, source: JsonObjectWithUndefined) {
+  Object.entries(source).forEach(([k, v]) => {
+    dest.set(k, convertJsonToYjsData(v))
+  })
+}

package/src/binding/convertYjsDataToJson.ts

@@ -1,31 +1,31 @@
-import { modelSnapshotOutWithMetadata } from "mobx-keystone"
-import * as Y from "yjs"
-import { JsonValue } from "../jsonTypes"
-import { YjsTextModel } from "./YjsTextModel"
-
-export function convertYjsDataToJson(
-  yjsData: Y.Array<unknown> | Y.Map<unknown> | Y.Text | unknown
-): JsonValue {
-  if (yjsData instanceof Y.Array) {
-    return yjsData.map((v) => convertYjsDataToJson(v))
-  }
-
-  if (yjsData instanceof Y.Map) {
-    const obj: Record<string, JsonValue> = {}
-    yjsData.forEach((v, k) => {
-      obj[k] = convertYjsDataToJson(v)
-    })
-    return obj
-  }
-
-  if (yjsData instanceof Y.Text) {
-    const deltas = yjsData.toDelta()
-
-    return modelSnapshotOutWithMetadata(YjsTextModel, {
-      deltaList: deltas.length > 0 ? [{ $frozen: true, data: deltas }] : [],
-    }) as JsonValue
-  }
-
-  // assume it's a primitive
-  return yjsData as JsonValue
-}
+import { modelSnapshotOutWithMetadata } from "mobx-keystone"
+import * as Y from "yjs"
+import { JsonObjectWithUndefined, JsonValueWithUndefined } from "../jsonTypes"
+import { YjsTextModel } from "./YjsTextModel"
+
+export type YjsData = Y.Array<YjsData> | Y.Map<YjsData> | Y.Text | JsonValueWithUndefined
+
+export function convertYjsDataToJson(yjsData: YjsData): JsonValueWithUndefined {
+  if (yjsData instanceof Y.Array) {
+    return yjsData.map((v) => convertYjsDataToJson(v))
+  }
+
+  if (yjsData instanceof Y.Map) {
+    const obj: JsonObjectWithUndefined = {}
+    yjsData.forEach((v, k) => {
+      obj[k] = convertYjsDataToJson(v)
+    })
+    return obj
+  }
+
+  if (yjsData instanceof Y.Text) {
+    const deltas = yjsData.toDelta() as unknown[]
+
+    return modelSnapshotOutWithMetadata(YjsTextModel, {
+      deltaList: deltas.length > 0 ? [{ $frozen: true, data: deltas }] : [],
+    }) as unknown as JsonValueWithUndefined
+  }
+
+  // assume it's a primitive
+  return yjsData
+}

package/src/binding/convertYjsEventToPatches.ts

@@ -1,92 +1,96 @@
-import { Patch } from "mobx-keystone"
-import * as Y from "yjs"
-import { JsonArray, JsonObject, JsonValue } from "../jsonTypes"
-import { failure } from "../utils/error"
-
-export function convertYjsEventToPatches(event: Y.YEvent<any>): Patch[] {
-  const patches: Patch[] = []
-
-  if (event instanceof Y.YMapEvent) {
-    const source = event.target as Y.Map<any>
-
-    event.changes.keys.forEach((change, key) => {
-      const path = [...event.path, key]
-
-      switch (change.action) {
-        case "add":
-          patches.push({
-            op: "add",
-            path,
-            value: toPlainValue(source.get(key)),
-          })
-          break
-
-        case "update":
-          patches.push({
-            op: "replace",
-            path,
-            value: toPlainValue(source.get(key)),
-          })
-          break
-
-        case "delete":
-          patches.push({
-            op: "remove",
-            path,
-          })
-          break
-
-        default:
-          throw failure(`unsupported Yjs map event action: ${change.action}`)
-      }
-    })
-  } else if (event instanceof Y.YArrayEvent) {
-    let retain = 0
-    event.changes.delta.forEach((change) => {
-      if (change.retain) {
-        retain += change.retain
-      }
-
-      if (change.delete) {
-        // remove X items at retain position
-        const path = [...event.path, retain]
-        for (let i = 0; i < change.delete; i++) {
-          patches.push({
-            op: "remove",
-            path,
-          })
-        }
-      }
-
-      if (change.insert) {
-        const newValues = Array.isArray(change.insert) ? change.insert : [change.insert]
-        newValues.forEach((v) => {
-          const path = [...event.path, retain]
-          patches.push({
-            op: "add",
-            path,
-            value: toPlainValue(v),
-          })
-          retain++
-        })
-      }
-    })
-  } else if (event instanceof Y.YTextEvent) {
-    const path = [...event.path, "deltaList", -1 /* last item */]
-    patches.push({
-      op: "add",
-      path,
-      value: { $frozen: true, data: event.delta },
-    })
-  }
-
-  return patches
-}
-
-function toPlainValue(v: Y.Map<any> | Y.Array<any> | JsonValue) {
-  if (v instanceof Y.Map || v instanceof Y.Array) {
-    return v.toJSON() as JsonObject | JsonArray
-  } else {
-    return v
-  }
-}
+import { Patch } from "mobx-keystone"
+import * as Y from "yjs"
+import {
+  JsonArrayWithUndefined,
+  JsonObjectWithUndefined,
+  JsonValueWithUndefined,
+} from "../jsonTypes"
+import { failure } from "../utils/error"
+
+export function convertYjsEventToPatches(event: Y.YEvent<any>): Patch[] {
+  const patches: Patch[] = []
+
+  if (event instanceof Y.YMapEvent) {
+    const source = event.target
+
+    event.changes.keys.forEach((change, key) => {
+      const path = [...event.path, key]
+
+      switch (change.action) {
+        case "add":
+          patches.push({
+            op: "add",
+            path,
+            value: toPlainValue(source.get(key)),
+          })
+          break
+
+        case "update":
+          patches.push({
+            op: "replace",
+            path,
+            value: toPlainValue(source.get(key)),
+          })
+          break
+
+        case "delete":
+          patches.push({
+            op: "remove",
+            path,
+          })
+          break
+
+        default:
+          throw failure(`unsupported Yjs map event action: ${change.action}`)
+      }
+    })
+  } else if (event instanceof Y.YArrayEvent) {
+    let retain = 0
+    event.changes.delta.forEach((change) => {
+      if (change.retain) {
+        retain += change.retain
+      }
+
+      if (change.delete) {
+        // remove X items at retain position
+        const path = [...event.path, retain]
+        for (let i = 0; i < change.delete; i++) {
+          patches.push({
+            op: "remove",
+            path,
+          })
+        }
+      }
+
+      if (change.insert) {
+        const newValues = Array.isArray(change.insert) ? change.insert : [change.insert]
+        newValues.forEach((v) => {
+          const path = [...event.path, retain]
+          patches.push({
+            op: "add",
+            path,
+            value: toPlainValue(v),
+          })
+          retain++
+        })
+      }
+    })
+  } else if (event instanceof Y.YTextEvent) {
+    const path = [...event.path, "deltaList", -1 /* last item */]
+    patches.push({
+      op: "add",
+      path,
+      value: { $frozen: true, data: event.delta },
+    })
+  }
+
+  return patches
+}
+
+function toPlainValue(v: Y.Map<any> | Y.Array<any> | JsonValueWithUndefined) {
+  if (v instanceof Y.Map || v instanceof Y.Array) {
+    return v.toJSON() as JsonObjectWithUndefined | JsonArrayWithUndefined
+  } else {
+    return v
+  }
+}

package/src/binding/resolveYjsPath.ts

@@ -1,27 +1,27 @@
-import * as Y from "yjs"
-import { failure } from "../utils/error"
-import { getOrCreateYjsCollectionAtom } from "../utils/getOrCreateYjsCollectionAtom"
-
-export function resolveYjsPath(yjsObject: unknown, path: readonly (string | number)[]): unknown {
-  let currentYjsObject: unknown = yjsObject
-
-  path.forEach((pathPart, i) => {
-    if (currentYjsObject instanceof Y.Map) {
-      getOrCreateYjsCollectionAtom(currentYjsObject).reportObserved()
-      const key = String(pathPart)
-      currentYjsObject = currentYjsObject.get(key)
-    } else if (currentYjsObject instanceof Y.Array) {
-      getOrCreateYjsCollectionAtom(currentYjsObject).reportObserved()
-      const key = Number(pathPart)
-      currentYjsObject = currentYjsObject.get(key)
-    } else {
-      throw failure(
-        `Y.Map or Y.Array was expected at path ${JSON.stringify(
-          path.slice(0, i)
-        )} in order to resolve path ${JSON.stringify(path)}, but got ${currentYjsObject} instead`
-      )
-    }
-  })
-
-  return currentYjsObject
-}
+import * as Y from "yjs"
+import { failure } from "../utils/error"
+import { getOrCreateYjsCollectionAtom } from "../utils/getOrCreateYjsCollectionAtom"
+
+export function resolveYjsPath(yjsObject: unknown, path: readonly (string | number)[]): unknown {
+  let currentYjsObject: unknown = yjsObject
+
+  path.forEach((pathPart, i) => {
+    if (currentYjsObject instanceof Y.Map) {
+      getOrCreateYjsCollectionAtom(currentYjsObject).reportObserved()
+      const key = String(pathPart)
+      currentYjsObject = currentYjsObject.get(key)
+    } else if (currentYjsObject instanceof Y.Array) {
+      getOrCreateYjsCollectionAtom(currentYjsObject).reportObserved()
+      const key = Number(pathPart)
+      currentYjsObject = currentYjsObject.get(key)
+    } else {
+      throw failure(
+        `Y.Map or Y.Array was expected at path ${JSON.stringify(
+          path.slice(0, i)
+        )} in order to resolve path ${JSON.stringify(path)}, but got ${currentYjsObject} instead`
+      )
+    }
+  })
+
+  return currentYjsObject
+}

package/src/binding/yjsBindingContext.ts

@@ -1,42 +1,42 @@
-import { AnyType, createContext } from "mobx-keystone"
-import * as Y from "yjs"
-
-/**
- * Context with info on how a mobx-keystone model is bound to a Y.js data structure.
- */
-export interface YjsBindingContext {
-  /**
-   * The Y.js document.
-   */
-  yjsDoc: Y.Doc
-
-  /**
-   * The bound Y.js data structure.
-   */
-  yjsObject: Y.Map<unknown> | Y.Array<unknown> | Y.Text
-
-  /**
-   * The mobx-keystone model type.
-   */
-  mobxKeystoneType: AnyType
-
-  /**
-   * The origin symbol used for transactions.
-   */
-  yjsOrigin: symbol
-
-  /**
-   * The bound mobx-keystone instance.
-   */
-  boundObject: unknown | undefined
-
-  /**
-   * Whether we are currently applying Y.js changes to the mobx-keystone model.
-   */
-  isApplyingYjsChangesToMobxKeystone: boolean
-}
-
-/**
- * Context with info on how a mobx-keystone model is bound to a Y.js data structure.
- */
-export const yjsBindingContext = createContext<YjsBindingContext | undefined>(undefined)
+import { AnyType, createContext } from "mobx-keystone"
+import * as Y from "yjs"
+
+/**
+ * Context with info on how a mobx-keystone model is bound to a Y.js data structure.
+ */
+export interface YjsBindingContext {
+  /**
+   * The Y.js document.
+   */
+  yjsDoc: Y.Doc
+
+  /**
+   * The bound Y.js data structure.
+   */
+  yjsObject: Y.Map<unknown> | Y.Array<unknown> | Y.Text
+
+  /**
+   * The mobx-keystone model type.
+   */
+  mobxKeystoneType: AnyType
+
+  /**
+   * The origin symbol used for transactions.
+   */
+  yjsOrigin: symbol
+
+  /**
+   * The bound mobx-keystone instance.
+   */
+  boundObject: unknown
+
+  /**
+   * Whether we are currently applying Y.js changes to the mobx-keystone model.
+   */
+  isApplyingYjsChangesToMobxKeystone: boolean
+}
+
+/**
+ * Context with info on how a mobx-keystone model is bound to a Y.js data structure.
+ */
+export const yjsBindingContext = createContext<YjsBindingContext | undefined>(undefined)

package/src/jsonTypes.ts

@@ -1,4 +1,9 @@
-export type JsonPrimitive = string | number | boolean | null
-export type JsonValue = JsonPrimitive | JsonObject | JsonArray
-export type JsonObject = { [key: string]: JsonValue }
-export interface JsonArray extends Array<JsonValue> {}
+export type JsonPrimitiveWithUndefined = string | number | boolean | null | undefined
+export type JsonValueWithUndefined =
+  | JsonPrimitiveWithUndefined
+  | JsonObjectWithUndefined
+  | JsonArrayWithUndefined
+// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
+export type JsonObjectWithUndefined = { [key: string]: JsonValueWithUndefined }
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface JsonArrayWithUndefined extends Array<JsonValueWithUndefined> {}

package/src/utils/getOrCreateYjsCollectionAtom.ts

@@ -1,18 +1,27 @@
-import { IAtom, createAtom } from "mobx"
-import * as Y from "yjs"
-
-const yjsCollectionAtoms = new WeakMap<Y.Map<unknown> | Y.Array<unknown>, IAtom>()
-
-/**
- * @internal
- */
-export const getOrCreateYjsCollectionAtom = (
-  yjsCollection: Y.Map<unknown> | Y.Array<unknown>
-): IAtom => {
-  let atom = yjsCollectionAtoms.get(yjsCollection)
-  if (!atom) {
-    atom = createAtom(`yjsCollectionAtom`)
-    yjsCollectionAtoms.set(yjsCollection, atom)
-  }
-  return atom
-}
+import { IAtom, createAtom } from "mobx"
+import * as Y from "yjs"
+
+const yjsCollectionAtoms = new WeakMap<Y.Map<unknown> | Y.Array<unknown>, IAtom>()
+
+/**
+ * @internal
+ */
+export const getYjsCollectionAtom = (
+  yjsCollection: Y.Map<unknown> | Y.Array<unknown>
+): IAtom | undefined => {
+  return yjsCollectionAtoms.get(yjsCollection)
+}
+
+/**
+ * @internal
+ */
+export const getOrCreateYjsCollectionAtom = (
+  yjsCollection: Y.Map<unknown> | Y.Array<unknown>
+): IAtom => {
+  let atom = yjsCollectionAtoms.get(yjsCollection)
+  if (!atom) {
+    atom = createAtom(`yjsCollectionAtom`)
+    yjsCollectionAtoms.set(yjsCollection, atom)
+  }
+  return atom
+}