lib0 0.2.112 → 0.2.115-0

package/delta/binding.d.ts

@@ -0,0 +1,105 @@
+/**
+ * @template T
+ * @typedef {import('../schema.js').Schema<T>} Schema
+ */
+/**
+ * @template {delta.AbstractDelta} DeltaA
+ * @template {delta.AbstractDelta} DeltaB
+ */
+export class Binding<DeltaA extends delta.AbstractDelta, DeltaB extends delta.AbstractDelta> {
+    /**
+     * @param {RDT<DeltaA>} a
+     * @param {RDT<DeltaB>} b
+     * @param {dt.Template<any,DeltaA,DeltaB>} template
+     */
+    constructor(a: RDT<DeltaA>, b: RDT<DeltaB>, template: dt.Template<any, DeltaA, DeltaB>);
+    /**
+     * @type {dt.Transformer<any,DeltaA,DeltaB>}
+     */
+    t: dt.Transformer<any, DeltaA, DeltaB>;
+    a: RDT<DeltaA>;
+    b: RDT<DeltaB>;
+    _mux: mux.mutex;
+    _achanged: (delta: DeltaA) => void;
+    _bchanged: (delta: DeltaB) => void;
+    destroy: () => void;
+}
+export function bind<DeltaA extends delta.AbstractDelta, Transformer extends dt.Template<any, DeltaA, any>>(a: RDT<DeltaA>, b: RDT<Transformer extends dt.Template<any, DeltaA, infer DeltaB> ? DeltaB : never>, template: dt.Template<any, DeltaA, any>): Binding<DeltaA, Transformer extends dt.Template<any, DeltaA, infer DeltaB extends delta.AbstractDelta> ? DeltaB : never>;
+export function deltaRDT<Delta extends delta.AbstractDelta>($delta: Schema<Delta>): DeltaRDT<Delta>;
+export const $domDelta: s.Schema<import("./node.js").RecursiveDeltaNode<string, Partial<{
+    [x: string]: string;
+}>, never, true>>;
+export function domRDT(dom: Element): DomRDT<DomDelta>;
+export type Schema<T> = import("../schema.js").Schema<T>;
+/**
+ * Abstract Interface for a delta-based Replicated Data Type.
+ */
+export type RDT<Delta extends delta.AbstractDelta> = ObservableV2<{
+    "change": (delta: Delta) => void;
+    "destroy": (rdt: RDT<Delta>) => void;
+}> & {
+    update: (delta: Delta) => any;
+    destroy: () => void;
+};
+export type DomDelta = delta.RecursiveNode<string, {
+    [key: string]: string;
+}, never, true>;
+import * as delta from './index.js';
+import * as dt from './transformer.js';
+import * as mux from '../mutex.js';
+/**
+ * @template {delta.AbstractDelta} Delta
+ * @implements RDT<Delta>
+ * @extends {ObservableV2<{ change: (delta: Delta) => void, 'destroy': (rdt:DeltaRDT<Delta>)=>void }>}
+ */
+declare class DeltaRDT<Delta extends delta.AbstractDelta> extends ObservableV2<{
+    change: (delta: Delta) => void;
+    destroy: (rdt: DeltaRDT<Delta>) => void;
+}> implements RDT<Delta> {
+    /**
+     * @param {Schema<Delta>} $delta
+     */
+    constructor($delta: Schema<Delta>);
+    $delta: s.Schema<Delta>;
+    /**
+     * @type {Delta?}
+     */
+    state: Delta | null;
+    _mux: mux.mutex;
+    /**
+     * @param {Delta} delta
+     */
+    update: (delta: Delta) => any;
+}
+import * as s from '../schema.js';
+/**
+ * @typedef {delta.RecursiveNode<string, { [key:string]: string }, never, true>} DomDelta
+ */
+/**
+ * @template {DomDelta} [D=DomDelta]
+ * @implements RDT<D>
+ * @extends {ObservableV2<{ change: (delta: D)=>void, destroy: (rdt:DomRDT<D>)=>void }>}>}
+ */
+declare class DomRDT<D extends DomDelta = DomDelta> extends ObservableV2<{
+    change: (delta: D) => void;
+    destroy: (rdt: DomRDT<D>) => void;
+}> implements RDT<D> {
+    /**
+     * @param {Element} observedNode
+     */
+    constructor(observedNode: Element);
+    observedNode: Element;
+    _mux: mux.mutex;
+    observer: MutationObserver;
+    /**
+     * @param {MutationRecord[]} mutations
+     */
+    _mutationHandler: (mutations: MutationRecord[]) => any;
+    /**
+     * @param {D} delta
+     */
+    update: (delta: D) => void;
+}
+import { ObservableV2 } from '../observable.js';
+export {};
+//# sourceMappingURL=binding.d.ts.map

package/delta/binding.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"binding.d.ts","sourceRoot":"","sources":["binding.js"],"names":[],"mappings":"AAYA;;;GAGG;AAEH;;;GAGG;AACH,qBAHmC,MAAM,SAA3B,KAAK,CAAC,aAAc,EACC,MAAM,SAA3B,KAAK,CAAC,aAAc;IAGhC;;;;OAIG;IACH,eAJW,GAAG,CAAC,MAAM,CAAC,KACX,GAAG,CAAC,MAAM,CAAC,YACX,EAAE,CAAC,QAAQ,CAAC,GAAG,EAAC,MAAM,EAAC,MAAM,CAAC,EA4BxC;IAzBC;;OAEG;IACH,GAFU,EAAE,CAAC,WAAW,CAAC,GAAG,EAAC,MAAM,EAAC,MAAM,CAAC,CAEnB;IACxB,eAAU;IACV,eAAU;IACV,gBAA6B;IAC7B,8BAgCoD,IAAI,CAxBrD;IACH,8BAuBoD,IAAI,CAfrD;IAGL,oBAKC;CACF;AAgBM,qBAN4B,MAAM,SAA3B,KAAK,CAAC,aAAc,EACS,WAAW,SAAxC,EAAE,CAAC,QAAQ,CAAC,GAAG,EAAC,MAAM,EAAC,GAAG,CAAE,KAC/B,GAAG,CAAC,MAAM,CAAC,KACX,GAAG,CAAC,WAAW,SAAS,EAAE,CAAC,QAAQ,CAAC,GAAG,EAAC,MAAM,EAAC,MAAM,MAAM,CAAC,GAAG,MAAM,GAAG,KAAK,CAAC,YAC9E,EAAE,CAAC,QAAQ,CAAC,GAAG,EAAC,MAAM,EAAC,GAAG,CAAC,sEAD0B,MAAM,gDAGH;AA2C5D,yBAH4B,KAAK,SAA1B,KAAK,CAAC,aAAc,UACvB,MAAM,CAAC,KAAK,CAAC,mBAE8B;AAkGtD;;kBAA+H;AAsJxH,4BAFI,OAAO,oBAE0B;mBAnW/B,CAAC,IACD,OAAO,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC;;;;gBAoDV,KAAK,SAA1B,KAAK,CAAC,aAAc,IACrB,YAAY,CAAC;IAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IAAC,SAAS,EAAE,CAAC,GAAG,EAAC,GAAG,CAAC,KAAK,CAAC,KAAG,IAAI,CAAA;CAAE,CAAC,GAAG;IAAE,MAAM,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,GAAG,CAAC;IAAC,OAAO,EAAE,MAAM,IAAI,CAAA;CAAE;uBAkP9I,KAAK,CAAC,aAAa,CAAC,MAAM,EAAE;IAAE,CAAC,GAAG,EAAC,MAAM,GAAG,MAAM,CAAA;CAAE,EAAE,KAAK,EAAE,IAAI,CAAC;uBAnTxD,YAAY;oBACf,kBAAkB;qBAMjB,aAAa;AAsElC;;;;GAIG;AACH,uBAJmC,KAAK,SAA1B,KAAK,CAAC,aAAc;YAEE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI;aAAa,CAAC,GAAG,EAAC,QAAQ,CAAC,KAAK,CAAC,KAAG,IAAI;cADnF,GAAG,CAAC,KAAK;IAItB;;OAEG;IACH,oBAFW,MAAM,CAAC,KAAK,CAAC,EAUvB;IANC,wBAAoB;IACpB;;OAEG;IACH,OAFU,KAAK,OAAC,CAEC;IACjB,gBAA6B;IAG/B;;OAEG;IACH,SAAS,OAFE,KAEG,SAOZ;CAMH;mBAxGkB,cAAc;AA0SjC;;GAEG;AAEH;;;;GAIG;AACH,qBAJyB,CAAC,SAAZ,QAAS;YAEa,CAAC,KAAK,EAAE,CAAC,KAAG,IAAI;aAAW,CAAC,GAAG,EAAC,MAAM,CAAC,CAAC,CAAC,KAAG,IAAI;cADrE,GAAG,CAAC,CAAC;IAIlB;;OAEG;IACH,0BAFW,OAAO,EAajB;IATC,sBAAgC;IAChC,gBAA6B;IAC7B,2BAA2D;IAS7D;;OAEG;IACH,mBAAmB,WAFR,cAAc,EAEG,SAGxB;IAEJ;;OAEG;IACH,SAAS,OAFE,CAEG,UAWb;CAOF;6BA1W4B,kBAAkB"}

package/delta/binding.js

@@ -0,0 +1,369 @@
+/* global MutationObserver */
+import { ObservableV2 } from '../observable.js'
+import * as delta from './index.js'
+import * as dt from './transformer.js' // eslint-disable-line
+import * as dom from '../dom.js'
+import * as set from '../set.js'
+import * as map from '../map.js'
+import * as error from '../error.js'
+import * as math from '../math.js'
+import * as mux from '../mutex.js'
+import * as s from '../schema.js'
+
+/**
+ * @template T
+ * @typedef {import('../schema.js').Schema<T>} Schema
+ */
+
+/**
+ * @template {delta.AbstractDelta} DeltaA
+ * @template {delta.AbstractDelta} DeltaB
+ */
+export class Binding {
+  /**
+   * @param {RDT<DeltaA>} a
+   * @param {RDT<DeltaB>} b
+   * @param {dt.Template<any,DeltaA,DeltaB>} template
+   */
+  constructor (a, b, template) {
+    /**
+     * @type {dt.Transformer<any,DeltaA,DeltaB>}
+     */
+    this.t = template.init()
+    this.a = a
+    this.b = b
+    this._mux = mux.createMutex()
+    this._achanged = this.a.on('change', d => this._mux(() => {
+      const tres = this.t.applyA(d)
+      if (tres.a) {
+        a.update(tres.a)
+      }
+      if (tres.b) {
+        b.update(tres.b)
+      }
+    }))
+    this._bchanged = this.b.on('change', d => this._mux(() => {
+      const tres = this.t.applyB(d)
+      if (tres.b) {
+        this.b.update(tres.b)
+      }
+      if (tres.a) {
+        a.update(tres.a)
+      }
+    }))
+  }
+
+  destroy = () => {
+    this.a.off('destroy', this.destroy)
+    this.b.off('destroy', this.destroy)
+    this.a.off('change', this._achanged)
+    this.b.off('change', this._bchanged)
+  }
+}
+
+/**
+ * Abstract Interface for a delta-based Replicated Data Type.
+ *
+ * @template {delta.AbstractDelta} Delta
+ * @typedef {ObservableV2<{ 'change': (delta: Delta) => void, 'destroy': (rdt:RDT<Delta>)=>void }> & { update: (delta: Delta) => any, destroy: () => void }} RDT
+ */
+
+/**
+ * @template {delta.AbstractDelta} DeltaA
+ * @template {dt.Template<any,DeltaA,any>} Transformer
+ * @param {RDT<DeltaA>} a
+ * @param {RDT<Transformer extends dt.Template<any,DeltaA,infer DeltaB> ? DeltaB : never>} b
+ * @param {dt.Template<any,DeltaA,any>} template
+ */
+export const bind = (a, b, template) => new Binding(a, b, template)
+
+/**
+ * @template {delta.AbstractDelta} Delta
+ * @implements RDT<Delta>
+ * @extends {ObservableV2<{ change: (delta: Delta) => void, 'destroy': (rdt:DeltaRDT<Delta>)=>void }>}
+ */
+class DeltaRDT extends ObservableV2 {
+  /**
+   * @param {Schema<Delta>} $delta
+   */
+  constructor ($delta) {
+    super()
+    this.$delta = $delta
+    /**
+     * @type {Delta?}
+     */
+    this.state = null
+    this._mux = mux.createMutex()
+  }
+
+  /**
+   * @param {Delta} delta
+   */
+  update = delta => delta.isEmpty() || this._mux(() => {
+    if (this.state != null) {
+      this.state.apply(delta)
+    } else {
+      this.state = delta
+    }
+    this.emit('change', [delta])
+  })
+
+  destroy () {
+    this.emit('destroy', [this])
+    super.destroy()
+  }
+}
+
+/**
+ * @template {delta.AbstractDelta} Delta
+ * @param {Schema<Delta>} $delta
+ */
+export const deltaRDT = $delta => new DeltaRDT($delta)
+
+/**
+ * @param {Node} domNode
+ */
+const domToDelta = domNode => {
+  if (dom.$element.check(domNode)) {
+    const d = delta.node(domNode.nodeName.toLowerCase())
+    for (let i = 0; i < domNode.attributes.length; i++) {
+      const attr = /** @type {Attr} */ (domNode.attributes.item(i))
+      d.attributes.set(attr.nodeName, attr.value)
+    }
+    domNode.childNodes.forEach(child => {
+      d.children.insert(dom.$text.check(child) ? child.textContent : [domToDelta(child)])
+    })
+    return d
+  }
+  error.unexpectedCase()
+}
+
+/**
+ * @param {DomDelta} d
+ */
+const deltaToDom = d => {
+  if (delta.$nodeAny.check(d)) {
+    const n = dom.element(d.name)
+    d.attributes.forEach(change => {
+      if (delta.$insertOp.check(change)) {
+        n.setAttribute(change.key, change.value)
+      }
+    })
+    d.children.forEach(child => {
+      if (delta.$insertOp.check(child)) {
+        n.append(...child.insert.map(deltaToDom))
+      } else if (delta.$textOp.check(child)) {
+        n.append(dom.text(child.insert))
+      }
+    })
+    return n
+  }
+  error.unexpectedCase()
+}
+
+/**
+ * @param {Element} el
+ * @param {delta.Node<string,any,any,any>} d
+ */
+const applyDeltaToDom = (el, d) => {
+  d.attributes.forEach(change => {
+    if (delta.$deleteOp.check(change)) {
+      el.removeAttribute(change.key)
+    } else {
+      el.setAttribute(change.key, change.value)
+    }
+  })
+  let childIndex = 0
+  let childOffset = 0
+  d.children.forEach(change => {
+    let child = el.childNodes[childIndex] || null
+    if (delta.$deleteOp.check(change)) {
+      let len = change.length
+      while (len > 0) {
+        if (dom.$element.check(child)) {
+          child.remove()
+          len--
+        } else if (dom.$text.check(child)) {
+          const childLen = child.length
+          if (childOffset === 0 && childLen <= len) {
+            child.remove()
+            len -= childLen
+          } else {
+            const spliceLen = math.min(len, childLen - childOffset)
+            child.deleteData(childOffset, spliceLen)
+            if (child.length <= childOffset) {
+              childOffset = 0
+              childIndex++
+            }
+          }
+        }
+      }
+    } else if (delta.$insertOp.check(change)) {
+      if (childOffset > 0) {
+        const tchild = dom.$text.cast(child)
+        child = tchild.splitText(childOffset)
+        childIndex++
+        childOffset = 0
+      }
+      el.insertBefore(dom.fragment(change.insert.map(deltaToDom)), child)
+    } else if (delta.$modifyOp.check(change)) {
+      applyDeltaToDom(dom.$element.cast(child), change.modify)
+    } else if (delta.$textOp.check(change)) {
+      el.insertBefore(dom.text(change.insert), child)
+    } else {
+      error.unexpectedCase()
+    }
+  })
+}
+
+export const $domDelta = delta.$node(s.$string, s.$record(s.$string, s.$string), s.$never, { recursive: true, withText: true })
+
+/**
+ * @param {Element} observedNode
+ * @param {MutationRecord[]} mutations
+ * @param {any} origin assign this origin to the generated delta
+ */
+const _mutationsToDelta = (observedNode, mutations, origin) => {
+  /**
+   * @typedef {{ removedBefore: Map<Node?,number>, added: Set<Node>, modified: number, d: delta.Node }} ChangedNodeInfo
+   */
+  /**
+   * Compute all deltas without recursion.
+   *
+   * 1. mark all changed parents in parentsChanged
+   * 2. fill out necessary information for each changed parent ()
+   */
+  //
+  /**
+   * @type {Map<Node,ChangedNodeInfo>}
+   */
+  const changedNodes = map.create()
+  /**
+   * @param {Node} node
+   * @return {ChangedNodeInfo}
+   */
+  const getChangedNodeInfo = node => map.setIfUndefined(changedNodes, node, () => ({ removedBefore: map.create(), added: set.create(), modified: 0, d: delta.node(node.nodeName.toLowerCase()) }))
+  const observedNodeInfo = getChangedNodeInfo(observedNode)
+  mutations.forEach(mutation => {
+    const target = /** @type {HTMLElement} */ (mutation.target)
+    const parent = target.parentNode
+    const attrName = /** @type {string} */ (mutation.attributeName)
+    const newVal = target.getAttribute(attrName)
+    const info = getChangedNodeInfo(target)
+    const d = info.d
+    // go up the tree and mark that a child has been modified
+    for (let changedParent = parent; changedParent != null && getChangedNodeInfo(changedParent).modified++ > 1 && changedParent !== observedNode; changedParent = changedParent.parentNode) {
+      // nop
+    }
+    switch (mutation.type) {
+      case 'attributes': {
+        const attrs = /** @type {delta.Node<any,any,any>} */ (d).attributes
+        if (newVal == null) {
+          attrs.delete(attrName)
+        } else {
+          attrs.set(/** @type {string} */ (attrName), newVal)
+        }
+        break
+      }
+      case 'characterData': {
+        error.methodUnimplemented()
+        break
+      }
+      case 'childList': {
+        const targetInfo = getChangedNodeInfo(target)
+        mutation.addedNodes.forEach(node => {
+          targetInfo.added.add(node)
+        })
+        const removed = mutation.removedNodes.length
+        if (removed > 0) {
+          // @todo this can't work because next can be null
+          targetInfo.removedBefore.set(mutation.nextSibling, removed)
+        }
+        break
+      }
+    }
+  })
+  changedNodes.forEach((info, node) => {
+    const numOfChildChanges = info.modified + info.removedBefore.size + info.added.size
+    const d = /** @type {delta.Node<any,any,any>} */ (info.d)
+    if (numOfChildChanges > 0) {
+      node.childNodes.forEach(nchild => {
+        if (info.removedBefore.has(nchild)) { // can happen separately
+          d.children.delete(/** @type {number} */ (info.removedBefore.get(nchild)))
+        }
+        if (info.added.has(nchild)) {
+          d.children.insert(dom.$text.check(nchild) ? nchild.textContent : [domToDelta(nchild)])
+        } else if (changedNodes.has(nchild)) {
+          d.children.modify(getChangedNodeInfo(nchild).d)
+        }
+      })
+      // remove items to the end, if necessary
+      d.children.delete(info.removedBefore.get(null) ?? 0)
+    }
+    d.done()
+  })
+  observedNodeInfo.d.origin = origin
+  return observedNodeInfo.d
+}
+
+/**
+ * @typedef {delta.RecursiveNode<string, { [key:string]: string }, never, true>} DomDelta
+ */
+
+/**
+ * @template {DomDelta} [D=DomDelta]
+ * @implements RDT<D>
+ * @extends {ObservableV2<{ change: (delta: D)=>void, destroy: (rdt:DomRDT<D>)=>void }>}>}
+ */
+class DomRDT extends ObservableV2 {
+  /**
+   * @param {Element} observedNode
+   */
+  constructor (observedNode) {
+    super()
+    this.observedNode = observedNode
+    this._mux = mux.createMutex()
+    this.observer = new MutationObserver(this._mutationHandler)
+    this.observer.observe(observedNode, {
+      subtree: true,
+      childList: true,
+      attributes: true,
+      characterDataOldValue: true
+    })
+  }
+
+  /**
+   * @param {MutationRecord[]} mutations
+   */
+  _mutationHandler = mutations =>
+    mutations.length > 0 && this._mux(() => {
+      this.emit('change', [/** @type {D} */(_mutationsToDelta(this.observedNode, mutations, this))])
+    })
+
+  /**
+   * @param {D} delta
+   */
+  update = delta => {
+    if (delta.origin !== this) {
+      // @todo the retrieved changes must be transformed agains the updated changes. need a proper
+      // transaction system
+      this._mutationHandler(this.observer.takeRecords())
+      this._mux(() => {
+        applyDeltaToDom(this.observedNode, delta)
+        const mutations = this.observer.takeRecords()
+        this.emit('change', [/** @type {D} */(_mutationsToDelta(this.observedNode, mutations, delta.origin))])
+      })
+    }
+  }
+
+  destroy () {
+    this.emit('destroy', [this])
+    super.destroy()
+    this.observer.disconnect()
+  }
+}
+
+/**
+ * @param {Element} dom
+ */
+export const domRDT = dom => new DomRDT(dom)

package/delta/binding.test.d.ts

@@ -0,0 +1,5 @@
+export function testBinding(): void;
+export function testDomBindingBasics(): void;
+export function testDomBindingBackAndForth(): void;
+export function testDataToDom(): void;
+//# sourceMappingURL=binding.test.d.ts.map

package/delta/binding.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"binding.test.d.ts","sourceRoot":"","sources":["binding.test.js"],"names":[],"mappings":"AAQO,oCAcN;AAEM,6CAcN;AAEM,mDAkCN;AAEM,sCAiBN"}