@ifc-lite/collab 0.2.0

package/dist/viewer-bridge.js

@@ -0,0 +1,82 @@
+/* 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/. */
+/**
+ * Viewer bridge (spec §7 + §16.4 — viewer-side rendering).
+ *
+ * Drop-in glue between a `CollabSession` and `packages/viewer`'s
+ * 2D-canvas-overlay-friendly DOM. Apps call this once at viewer
+ * mount time and presence rendering is wired end to end:
+ *
+ *     import { mountPresenceInViewer } from '@ifc-lite/collab';
+ *     const teardown = mountPresenceInViewer({
+ *       session,
+ *       container: document.getElementById('viewer'),
+ *       viewport: 'plan',
+ *     });
+ *     // …on dispose:
+ *     teardown();
+ *
+ * Behind the scenes:
+ *   - Mounts a `createPresenceOverlay` over `container`.
+ *   - Subscribes to `session.presence.onUpdate` and forwards to the
+ *     overlay.
+ *   - Wires the local cursor: every mousemove on `container` is
+ *     turned into a `setCursor2d` update.
+ *   - Cleans everything up on teardown.
+ */
+import { createPresenceOverlay } from './awareness/overlay.js';
+export function mountPresenceInViewer(opts) {
+    if (typeof document === 'undefined') {
+        throw new Error('@ifc-lite/collab: mountPresenceInViewer requires a browser DOM');
+    }
+    const overlay = createPresenceOverlay({
+        container: opts.container,
+        viewport: opts.viewport,
+        excludeClientId: opts.session.clientId,
+    });
+    const presenceUnsub = opts.session.presence.onUpdate((peers) => {
+        overlay.update(peers);
+    });
+    const handleMove = (event) => {
+        const rect = opts.container.getBoundingClientRect();
+        const localX = event.clientX - rect.left;
+        const localY = event.clientY - rect.top;
+        if (opts.raycastToWorld) {
+            const hit = opts.raycastToWorld(localX, localY);
+            // On a miss we deliberately leave the last cursor3d in place —
+            // see the option doc comment above.
+            if (hit) {
+                opts.session.presence.setCursor3d(hit);
+            }
+            return;
+        }
+        opts.session.presence.setCursor2d(opts.viewport, { x: localX, y: localY });
+    };
+    const clearLocalCursor = () => {
+        if (opts.raycastToWorld) {
+            opts.session.presence.setCursor3d(null);
+        }
+        else {
+            opts.session.presence.setCursor2d(opts.viewport, null);
+        }
+    };
+    if (opts.trackLocalCursor !== false) {
+        opts.container.addEventListener('mousemove', handleMove);
+        opts.container.addEventListener('mouseleave', clearLocalCursor);
+    }
+    return () => {
+        presenceUnsub();
+        if (opts.trackLocalCursor !== false) {
+            opts.container.removeEventListener('mousemove', handleMove);
+            opts.container.removeEventListener('mouseleave', clearLocalCursor);
+            // Explicitly clear our published cursor — unmounting without
+            // a prior `mouseleave` (e.g. SPA route change while pointer is
+            // inside the viewport) used to leave stale cursors visible to
+            // other peers until the session disposed.
+            clearLocalCursor();
+        }
+        overlay.destroy();
+    };
+}
+//# sourceMappingURL=viewer-bridge.js.map

package/dist/viewer-bridge.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"viewer-bridge.js","sourceRoot":"","sources":["../src/viewer-bridge.ts"],"names":[],"mappings":"AAAA;;+DAE+D;AAE/D;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,OAAO,EAAE,qBAAqB,EAAwB,MAAM,wBAAwB,CAAC;AA6BrF,MAAM,UAAU,qBAAqB,CAAC,IAAkC;IACtE,IAAI,OAAO,QAAQ,KAAK,WAAW,EAAE,CAAC;QACpC,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAC;IACpF,CAAC;IAED,MAAM,OAAO,GAAoB,qBAAqB,CAAC;QACrD,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,eAAe,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ;KACvC,CAAC,CAAC;IAEH,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,KAAkB,EAAE,EAAE;QAC1E,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,MAAM,UAAU,GAAG,CAAC,KAAiB,EAAE,EAAE;QACvC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,qBAAqB,EAAE,CAAC;QACpD,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC;QACzC,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC;QACxC,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,MAAM,GAAG,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YAChD,+DAA+D;YAC/D,oCAAoC;YACpC,IAAI,GAAG,EAAE,CAAC;gBACR,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;YACzC,CAAC;YACD,OAAO;QACT,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;IAC7E,CAAC,CAAC;IAEF,MAAM,gBAAgB,GAAG,GAAG,EAAE;QAC5B,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAC1C,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACzD,CAAC;IACH,CAAC,CAAC;IAEF,IAAI,IAAI,CAAC,gBAAgB,KAAK,KAAK,EAAE,CAAC;QACpC,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QACzD,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,YAAY,EAAE,gBAAgB,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,GAAG,EAAE;QACV,aAAa,EAAE,CAAC;QAChB,IAAI,IAAI,CAAC,gBAAgB,KAAK,KAAK,EAAE,CAAC;YACpC,IAAI,CAAC,SAAS,CAAC,mBAAmB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;YAC5D,IAAI,CAAC,SAAS,CAAC,mBAAmB,CAAC,YAAY,EAAE,gBAAgB,CAAC,CAAC;YACnE,6DAA6D;YAC7D,+DAA+D;YAC/D,8DAA8D;YAC9D,0CAA0C;YAC1C,gBAAgB,EAAE,CAAC;QACrB,CAAC;QACD,OAAO,CAAC,OAAO,EAAE,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC"}

package/package.json

@@ -0,0 +1,83 @@
+{
+  "name": "@ifc-lite/collab",
+  "version": "0.2.0",
+  "description": "Real-time collaborative BIM via CRDT on IFCX",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./snapshot": {
+      "import": "./dist/snapshot/index.js",
+      "types": "./dist/snapshot/index.d.ts"
+    },
+    "./providers/indexeddb": {
+      "import": "./dist/providers/indexeddb.js",
+      "types": "./dist/providers/indexeddb.d.ts"
+    },
+    "./providers/websocket": {
+      "import": "./dist/providers/websocket.js",
+      "types": "./dist/providers/websocket.d.ts"
+    },
+    "./awareness": {
+      "import": "./dist/awareness/index.js",
+      "types": "./dist/awareness/index.d.ts"
+    },
+    "./snapshot/worker": {
+      "import": "./dist/snapshot/worker.js",
+      "types": "./dist/snapshot/worker.d.ts"
+    }
+  },
+  "dependencies": {
+    "@automerge/automerge": "^3.2.6",
+    "lib0": "^0.2.99",
+    "y-indexeddb": "^9.0.12",
+    "y-protocols": "^1.0.6",
+    "y-websocket": "^2.0.4",
+    "yjs": "^13.6.20",
+    "@ifc-lite/data": "^1.17.0",
+    "@ifc-lite/ifcx": "^2.1.1",
+    "@ifc-lite/mutations": "^1.15.0"
+  },
+  "devDependencies": {
+    "@types/ws": "^8.5.13",
+    "typescript": "^5.3.0",
+    "vitest": "^1.6.0",
+    "ws": "^8.18.0"
+  },
+  "license": "MPL-2.0",
+  "author": "Louis True",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/louistrue/ifc-lite.git",
+    "directory": "packages/collab"
+  },
+  "homepage": "https://louistrue.github.io/ifc-lite/",
+  "bugs": "https://github.com/louistrue/ifc-lite/issues",
+  "keywords": [
+    "ifc",
+    "ifcx",
+    "ifc5",
+    "bim",
+    "collaboration",
+    "crdt",
+    "yjs",
+    "real-time",
+    "aec"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "pnpm exec tsc",
+    "dev": "pnpm exec tsc --watch",
+    "test": "vitest run"
+  }
+}