@snaptrude/plugin-client 0.9.6 → 0.11.0-rc.1

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @snaptrude/plugin-client
 
+## 0.11.0
+
+### Minor Changes
+
+- 13c1fb5: 0.11.0 — version lockstep with `@snaptrude/plugin-core` 0.11.0 (PG2 remediation additive types). No client code changes: the client is a generic RPC proxy, so the new methods and fields are reachable without per-method code. Note: plugin-core 0.10.0 on npm was the smart-layout types published from a separate branch (no matching plugin-client release); this line goes 0.9.6 → 0.11.0 directly.
+
+### Patch Changes
+
+- Updated dependencies [13c1fb5]
+  - @snaptrude/plugin-core@0.11.0
+
 ## 0.9.6
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@snaptrude/plugin-client",
-  "version": "0.9.6",
+  "version": "0.11.0-rc.1",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -23,7 +23,7 @@
   ],
   "dependencies": {
     "comlink": "^4.4.2",
-    "@snaptrude/plugin-core": "0.9.6"
+    "@snaptrude/plugin-core": "0.11.0-rc.1"
   },
   "devDependencies": {
     "tsup": "^8.5.1",

package/upgrade-notes/0.9.0-to-0.9.6.md

@@ -0,0 +1,30 @@
+---
+from: 0.9.0
+to: 0.9.6
+breaking: false
+---
+
+## Summary
+
+0.9.6 adds five small APIs the plugin agent repeatedly reached for but that did not exist — a project-identity read, two missing getters, a targeted un-hide, and a catalog-group listing that aligns the furniture surface with doors and windows. Nothing breaks; every existing call is unchanged. The 0.9.0 → 0.9.6 span also contains the patch releases 0.9.1–0.9.4 (terrain mesh replacement, the Present-mode styling/labels/shapes lane, the OCC brep-constructor batch, and loft/sweep upgrades) — patch-level and strictly additive; see the `@snaptrude/plugin-core` CHANGELOG for those details.
+
+## Breaking changes
+
+_None._
+
+## New APIs
+
+- **`core.project.getInfo()`** — project id, display name, unit type, storey count (scoped to the active building), active storey, and site location in one call. Closes a genuine capability gap: nothing previously returned the current project's identity.
+- **`core.storeys.getActive()`** — `setActive` had no getter, unlike `core.buildings`, `core.layers` and `core.proposals`.
+- **`core.camera.getMode()`** — `setMode` had no getter, while `getProjection`/`setProjection` on the same class were paired.
+- **`design.visibility.show(components)`** — `hide` previously had only `showAll` as its inverse, so specific components could not be revealed.
+- **`design.furniture.listCatalogGroups()`** — matches `design.doors` and `design.windows`, so all three catalog surfaces are named alike.
+
+## Behavior changes
+
+- `design.furniture.listCategories()` is **deprecated** (still supported) in favour of `design.furniture.listCatalogGroups()`.
+- From the span's patch releases: `brepFromLoft` defaults to auto edge-count matching and auto seam alignment (pass `options: { compatibility: "strict", seamAlignment: "authored" }` to restore pre-0.9.4 lofting); `brepFromSweep` accepts closed (ring) paths and taper scale laws.
+
+## No action needed
+
+Existing plugins compile and run unchanged. Adopt the new getters and `listCatalogGroups` at your own pace.

package/upgrade-notes/0.9.6-to-0.11.0.md

@@ -0,0 +1,33 @@
+---
+from: 0.9.6
+to: 0.11.0
+breaking: true
+---
+
+## Summary
+
+0.11.0 is the ParametricGraphsV2 (PG2) remediation's additive-types release: new optional result fields that report what the parametric engine did (delete cascades, space rebuilds, visibility), four new error codes for parametric outcomes, engine-resolution semantics on wall creation, grounded furniture placement, a derived-BIM query, and the placed-view LOD surface. One breaking change (design.create.floor now returns an array — see below); everything else is strictly additive. Version note: plugin-core 0.10.0 on npm was the smart-layout types published from a separate branch and is skipped by this host line (no plugin-client 0.10.0 exists) — this line goes 0.9.6 → 0.11.0 directly.
+
+## Breaking changes
+
+- **`design.create.floor` returns `ComponentHandle[]`** (was a single `ComponentHandle`). The parametric engine owns floor topology and may split the requested footprint into several floors or merge it into a pre-existing neighbour; the call now honors that resolution and returns **every floor covering the requested footprint after the operation** — created floor(s) and/or the absorbing floor. A simple independent create returns `[floor]`. Migration: `const floor = await …floor(c, t)` → `const [floor] = await …floor(c, t)` (destructure the first element for the old behavior); inspect the full array to handle splits/merges.
+
+## New APIs
+
+- **`design.query.spaces.listGeneratedBim(space)`** — the space's engine-derived BIM component handles as `{ walls, floors, slabs }` (`PluginSpaceGeneratedBim`). The set changes on merge/split — re-query after writes; this is the churn-recovery anchor for stale derived handles.
+- **`presentation.placedViews.setLod(shapeId, lod)`** — set the level of detail a placed view renders at (`PluginViewLod`: `"design"` massing / `"bim"` detail). The placed-view record gains matching optional `lod` and `inactiveBuildingMask` fields.
+- **`presentation.sheets.place` `options.lod`** — the LOD of the placed view (default: the product's Design default).
+- **`design.create.walls` honors the engine's resolution** — curves touching existing walls may merge into or split against them; the call returns the actually-created set (its count can differ from the input curve count; profile-ordered matches first). The former hard requirement of exactly one new wall per curve is gone — re-query rather than index-pairing input curves to output walls.
+- **`design.create.furniture` placement is grounded** — `position.y` is the placed instance's bounding-box bottom (the surface it stands on). Plugins that encoded origin-relative Y values must recompute placements against the grounded contract (no legacy option is kept).
+- **`design.delete.entities` cascade report** — returns `PluginDesignDeleteResult`: the shared change-result shape plus optional `cascaded` handles (components PG2 removed as a consequence — derived walls/floors/slabs of deleted spaces; for cache invalidation).
+- **`design.update.space` / `.spaces` `rebuilt`** — `PluginSpaceUpdateResult` gains an optional `rebuilt` boolean: a geometry update rebuilt the space's derived BIM (hosted children re-created, previous derived handles retired).
+- **`design.query.getProperties` `isVisible`** — optional read-only property: whether the entity currently has a visible representation on canvas (user hide flag AND LOD/mode gating both considered). Not a filter field.
+- **Error codes** — `HANDLE_STALE` (a legitimately held handle retired by a parametric merge/split/rebuild — the one deliberate exception to the `HANDLE_INVALID` collapse; forged ids still collapse), `KIND_HIDDEN_IN_MODE`, `MERGED_INTO_EXISTING`, `BLOCKED_IN_BIM`. Wrong-kind targets keep the existing `HANDLE_KIND_MISMATCH` — no new code.
+
+## Behavior changes
+
+_None._ Every addition is an optional field, optional trailing argument, new method, or appended error code. New optional result fields (`cascaded`, `rebuilt`, `lod`, `inactiveBuildingMask`, `isVisible`) appear only on hosts that emit them — treat absence as "not reported".
+
+## No action needed
+
+Existing plugins compile and run unchanged. If you cache handles to a space's derived walls/floors/slabs, adopt `listGeneratedBim` + the `cascaded`/`rebuilt` signals to invalidate them after writes.

package/upgrade-notes/index.json

@@ -1,6 +1,6 @@
 {
   "package": "@snaptrude/plugin-client",
-  "latest": "0.9.0",
+  "latest": "0.11.0",
   "spans": [
     {
       "from": "0.4.0",
@@ -37,6 +37,18 @@
       "to": "0.9.0",
       "file": "0.8.0-to-0.9.0.md",
       "breaking": false
+    },
+    {
+      "from": "0.9.0",
+      "to": "0.9.6",
+      "file": "0.9.0-to-0.9.6.md",
+      "breaking": false
+    },
+    {
+      "from": "0.9.6",
+      "to": "0.11.0",
+      "file": "0.9.6-to-0.11.0.md",
+      "breaking": false
     }
   ]
 }