@thatopen/services 0.3.13 → 0.3.15

package/dist/cli/commands/revit.d.ts

@@ -2,7 +2,7 @@ import { Command } from 'commander';
 
 /**
  * `thatopen revit ...` — Revit collaboration commands. They drive the local
- * That Open Revit add-in (BT3): publish a shared central, join one, and sync.
+ * That Open Revit add-in (revit-flow): publish a shared central, join one, and sync.
  * Auth comes from `thatopen login` (~/.thatopen/config.json) and is forwarded to
  * the add-in, so the user never re-enters a token here.
  */

package/dist/cli/lib/revit-addin.d.ts

@@ -1,5 +1,5 @@
 /**
- * Talks to the local That Open Revit add-in (BT3). The add-in runs a
+ * Talks to the local That Open Revit add-in (revit-flow). The add-in runs a
  * 127.0.0.1 command listener and, on startup, writes its port + token to
  * %APPDATA%\ThatOpen\revit-addin.json so the CLI can discover it. Revit-specific
  * work (create central, create local, sync) happens inside the add-in; the CLI

package/dist/cli.js

@@ -11701,7 +11701,7 @@ async function callAddin(cmd, body = {}) {
       method: "POST",
       headers: {
         "Content-Type": "application/json",
-        "X-Bt3-Token": info.token
+        "X-RevitFlow-Token": info.token
       },
       body: JSON.stringify(body),
       signal: AbortSignal.timeout(6e5)
@@ -11799,6 +11799,22 @@ revitCommand.command("sync").description("Synchronize your local with the team (
   const r = await callAddin("sync");
   console.log(`Synced.  v${r.verB} → v${r.verA}.`);
 });
+revitCommand.command("worksets").description("List the model worksets and who owns each").action(async () => {
+  await connect();
+  const r = await callAddin("worksets");
+  console.log(JSON.stringify(r.worksets, null, 2));
+});
+revitCommand.command("take").description("Take ownership of a workset (only one person at a time — the team lock arbitrates)").requiredOption("--workset <name>", "The workset name to take").action(async (opts) => {
+  await connect();
+  const r = await callAddin("take", { workset: opts.workset });
+  if (r.taken) console.log(`✓ Took workset "${r.workset}" (${r.result}). You can now edit its elements.`);
+  else console.log(`✗ Could NOT take "${r.workset}" — it is held by "${r.deniedBy}". Ask them to release it (untake).`);
+});
+revitCommand.command("untake").description("Release a workset you own so teammates can take it").requiredOption("--workset <name>", "The workset name to release").action(async (opts) => {
+  await connect();
+  const r = await callAddin("untake", { workset: opts.workset });
+  console.log(`Released workset "${r.released}".`);
+});
 const pkg = JSON.parse(
   require$$3.readFileSync(require$$2.join(__dirname, "..", "package.json"), "utf-8")
 );

package/docs/revit-collab-quickstart.md

@@ -81,7 +81,7 @@ Do **not** ask for the access token yet (that's Step 2).
 
    **(b) Revit is open but status still errors → the add‑in isn't installed. Install it:**
    - The add‑in files ship in **this same folder** as this guide (`install.ps1`,
-     `Bt3Addin.dll`, `Bt3Core.dll`, `bt3.addin`). From this folder, run:
+     `RevitFlowAddin.dll`, `RevitFlowCore.dll`, `revitflow.addin`). From this folder, run:
      ```
      powershell -ExecutionPolicy Bypass -File install.ps1
      ```
@@ -178,6 +178,52 @@ Success: `Synced.  vN → vM.` Repeat as often as they like; syncs are queued, n
 
 ---
 
+## Step 5 — Worksets (so two people don't edit the same thing)
+Syncs never corrupt the central, but if **two people edit the SAME element** without
+coordinating, the second one's sync is rejected and their local can get stuck. To avoid
+that, claim the part of the model you're about to edit using **worksets** — the unit of
+ownership. Typically one workset per area or per person (this central already has one per
+floor/level).
+
+**See the worksets and who owns each:**
+```
+thatopen revit worksets
+```
+
+**Claim a workset before editing it — two equivalent ways:**
+- **Ribbon (easiest):** in Revit's **Add-Ins → That Open** panel, select any element that
+  belongs to the workset you want, then click **"Take workset"**.
+- **CLI:**
+  ```
+  thatopen revit take --workset "<NAME>"
+  ```
+Only **one person at a time** can own a workset. If someone else already holds it, you get
+`✗ held by <user>` — coordinate or pick another. If two people click Take at the same
+instant, the platform lock gives it to exactly one and denies the other (no corruption).
+
+**⚠️ Ownership only protects you AFTER a sync round.** Taking a workset is instant for the
+*claim* (nobody else can take it), but Revit only **blocks teammates' edits** once the
+ownership reaches their copy: **you Sync (push your ownership), then each teammate Syncs
+(pulls it).** So the reliable sequence is:
+1. `thatopen revit take --workset "<NAME>"` (or the Take workset button)
+2. `thatopen revit sync`   ← you push the ownership
+3. teammates `thatopen revit sync`   ← now Revit blocks them from editing your workset
+
+Until teammates have synced, they could still auto-borrow an element in that workset by
+editing it directly. After the round, they'll see it as owned by you and be blocked.
+
+**Release when you're done** so teammates can take it:
+- **Ribbon:** click **"Release worksets"** (frees everything you own).
+- **CLI:** `thatopen revit untake --workset "<NAME>"`
+Then `sync` so the release propagates.
+
+> Note: simply editing an element makes you its **borrower** automatically (element-level);
+> **taking a workset** makes you the **owner** (workset-level). Revit only blocks editing
+> worksets owned by **someone else** — so the Take→Sync→Sync round above is what creates the
+> protection.
+
+---
+
 ## Troubleshooting
 - **`thatopen login` fails with "Unauthorized"** → the token is invalid/expired, or it's
   for a different environment than `--api-url`. Ask the user to generate a fresh token in
@@ -196,6 +242,11 @@ Success: `Synced.  vN → vM.` Repeat as often as they like; syncs are queued, n
   `--convert`.
 - **`join` says "Identify the central … with one of …"** → provide `--folder-id`, or
   `--path`, or both `--project` and `--doc`.
+- **`take` returns `✗ held by <user>`** → someone else owns that workset. Ask them to
+  Release + sync, or claim a different workset. This is expected, not an error.
+- **A teammate can still edit "my" workset** → ownership hasn't reached them yet. Make sure
+  **you synced after taking it, and they synced afterwards** (Step 5). Until both sync
+  rounds happen, Revit on their side doesn't know you own it.
 
 ## Rules recap (for the AI)
 - Ask for every value you don't have — never guess a project id, file path, or central name.

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.13",
-  "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.15",
+  "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
+    }
+  }
+}