pi-revit 0.2.3 → 0.2.5

package/CHANGELOG.md

@@ -0,0 +1,105 @@
+# Changelog
+
+All notable changes to pi-revit are documented here.
+Format follows [Keep a Changelog](https://keepachangelog.com/); version headers use
+`## [x.y.z] - YYYY-MM-DD` so tooling (and Pi's changelog parser format) can read them.
+
+Every published version gets an entry with **Added** / **Changed** / **Fixed** sections
+describing what the user will notice — not internal refactors.
+
+## [0.2.5] - 2026-07-20
+
+### Fixed
+- `execute_csharp` dialog guard no longer answers every Revit popup with OK. On some
+  dialogs OK is the destructive choice (e.g. "Delete Element(s)"), so a script could
+  silently delete dimensions or constraints and still report success. Unrecognized
+  dialogs are now answered dismissively (Cancel, then Close, then No; OK only as the
+  last resort so Revit can never hang behind a popup), a small allowlist keeps OK for
+  dialogs that are safe to confirm, and `suppressedDialogs` now reports which answer
+  was given (e.g. `TaskDialog_… (answered Cancel)`).
+
+### Changed
+- The `execute_csharp` tool description tells the model that confirmation prompts may be
+  cancelled and to check `suppressedDialogs` when a result looks incomplete.
+
+Requires redeploying the Revit add-in (`scripts\deploy.ps1` + Revit restart) — `ping`
+warns on a version mismatch until then.
+
+## [0.2.4] - 2026-07-20
+
+### Added
+- This changelog. It ships inside the npm package and gets a `## [x.y.z]` entry with
+  **Added / Changed / Fixed** sections for every release, so updates report what actually
+  changed instead of just a version number.
+
+## [0.2.3] - 2026-07-20
+
+### Changed
+- `search_api_docs`: results with the same short name in different namespaces are now
+  disambiguated with their full namespace, so `Category` vs internal schedule types
+  can't be confused.
+
+### Fixed
+- Removed a hardcoded example from the overload note that could mislead the model into
+  copying a signature that didn't apply.
+
+## [0.2.2] - 2026-07-20
+
+### Added
+- `search_api_docs`: exception documentation ("Throws:") is now shown for matched members.
+- Overload-targeted queries: a query containing `(` matches against rendered signatures.
+
+### Changed
+- Overloads now rank simplest-first (fewest parameters), so the common form appears on top.
+
+## [0.2.1] - 2026-07-16
+
+### Added
+- Extension/add-in version handshake: `ping` reports both versions and warns when the
+  npm extension and the installed Revit add-in are out of sync (partial-update detection).
+
+## [0.2.0] - 2026-07-15
+
+### Changed
+- SKILL.md: documents the top-match inline docs behaviour and the automatic
+  `Models\<title>\exports` output location so the agent uses them without prompting.
+
+## [0.1.9] - 2026-07-15
+
+### Added
+- `search_api_docs` indexes every Revit API enum and surfaces `<remarks>` documentation.
+
+### Changed
+- The top match's full documentation is placed directly in the tool's text output
+  (where model attention is strongest) instead of only in the structured payload.
+
+## [0.1.8] - 2026-07-13
+
+### Added
+- Automatic per-model output sorting: exports, captures, and scripts land under
+  `Models\<model title>\` in the workspace, keyed to the source document.
+
+## [0.1.7] - 2026-07-13
+
+### Fixed
+- npm-install uninstall flow no longer blocks itself on its own installation folder.
+
+## [0.1.6] - 2026-07-13
+
+### Changed
+- The global launcher installs next to the user's permanent pi under npx.
+
+## [0.1.5] - 2026-07-13
+
+### Fixed
+- Uninstall of the npm-installed Pi package.
+- Workspace paths containing non-ASCII characters.
+
+First version published to npm.
+
+## [0.1.0] - 2026-06-17
+
+Initial public release: Revit bridge add-in (Revit 2025/2026/2027) plus Pi extension with
+`ping`, `get_model_overview`, `get_elements`, `get_element_details`, `set_parameters`,
+`manage_selection`, `capture_view`, `export_documents`, `execute_csharp`, and
+`search_api_docs`.

package/package.json

@@ -1,55 +1,56 @@
-{
-  "name": "pi-revit",
-  "version": "0.2.3",
-  "description": "Native Pi connector for Autodesk Revit. Run npx.cmd -y pi-revit for the full Windows install.",
-  "author": "Ahmad Altahlawi",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Triavision-ai/pi-revit.git"
-  },
-  "bugs": {
-    "url": "https://github.com/Triavision-ai/pi-revit/issues"
-  },
-  "homepage": "https://github.com/Triavision-ai/pi-revit#readme",
-  "keywords": [
-    "pi-package",
-    "pi-extension",
-    "revit",
-    "bim",
-    "autodesk",
-    "revit-api"
-  ],
-  "bin": {
-    "pi-revit": "bin/pi-revit.js"
-  },
-  "scripts": {
-    "deploy": "powershell -ExecutionPolicy Bypass -File scripts/deploy.ps1",
-    "setup": "powershell -ExecutionPolicy Bypass -File scripts/setup-workspace.ps1",
-    "uninstall:revit": "powershell -ExecutionPolicy Bypass -File scripts/uninstall.ps1"
-  },
-  "files": [
-    "bin/",
-    "extensions/",
-    "skills/",
-    "scripts/",
-    "src/",
-    "workspace/",
-    "README.md"
-  ],
-  "pi": {
-    "extensions": [
-      "./extensions/pi-revit/index.ts"
-    ],
-    "skills": [
-      "./skills"
-    ]
-  },
-  "engines": {
-    "node": ">=20.3"
-  },
-  "peerDependencies": {
-    "@earendil-works/pi-coding-agent": "*",
-    "typebox": "*"
-  }
-}
+{
+  "name": "pi-revit",
+  "version": "0.2.5",
+  "description": "Native Pi connector for Autodesk Revit. Run npx.cmd -y pi-revit for the full Windows install.",
+  "author": "Ahmad Altahlawi",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Triavision-ai/pi-revit.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Triavision-ai/pi-revit/issues"
+  },
+  "homepage": "https://github.com/Triavision-ai/pi-revit#readme",
+  "keywords": [
+    "pi-package",
+    "pi-extension",
+    "revit",
+    "bim",
+    "autodesk",
+    "revit-api"
+  ],
+  "bin": {
+    "pi-revit": "bin/pi-revit.js"
+  },
+  "scripts": {
+    "deploy": "powershell -ExecutionPolicy Bypass -File scripts/deploy.ps1",
+    "setup": "powershell -ExecutionPolicy Bypass -File scripts/setup-workspace.ps1",
+    "uninstall:revit": "powershell -ExecutionPolicy Bypass -File scripts/uninstall.ps1"
+  },
+  "files": [
+    "bin/",
+    "extensions/",
+    "skills/",
+    "scripts/",
+    "src/",
+    "workspace/",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "pi": {
+    "extensions": [
+      "./extensions/pi-revit/index.ts"
+    ],
+    "skills": [
+      "./skills"
+    ]
+  },
+  "engines": {
+    "node": ">=20.3"
+  },
+  "peerDependencies": {
+    "@earendil-works/pi-coding-agent": "*",
+    "typebox": "*"
+  }
+}

package/src/Revit/Tools/ExecuteCsharp.cs

@@ -59,7 +59,7 @@ namespace RevitBridge.Tools
 
         public string Name => "execute_csharp";
         public string Label => "Execute C#";
-        public string Description => "Compile and run a C# script on the Revit API thread against the open model — the escape hatch for anything without a dedicated tool: element creation, deletion, geometry edits (move/copy/rotate), views, sheets, schedules, tagging, families, links, worksets. Globals: doc (Document), uidoc (UIDocument), uiapp (UIApplication), and Dump(value) to record intermediate values into the result's dumps[]. Default imports: System, System.Linq, System.Collections.Generic, Autodesk.Revit.DB, Autodesk.Revit.UI — add using directives at the top for sub-namespaces (e.g. using Autodesk.Revit.DB.Architecture;). The entire run is wrapped in ONE transaction named 'execute_csharp': committed on success, rolled back on any exception, so a failed script never changes the model (do not open your own Transaction; sub-transactions are fine). The script's final expression or return statement becomes returnValue; return primitives, strings, or anonymous objects/lists — Revit API values are projected to safe shapes (Element -> {id,name,category,typeName,levelId}, ElementId -> number, XYZ -> {x,y,z}, Parameter -> {name,value,displayValue}; other API objects become strings) with depth and item caps, so never rely on raw API objects round-tripping. Lengths are in internal units (decimal feet) — convert with UnitUtils. Prefer collector-level filtering (FilteredElementCollector .OfCategory/.OfClass/.WhereElementIsNotElementType) and bounded loops: the call budget is 120s and Revit cannot be interrupted mid-script. Scripts must be fully synchronous — await/async is rejected at compile time, and blocking on tasks (Task.Result/.Wait()) can freeze Revit. Modal dialogs raised while running are auto-dismissed and reported in suppressedDialogs. Verify unfamiliar signatures with search_api_docs first.";
+        public string Description => "Compile and run a C# script on the Revit API thread against the open model — the escape hatch for anything without a dedicated tool: element creation, deletion, geometry edits (move/copy/rotate), views, sheets, schedules, tagging, families, links, worksets. Globals: doc (Document), uidoc (UIDocument), uiapp (UIApplication), and Dump(value) to record intermediate values into the result's dumps[]. Default imports: System, System.Linq, System.Collections.Generic, Autodesk.Revit.DB, Autodesk.Revit.UI — add using directives at the top for sub-namespaces (e.g. using Autodesk.Revit.DB.Architecture;). The entire run is wrapped in ONE transaction named 'execute_csharp': committed on success, rolled back on any exception, so a failed script never changes the model (do not open your own Transaction; sub-transactions are fine). The script's final expression or return statement becomes returnValue; return primitives, strings, or anonymous objects/lists — Revit API values are projected to safe shapes (Element -> {id,name,category,typeName,levelId}, ElementId -> number, XYZ -> {x,y,z}, Parameter -> {name,value,displayValue}; other API objects become strings) with depth and item caps, so never rely on raw API objects round-tripping. Lengths are in internal units (decimal feet) — convert with UnitUtils. Prefer collector-level filtering (FilteredElementCollector .OfCategory/.OfClass/.WhereElementIsNotElementType) and bounded loops: the call budget is 120s and Revit cannot be interrupted mid-script. Scripts must be fully synchronous — await/async is rejected at compile time, and blocking on tasks (Task.Result/.Wait()) can freeze Revit. Modal dialogs raised while running are auto-dismissed and reported in suppressedDialogs — unrecognized dialogs are answered dismissively (Cancel/Close/No) rather than confirmed, so an operation that raises a confirmation prompt may be cancelled; check suppressedDialogs when a result looks incomplete. Verify unfamiliar signatures with search_api_docs first.";
         public bool Write => true;
 
         public object ParametersSchema => new
@@ -234,9 +234,31 @@ namespace RevitBridge.Tools
         }
 
         /// <summary>Auto-dismisses any modal Revit dialog raised while the script runs, so a
-        /// popup cannot hang the Revit thread; dismissed dialog ids are reported.</summary>
+        /// popup cannot hang the Revit thread; dismissed dialog ids and the answer given are
+        /// reported. Unrecognized dialogs get the dismissive answer (Cancel, then Close, then
+        /// No) — on several Revit dialogs OK is the destructive choice (e.g. "Delete
+        /// Element(s)"), so confirming blind can silently damage the model. OK leads only for
+        /// dialogs known to be safe to confirm, and is otherwise the last resort: every
+        /// override attempt failing would leave the dialog up and hang the Revit thread,
+        /// which is the one outcome this guard exists to prevent.</summary>
         private sealed class DialogGuard : IDisposable
         {
+            private const int IDOK = 1;
+            private const int IDCANCEL = 2;
+            private const int IDNO = 7;
+            private const int IDCLOSE = 8;
+
+            /// <summary>Dialogs where confirming is the benign answer and cancelling would
+            /// abort the operation the script deliberately started.</summary>
+            private static readonly HashSet<string> ConfirmSafeDialogIds = new(StringComparer.OrdinalIgnoreCase)
+            {
+                // "Export with temporary hide/isolate": OK exports the view as displayed.
+                "TaskDialog_Really_Print_Or_Export_Temp_View_Modes",
+            };
+
+            private static readonly int[] ConfirmFirst = { IDOK, IDCANCEL, IDCLOSE };
+            private static readonly int[] DismissFirst = { IDCANCEL, IDCLOSE, IDNO, IDOK };
+
             private readonly UIApplication _uiapp;
             public List<string> Suppressed { get; } = new();
 
@@ -248,17 +270,35 @@ namespace RevitBridge.Tools
 
             private void OnDialogBoxShowing(object? sender, DialogBoxShowingEventArgs e)
             {
-                Suppressed.Add(string.IsNullOrEmpty(e.DialogId) ? e.GetType().Name : e.DialogId);
-                try
-                {
-                    e.OverrideResult(1); // IDOK
-                }
-                catch
+                string id = string.IsNullOrEmpty(e.DialogId) ? e.GetType().Name : e.DialogId;
+                int[] answers = ConfirmSafeDialogIds.Contains(id) ? ConfirmFirst : DismissFirst;
+                foreach (int answer in answers)
                 {
-                    // Some dialogs reject overrides; never let the guard itself throw.
+                    try
+                    {
+                        if (e.OverrideResult(answer))
+                        {
+                            Suppressed.Add($"{id} (answered {AnswerName(answer)})");
+                            return;
+                        }
+                    }
+                    catch
+                    {
+                        // Some dialogs reject specific overrides; try the next answer.
+                    }
                 }
+                Suppressed.Add($"{id} (override rejected — dialog may need manual dismissal)");
             }
 
+            private static string AnswerName(int answer) => answer switch
+            {
+                IDOK => "OK",
+                IDCANCEL => "Cancel",
+                IDNO => "No",
+                IDCLOSE => "Close",
+                _ => answer.ToString(),
+            };
+
             public void Dispose()
             {
                 try