@ifc-lite/collab 0.2.3 → 0.2.5

package/README.md

@@ -2,11 +2,18 @@
 
 Real-time collaborative BIM via CRDT on IFCX. Built on [Yjs](https://github.com/yjs/yjs).
 
-> **Status: v0.1 Foundation.** Single- and multi-peer Y.Doc editing, IFCX
+> **Status: early (0.x).** Single- and multi-peer Y.Doc editing, IFCX
 > seed/snapshot round-trip, IndexedDB persistence, undo manager, websocket
-> provider, awareness/presence types, conflict detection. See
-> [`docs/architecture/collab-plan.md`](../../docs/architecture/collab-plan.md)
-> for the full v0.1 → v1.0 roadmap.
+> provider, awareness/presence, conflict detection, per-user layer
+> extraction, branching, federation, and end-to-end encryption helpers. See
+> [collab-plan.md](https://github.com/LTplus-AG/ifc-lite/blob/main/docs/architecture/collab-plan.md)
+> for the roadmap.
+
+## Installation
+
+```bash
+npm install @ifc-lite/collab
+```
 
 ## Why
 
@@ -26,7 +33,7 @@ const buffer = await fetch('/model.ifcx').then((r) => r.arrayBuffer());
 const session = await createCollabSession({
   roomId: 'project-abc/model.ifcx',
   user: { id: 'louis', name: 'Louis Trümpler', color: '#5b8def' },
-  provider: 'indexeddb', // or 'websocket' for multi-peer
+  provider: 'indexeddb', // or 'websocket' for multi-peer (requires serverUrl)
 });
 seedFromIfcx(session.doc, buffer);
 
@@ -50,12 +57,16 @@ const ifcx = snapshotToIfcx(session.doc, { author: 'louis' });
 
 ```ts
 createCollabSession(opts) → CollabSession
-session.doc           // Y.Doc
-session.presence      // Presence (awareness wrapper)
-session.transact(fn)  // wrapper around ydoc.transact with our origin
-session.undo()        // local-origin undo via Y.UndoManager
+session.doc            // Y.Doc
+session.presence       // Presence (awareness wrapper)
+session.whenSynced     // resolves once persistence / websocket sync completes
+session.seed(input)    // seed the Y.Doc from an .ifcx buffer or object
+session.transact(fn)   // wrapper around ydoc.transact with our origin
+session.undo()         // local-origin undo via Y.UndoManager
 session.redo()
-session.snapshot()    // → IfcxFile
+session.snapshot()     // → IfcxFile
+session.extractUserLayer(baseline)  // per-peer IFCX overlay layer
+session.onConflict(listener)
 session.dispose()
 ```
 
@@ -87,6 +98,12 @@ See spec §9 for the full conflict policy. In short:
 The `createConflictDetector` helper observes Y.Doc updates and emits
 structured events that the viewer (or any UI) can render.
 
+## Docs
+
+See the [ifc-lite docs](https://ltplus-ag.github.io/ifc-lite/). Pair with
+[`@ifc-lite/collab-server`](https://www.npmjs.com/package/@ifc-lite/collab-server)
+for multi-peer websocket sync.
+
 ## License
 
 MPL-2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ifc-lite/collab",
-  "version": "0.2.3",
+  "version": "0.2.5",
   "description": "Real-time collaborative BIM via CRDT on IFCX",
   "type": "module",
   "main": "./dist/index.js",
@@ -39,15 +39,13 @@
     "y-protocols": "^1.0.6",
     "y-websocket": "^3.0.0",
     "yjs": "^13.6.31",
-    "@ifc-lite/data": "^2.0.2",
-    "@ifc-lite/ifcx": "^2.1.4",
-    "@ifc-lite/mutations": "^1.15.3"
+    "@ifc-lite/data": "^2.5.1",
+    "@ifc-lite/ifcx": "^2.2.1",
+    "@ifc-lite/mutations": "^1.18.0"
   },
   "devDependencies": {
-    "@types/ws": "^8.5.13",
     "typescript": "^6.0.3",
-    "vitest": "^4.1.0",
-    "ws": "^8.21.0"
+    "vitest": "^4.1.9"
   },
   "license": "MPL-2.0",
   "author": "Louis True",

package/dist/doc/index.d.ts

@@ -1,8 +0,0 @@
-export * from './schema.js';
-export * from './schema-version.js';
-export * from './migration-ifc4-to-ifc4x3.js';
-export * from './entity.js';
-export * from './relationship.js';
-export * from './geometry.js';
-export * from './units.js';
-//# sourceMappingURL=index.d.ts.map

package/dist/doc/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/doc/index.ts"],"names":[],"mappings":"AAIA,cAAc,aAAa,CAAC;AAC5B,cAAc,qBAAqB,CAAC;AACpC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,aAAa,CAAC;AAC5B,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC"}

package/dist/doc/index.js

@@ -1,11 +0,0 @@
-/* This Source Code Form is subject to the terms of the Mozilla Public
- * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
-export * from './schema.js';
-export * from './schema-version.js';
-export * from './migration-ifc4-to-ifc4x3.js';
-export * from './entity.js';
-export * from './relationship.js';
-export * from './geometry.js';
-export * from './units.js';
-//# sourceMappingURL=index.js.map

package/dist/doc/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/doc/index.ts"],"names":[],"mappings":"AAAA;;+DAE+D;AAE/D,cAAc,aAAa,CAAC;AAC5B,cAAc,qBAAqB,CAAC;AACpC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,aAAa,CAAC;AAC5B,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC"}