@thatopen/services 0.3.7 → 0.3.9

package/dist/index.es.js

@@ -2,8 +2,8 @@ var Fe = Object.defineProperty;
 var ge = (n) => {
   throw TypeError(n);
 };
-var Ve = (n, e, t) => e in n ? Fe(n, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : n[e] = t;
-var _ = (n, e, t) => Ve(n, typeof e != "symbol" ? e + "" : e, t), J = (n, e, t) => e.has(n) || ge("Cannot " + t);
+var Me = (n, e, t) => e in n ? Fe(n, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : n[e] = t;
+var _ = (n, e, t) => Me(n, typeof e != "symbol" ? e + "" : e, t), J = (n, e, t) => e.has(n) || ge("Cannot " + t);
 var j = (n, e, t) => (J(n, e, "read from private field"), t ? t.call(n) : e.get(n)), Y = (n, e, t) => e.has(n) ? ge("Cannot add the same private member more than once") : e instanceof WeakSet ? e.add(n) : e.set(n, t), we = (n, e, t, s) => (J(n, e, "write to private field"), s ? s.call(n, t) : e.set(n, t), t), c = (n, e, t) => (J(n, e, "access private method"), t);
 const k = /* @__PURE__ */ Object.create(null);
 k.open = "0";
@@ -24,22 +24,22 @@ const ee = { type: "error", data: "parser error" }, Ae = typeof Blob == "functio
     e("b" + (s || ""));
   }, t.readAsDataURL(n);
 };
-function Ee(n) {
+function be(n) {
   return n instanceof Uint8Array ? n : n instanceof ArrayBuffer ? new Uint8Array(n) : new Uint8Array(n.buffer, n.byteOffset, n.byteLength);
 }
 let K;
-function Me(n, e) {
+function Ve(n, e) {
   if (Ae && n.data instanceof Blob)
-    return n.data.arrayBuffer().then(Ee).then(e);
+    return n.data.arrayBuffer().then(be).then(e);
   if (Oe && (n.data instanceof ArrayBuffer || Se(n.data)))
-    return e(Ee(n.data));
+    return e(be(n.data));
   ue(n, !1, (t) => {
     K || (K = new TextEncoder()), e(K.encode(t));
   });
 }
-const be = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/", N = typeof Uint8Array > "u" ? [] : new Uint8Array(256);
-for (let n = 0; n < be.length; n++)
-  N[be.charCodeAt(n)] = n;
+const Ee = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/", N = typeof Uint8Array > "u" ? [] : new Uint8Array(256);
+for (let n = 0; n < Ee.length; n++)
+  N[Ee.charCodeAt(n)] = n;
 const He = (n) => {
   let e = n.length * 0.75, t = n.length, s, r = 0, i, o, h, l;
   n[n.length - 1] === "=" && (e--, n[n.length - 2] === "=" && e--);
@@ -97,7 +97,7 @@ const He = (n) => {
 function Ke() {
   return new TransformStream({
     transform(n, e) {
-      Me(n, (t) => {
+      Ve(n, (t) => {
         const s = t.length;
         let r;
         if (s < 126)
@@ -219,13 +219,13 @@ g.prototype.listeners = function(n) {
 g.prototype.hasListeners = function(n) {
   return !!this.listeners(n).length;
 };
-const H = typeof Promise == "function" && typeof Promise.resolve == "function" ? (e) => Promise.resolve().then(e) : (e, t) => t(e, 0), E = typeof self < "u" ? self : typeof window < "u" ? window : Function("return this")(), Xe = "arraybuffer";
+const H = typeof Promise == "function" && typeof Promise.resolve == "function" ? (e) => Promise.resolve().then(e) : (e, t) => t(e, 0), b = typeof self < "u" ? self : typeof window < "u" ? window : Function("return this")(), Xe = "arraybuffer";
 function Be(n, ...e) {
   return e.reduce((t, s) => (n.hasOwnProperty(s) && (t[s] = n[s]), t), {});
 }
-const Qe = E.setTimeout, Ze = E.clearTimeout;
+const Qe = b.setTimeout, Ze = b.clearTimeout;
 function G(n, e) {
-  e.useNativeTimers ? (n.setTimeoutFn = Qe.bind(E), n.clearTimeoutFn = Ze.bind(E)) : (n.setTimeoutFn = E.setTimeout.bind(E), n.clearTimeoutFn = E.clearTimeout.bind(E));
+  e.useNativeTimers ? (n.setTimeoutFn = Qe.bind(b), n.clearTimeoutFn = Ze.bind(b)) : (n.setTimeoutFn = b.setTimeout.bind(b), n.clearTimeoutFn = b.clearTimeout.bind(b));
 }
 const et = 1.33;
 function tt(n) {
@@ -602,7 +602,7 @@ if (typeof document < "u") {
   if (typeof attachEvent == "function")
     attachEvent("onunload", Te);
   else if (typeof addEventListener == "function") {
-    const n = "onpagehide" in E ? "pagehide" : "unload";
+    const n = "onpagehide" in b ? "pagehide" : "unload";
     addEventListener(n, Te, !1);
   }
 }
@@ -635,7 +635,7 @@ function Pe(n) {
   }
   if (!e)
     try {
-      return new E[["Active"].concat("Object").join("X")]("Microsoft.XMLHTTP");
+      return new b[["Active"].concat("Object").join("X")]("Microsoft.XMLHTTP");
     } catch {
     }
 }
@@ -696,7 +696,7 @@ class ft extends fe {
     return this.opts.timestampRequests && (t[this.opts.timestampParam] = xe()), this.supportsBinary || (t.b64 = 1), this.createUri(e, t);
   }
 }
-const z = E.WebSocket || E.MozWebSocket;
+const z = b.WebSocket || b.MozWebSocket;
 class pt extends ft {
   createSocket(e, t, s) {
     return Le ? new z(e, t, s) : t ? new z(e, t) : new z(e);
@@ -1066,7 +1066,7 @@ class $ extends g {
   }
 }
 $.protocol = Re;
-class Et extends $ {
+class bt extends $ {
   constructor() {
     super(...arguments), this._upgrades = [];
   }
@@ -1138,7 +1138,7 @@ class Et extends $ {
     return t;
   }
 }
-let bt = class extends Et {
+let Et = class extends bt {
   constructor(e, t = {}) {
     const s = typeof e == "object" ? e : t;
     (!s.transports || s.transports && typeof s.transports[0] == "string") && (s.transports = (s.transports || ["polling", "websocket", "webtransport"]).map((r) => yt[r]).filter((r) => !!r)), super(e, s);
@@ -1420,7 +1420,7 @@ const xt = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
     return p;
   }
 }, Symbol.toStringTag, { value: "Module" }));
-function b(n, e, t) {
+function E(n, e, t) {
   return n.on(e, t), function() {
     n.off(e, t);
   };
@@ -1468,10 +1468,10 @@ class qe extends g {
       return;
     const e = this.io;
     this.subs = [
-      b(e, "open", this.onopen.bind(this)),
-      b(e, "packet", this.onpacket.bind(this)),
-      b(e, "error", this.onerror.bind(this)),
-      b(e, "close", this.onclose.bind(this))
+      E(e, "open", this.onopen.bind(this)),
+      E(e, "packet", this.onpacket.bind(this)),
+      E(e, "error", this.onerror.bind(this)),
+      E(e, "close", this.onclose.bind(this))
     ];
   }
   /**
@@ -2100,14 +2100,14 @@ class ie extends g {
   open(e) {
     if (~this._readyState.indexOf("open"))
       return this;
-    this.engine = new bt(this.uri, this.opts);
+    this.engine = new Et(this.uri, this.opts);
     const t = this.engine, s = this;
     this._readyState = "opening", this.skipReconnect = !1;
-    const r = b(t, "open", function() {
+    const r = E(t, "open", function() {
       s.onopen(), e && e();
     }), i = (h) => {
       this.cleanup(), this._readyState = "closed", this.emitReserved("error", h), e ? e(h) : this.maybeReconnectOnOpen();
-    }, o = b(t, "error", i);
+    }, o = E(t, "error", i);
     if (this._timeout !== !1) {
       const h = this._timeout, l = this.setTimeoutFn(() => {
         r(), i(new Error("timeout")), t.close();
@@ -2136,12 +2136,12 @@ class ie extends g {
     this.cleanup(), this._readyState = "open", this.emitReserved("open");
     const e = this.engine;
     this.subs.push(
-      b(e, "ping", this.onping.bind(this)),
-      b(e, "data", this.ondata.bind(this)),
-      b(e, "error", this.onerror.bind(this)),
-      b(e, "close", this.onclose.bind(this)),
+      E(e, "ping", this.onping.bind(this)),
+      E(e, "data", this.ondata.bind(this)),
+      E(e, "error", this.onerror.bind(this)),
+      E(e, "close", this.onclose.bind(this)),
       // @ts-ignore
-      b(this.decoder, "decoded", this.ondecoded.bind(this))
+      E(this.decoder, "decoded", this.ondecoded.bind(this))
     );
   }
   /**
@@ -2327,7 +2327,7 @@ class Lt extends Error {
   }
 }
 const T = "item/folder", f = "item", O = "processor", It = "npm-registry", S = "hidden", X = "FILE", Q = "TOOL", Z = "APP";
-var a, ae, u, C, V, M, ce, he, Ue;
+var a, ae, u, C, M, V, ce, he, Ue;
 const ye = class ye {
   /**
    * Creates a new EngineServicesClient instance.
@@ -2475,7 +2475,7 @@ const ye = class ye {
    * @returns The created item and its first version.
    */
   async createFile(e) {
-    return await c(this, a, M).call(this, e, X);
+    return await c(this, a, V).call(this, e, X);
   }
   /**
    * Updates an existing file. Can rename, move to a different folder,
@@ -2508,7 +2508,7 @@ const ye = class ye {
    * @returns A fetch Response containing the file data.
    */
   async downloadFile(e, t) {
-    return await c(this, a, V).call(this, e, t);
+    return await c(this, a, M).call(this, e, t);
   }
   /**
    * Retrieves the free-JSON metadata for a specific file version.
@@ -2655,7 +2655,7 @@ const ye = class ye {
    */
   async createComponent(e) {
     const { componentProps: t } = e;
-    return await c(this, a, M).call(this, e, Q, t);
+    return await c(this, a, V).call(this, e, Q, t);
   }
   /**
    * Updates an existing component. Can rename, move, and/or upload a new version.
@@ -2674,7 +2674,7 @@ const ye = class ye {
    * @returns A fetch Response containing the ZIP data.
    */
   async downloadComponent(e, t) {
-    return await c(this, a, V).call(this, e, t);
+    return await c(this, a, M).call(this, e, t);
   }
   /**
    * Downloads only the JavaScript bundle from a component's ZIP.
@@ -2831,7 +2831,7 @@ return main;`)(...h), d = (y == null ? void 0 : y.componentDefinition) ?? y;
    */
   async createApp(e) {
     const { appProps: t } = e;
-    return await c(this, a, M).call(this, e, Z, t);
+    return await c(this, a, V).call(this, e, Z, t);
   }
   /**
    * Downloads an app's full ZIP file. Returns the raw fetch Response.
@@ -2840,7 +2840,7 @@ return main;`)(...h), d = (y == null ? void 0 : y.componentDefinition) ?? y;
    * @returns A fetch Response containing the ZIP data.
    */
   async downloadApp(e, t) {
-    return await c(this, a, V).call(this, e, t);
+    return await c(this, a, M).call(this, e, t);
   }
   /**
    * Downloads only the JavaScript bundle from an app's ZIP.
@@ -3220,7 +3220,7 @@ a = new WeakSet(), ae = function(e) {
       }
     }
   );
-}, V = async function(e, t) {
+}, M = async function(e, t) {
   const { versionTag: s, withDraft: r } = t || {};
   return await c(this, a, C).call(this, `${f}/${e}/download`, {
     query: {
@@ -3228,7 +3228,7 @@ a = new WeakSet(), ae = function(e) {
       ...r && { withDraft: r }
     }
   });
-}, M = async function(e, t, s) {
+}, V = async function(e, t, s) {
   const { name: r, versionTag: i, parentFolderId: o, projectId: h, file: l, metadata: y } = e, d = new FormData();
   return d.append("file", l), d.append("name", r), d.append("versionTag", i), d.append("itemType", t), o && d.append("folderId", o), h && d.append("projectId", h), s && d.append("extraProps", JSON.stringify(s)), y && d.append("metadata", JSON.stringify(y)), await c(this, a, u).call(this, "POST", f, {
     body: d
@@ -3343,14 +3343,15 @@ const Dt = {
   MAX_FIELDS: 200,
   MAX_KEY_LENGTH: 50,
   MAX_VALUE_LENGTH: 50
-}, Ft = { uuid: "a3f82c1d-5b74-4e9a-bc30-d7e12f894a61" }, Vt = { uuid: "b0b5e2a2-0b3a-4a6b-8b1c-0b1c4a6b8b1c" }, Mt = { uuid: "2c4ae432-fc24-43e9-9783-0c960c674e96" }, Ht = { uuid: "234f1416-528d-452a-9cc9-a16c5239b2eb" };
+}, Ft = { uuid: "a3f82c1d-5b74-4e9a-bc30-d7e12f894a61" }, Mt = { uuid: "2c9f4e8d-3a1b-4c5e-9d7f-0a2b6c8e1d3f" }, Vt = { uuid: "b0b5e2a2-0b3a-4a6b-8b1c-0b1c4a6b8b1c" }, Ht = { uuid: "2c4ae432-fc24-43e9-9783-0c960c674e96" }, Gt = { uuid: "234f1416-528d-452a-9cc9-a16c5239b2eb" };
 export {
   Ft as CDEManager,
+  Mt as ClashesManager,
   oe as EngineServicesClient,
   Vt as FileList,
-  Mt as HelloWorld,
+  Ht as HelloWorld,
   Dt as METADATA_LIMITS,
   ke as PlatformClient,
   Lt as RequestError,
-  Ht as UIManager
+  Gt as UIManager
 };

package/docs/builtin/paths.json

@@ -35,6 +35,10 @@
     "path": "src/built-in/CDEManager/examples/ProjectConfig/example.ts",
     "description": "Project configuration — read, write, and reload persistent data — A CDE application needs to store two kinds of configuration: project-wide settings that all team members share (the metadata schema, custom naming rules) and personal settings that belong to one user (which columns are visible, which metadata views are pinned). Both live inside the project's file storage under a reserved system folder, so they travel with the project and don't rely on a separate configuration service."
   },
+  {
+    "path": "src/built-in/ClashesManager/example.ts",
+    "description": "ClashesManager — Structural engineers and BIM coordinators routinely detect geometric clashes between disciplines — structural steel penetrating ductwork, pipes clashing with slabs — and need to track the status of each issue through resolution without leaving their BIM environment."
+  },
   {
     "path": "src/built-in/UIManager/src/app/example.ts",
     "description": "top-app — Front-end developers building BIM web apps need to coordinate several async initialization steps before the UI can be shown — loading the engine, preparing fragment workers, registering loaders — and users need visible feedback on what is happening during that wait, rather than a blank screen."
@@ -71,6 +75,10 @@
     "path": "src/built-in/UIManager/src/app/examples/Sidebar/example.ts",
     "description": "Sidebar navigation — Product teams building BIM apps often need multiple distinct views — a 3D model viewer, a data browser, a settings screen — but wiring a custom nav bar and managing view transitions from scratch adds complexity before any real feature work begins."
   },
+  {
+    "path": "src/built-in/UIManager/src/clashes-panel/example.ts",
+    "description": "clashes-panel — BIM coordinators need a dedicated review environment where they can see all detected clashes, filter by status, navigate to each issue in the 3D viewer, and mark items as resolved — without writing any UI code themselves."
+  },
   {
     "path": "src/built-in/UIManager/src/models-list/example.ts",
     "description": "top-models-list — top-models-list is the project files panel: it lists the project's files, uploads new ones, converts IFC to fragments, and loads `.frag` models into the 3D scene. Its loaders are PLUGGABLE — the panel owns the UI and the orchestration (progress, refresh, association), but the HOST decides how each file format is loaded, so you can teach it new formats without forking the built-in."

package/package.json

@@ -1,95 +1,95 @@
-{
-  "name": "@thatopen/services",
-  "description": "Client library and CLI for building BIM apps and cloud components on the That Open Platform",
-  "author": "That Open Company",
-  "license": "MIT",
-  "homepage": "https://github.com/ThatOpen/engine_services#readme",
-  "bugs": {
-    "url": "https://github.com/ThatOpen/engine_services/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/ThatOpen/engine_services.git"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "private": false,
-  "version": "0.3.7",
-  "main": "dist/index.cjs.js",
-  "module": "dist/index.es.js",
-  "types": "dist/index.d.ts",
-  "bin": {
-    "thatopen": "dist/cli.js"
-  },
-  "files": [
-    "dist",
-    "src/cli/templates",
-    "src/built-in",
-    "docs",
-    "resources"
-  ],
-  "scripts": {
-    "dev": "vite",
-    "lint": "eslint src/",
-    "build": "eslint src/ && tsc && vite build && vite build --config vite.config.cli.mts && node scripts/generate-cli-docs-paths.mjs && node scripts/generate-client-examples-paths.mjs",
-    "build:lib": "tsc && vite build",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "build:cli": "vite build --config vite.config.cli.mts",
-    "preview": "vite preview",
-    "test:ui": "vite --config test/vite.config.mts",
-    "template:app": "cd src/cli/templates/app && npm install && cd ../../../.. && node scripts/generate-template-tsconfig.mjs",
-    "template:app:dev": "cd src/cli/templates/app && npm run dev",
-    "changeset": "changeset",
-    "version": "changeset version",
-    "prepublishOnly": "npm run build"
-  },
-  "devDependencies": {
-    "@changesets/cli": "^2.27.7",
-    "@thatopen/components": "~3.4.0",
-    "@thatopen/components-front": "~3.4.0",
-    "@thatopen/fragments": "~3.4.0",
-    "@thatopen/ui": "~3.4.0",
-    "@thatopen/ui-obc": "~3.4.0",
-    "@types/node": "^20.12.12",
-    "@types/three": "^0.182.0",
-    "commander": "^14.0.3",
-    "esbuild": "^0.27.3",
-    "eslint": "9.x",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-prettier": "^5.1.3",
-    "globals": "^15.3.0",
-    "jszip": "^3.10.1",
-    "prettier": "^3.2.5",
-    "three": ">=0.182.0",
-    "tsx": "^4.16.2",
-    "typescript": "^5.2.2",
-    "typescript-eslint": "^7.10.0",
-    "vite": "^5.2.0",
-    "vite-plugin-dts": "^3.9.1",
-    "vite-plugin-eslint": "^1.8.1",
-    "vitest": "^4.1.4"
-  },
-  "dependencies": {
-    "dotenv": "^16.4.5",
-    "socket.io": "^4.8.0",
-    "socket.io-client": "^4.8.0"
-  },
-  "peerDependencies": {
-    "@thatopen/components": "~3.4.0",
-    "@thatopen/ui": "~3.4.0",
-    "three": ">=0.182.0"
-  },
-  "peerDependenciesMeta": {
-    "@thatopen/components": {
-      "optional": true
-    },
-    "@thatopen/ui": {
-      "optional": true
-    },
-    "three": {
-      "optional": true
-    }
-  }
-}
+{
+  "name": "@thatopen/services",
+  "description": "Client library and CLI for building BIM apps and cloud components on the That Open Platform",
+  "author": "That Open Company",
+  "license": "MIT",
+  "homepage": "https://github.com/ThatOpen/engine_services#readme",
+  "bugs": {
+    "url": "https://github.com/ThatOpen/engine_services/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ThatOpen/engine_services.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "private": false,
+  "version": "0.3.9",
+  "main": "dist/index.cjs.js",
+  "module": "dist/index.es.js",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "thatopen": "dist/cli.js"
+  },
+  "files": [
+    "dist",
+    "src/cli/templates",
+    "src/built-in",
+    "docs",
+    "resources"
+  ],
+  "scripts": {
+    "dev": "vite",
+    "lint": "eslint src/",
+    "build": "eslint src/ && tsc && vite build && vite build --config vite.config.cli.mts && node scripts/generate-cli-docs-paths.mjs && node scripts/generate-client-examples-paths.mjs",
+    "build:lib": "tsc && vite build",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "build:cli": "vite build --config vite.config.cli.mts",
+    "preview": "vite preview",
+    "test:ui": "vite --config test/vite.config.mts",
+    "template:app": "cd src/cli/templates/app && npm install && cd ../../../.. && node scripts/generate-template-tsconfig.mjs",
+    "template:app:dev": "cd src/cli/templates/app && npm run dev",
+    "changeset": "changeset",
+    "version": "changeset version",
+    "prepublishOnly": "npm run build"
+  },
+  "devDependencies": {
+    "@changesets/cli": "^2.27.7",
+    "@thatopen/components": "~3.4.0",
+    "@thatopen/components-front": "~3.4.0",
+    "@thatopen/fragments": "~3.4.0",
+    "@thatopen/ui": "~3.4.0",
+    "@thatopen/ui-obc": "~3.4.0",
+    "@types/node": "^20.12.12",
+    "@types/three": "^0.182.0",
+    "commander": "^14.0.3",
+    "esbuild": "^0.27.3",
+    "eslint": "9.x",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "globals": "^15.3.0",
+    "jszip": "^3.10.1",
+    "prettier": "^3.2.5",
+    "three": ">=0.182.0",
+    "tsx": "^4.16.2",
+    "typescript": "^5.2.2",
+    "typescript-eslint": "^7.10.0",
+    "vite": "^5.2.0",
+    "vite-plugin-dts": "^3.9.1",
+    "vite-plugin-eslint": "^1.8.1",
+    "vitest": "^4.1.4"
+  },
+  "dependencies": {
+    "dotenv": "^16.4.5",
+    "socket.io": "^4.8.0",
+    "socket.io-client": "^4.8.0"
+  },
+  "peerDependencies": {
+    "@thatopen/components": "~3.4.0",
+    "@thatopen/ui": "~3.4.0",
+    "three": ">=0.182.0"
+  },
+  "peerDependenciesMeta": {
+    "@thatopen/components": {
+      "optional": true
+    },
+    "@thatopen/ui": {
+      "optional": true
+    },
+    "three": {
+      "optional": true
+    }
+  }
+}