@snaptrude/plugin-core 0.9.4 → 0.9.6

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @snaptrude/plugin-core
 
+## 0.9.6
+
+### Patch Changes
+
+- Add five APIs the plugin agent repeatedly reached for but that did not exist.
+  - `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. `design.furniture.listCategories()` is deprecated but still supported.
+
 ## 0.9.4
 
 ### Patch Changes

package/api-manifest.json

@@ -483,6 +483,17 @@
     "argsType": "string",
     "resultType": "PluginCoreBuildingsUpdateResult"
   },
+  {
+    "path": "core.camera.getMode",
+    "namespace": "core.camera",
+    "summary": "Get the current camera mode. Paired with {@linkcode PluginCameraApi.setMode}.",
+    "examplePrompts": [
+      "Am I in 2D or 3D?",
+      "What view mode is the editor in?\n\n# Example\n```ts\nif ((await snaptrude.core.camera.getMode()) === \"2d\") {\nawait snaptrude.core.camera.setMode(\"3d\")\n}\n```"
+    ],
+    "argsType": null,
+    "resultType": "PluginCameraMode"
+  },
   {
     "path": "core.camera.getProjection",
     "namespace": "core.camera",
@@ -2907,6 +2918,19 @@
     "argsType": "number",
     "resultType": "void"
   },
+  {
+    "path": "core.io.underlay.classifyArcs",
+    "namespace": "core.io.underlay",
+    "summary": "Classify one retained AutoCAD layer's **arcs as door swings** — the deterministic tracing primitive behind CAD-to-BIM door placement. A door swing is drawn as a ~90° arc whose radius IS the leaf width and whose centre IS the hinge point. This filters the layer's arcs by plausible radius and sweep (rejecting inch-scale fillets, full-circle symbols and long shallow curves), reads each survivor as a door candidate (hinge, leaf width, swing direction, hosting wall direction), merges mirrored pairs sharing a chord line into double doors, and returns a radius histogram — real drawings use a handful of standard door sizes, so the histogram's clusters are the drawing's door widths (sanity-check them against the catalog; distrust arcs in no cluster).",
+    "examplePrompts": [
+      "Find the doors on the a-door CAD layer",
+      "Classify the door swing arcs in the imported drawing",
+      "What door sizes does this DWG use?",
+      "Read hinge points and leaf widths from the CAD door layer\n\n# Example\n```ts\nconst [cad] = await snaptrude.core.io.underlay.list()\nconst r = await snaptrude.core.io.underlay.classifyArcs(cad, \"a-door\")\nif (r) {\nconsole.log(`${r.doors.length} doors; sizes:`,\nr.radiusHistogram.filter((b) => b.count > 1))\n}\n```"
+    ],
+    "argsType": "UnderlayHandle",
+    "resultType": "PluginCadArcClassifyResult | null"
+  },
   {
     "path": "core.io.underlay.delete",
     "namespace": "core.io.underlay",
@@ -2920,6 +2944,19 @@
     "argsType": "UnderlayHandle",
     "resultType": "void"
   },
+  {
+    "path": "core.io.underlay.extractCenterlines",
+    "namespace": "core.io.underlay",
+    "summary": "Extract **continuous wall centrelines** from one retained AutoCAD layer's double-line wall faces — the deterministic tracing primitive behind CAD-to-BIM wall conversion. Instead of paging raw curves and re-deriving the geometry in worker code, this reads the whole layer and runs the vetted pipeline: cull fragments, dedupe, merge collinear runs into *faces*, pair parallel faces a wall-thickness apart into centrelines (midline = axis, separation = thickness), bridge collinear gaps up to `bridgeOpenings.maxWidth` into ONE continuous centreline while recording each bridged span as an opening, then snap near-touching endpoints at junctions.",
+    "examplePrompts": [
+      "Trace the walls from the a-wall CAD layer",
+      "Convert the AutoCAD wall linework into Snaptrude walls",
+      "Extract wall centrelines with thickness from the imported DWG",
+      "Find the glazing runs on the a-glazing layer\n\n# Example\n```ts\nconst [cad] = await snaptrude.core.io.underlay.list()\nconst r = await snaptrude.core.io.underlay.extractCenterlines(cad, \"a-wall\")\nif (r) {\nconst items = r.centerlines.map((c) => ({\nprofile: [c.start, c.end],\nthickness: c.thickness,\n}))\nconsole.log(`${items.length} walls, ${r.unpaired.length} unpaired faces`)\n}\n```"
+    ],
+    "argsType": "UnderlayHandle",
+    "resultType": "PluginCadCenterlinesResult | null"
+  },
   {
     "path": "core.io.underlay.getBounds",
     "namespace": "core.io.underlay",
@@ -2933,6 +2970,17 @@
     "argsType": "UnderlayHandle",
     "resultType": "BBoxComponents | null"
   },
+  {
+    "path": "core.io.underlay.getCadLayerGeometry",
+    "namespace": "core.io.underlay",
+    "summary": "Read one original AutoCAD layer's retained line and arc geometry in **Snaptrude world space** and Snaptrude internal units. Results are paged so large drawings can be inspected without returning the whole DWG at once.",
+    "examplePrompts": [
+      "Read the wall geometry from the A-WALL layer in this CAD underlay",
+      "Get the next 500 curves from the structural CAD layer\n\n# Example\n```ts\nconst page = await snaptrude.core.io.underlay.getCadLayerGeometry(\ncad,\n\"A-WALL\",\n{ offset: 0, limit: 500 },\n)\nif (page) console.log(`${page.curves.length} of ${page.total} curves`)\n```"
+    ],
+    "argsType": "UnderlayHandle",
+    "resultType": "PluginCadLayerGeometryPage | null"
+  },
   {
     "path": "core.io.underlay.getOpacity",
     "namespace": "core.io.underlay",
@@ -2972,6 +3020,17 @@
     "argsType": "number",
     "resultType": "UnderlayHandle[]"
   },
+  {
+    "path": "core.io.underlay.listCadLayers",
+    "namespace": "core.io.underlay",
+    "summary": "List the distinct original AutoCAD layer names retained by a placed CAD underlay. Returns `[]` for non-CAD underlays, legacy imports created before source-layer retention, missing underlays, or CAD drawings without layer tags.",
+    "examplePrompts": [
+      "List the original AutoCAD layers in this imported drawing",
+      "Which CAD layers are available in this underlay?\n\n# Example\n```ts\nconst layers = await snaptrude.core.io.underlay.listCadLayers(cad)\nconsole.log(layers)\n```"
+    ],
+    "argsType": "UnderlayHandle",
+    "resultType": "string[]"
+  },
   {
     "path": "core.io.underlay.resetScale",
     "namespace": "core.io.underlay",
@@ -3349,6 +3408,19 @@
     "argsType": "PluginAppMode",
     "resultType": "PluginCoreModeSetResult"
   },
+  {
+    "path": "core.project.getInfo",
+    "namespace": "core.project",
+    "summary": "Read identity and headline facts about the currently open project — id, display name, unit type, storey count, active storey, and site location when the project is geo-located.",
+    "examplePrompts": [
+      "What is this project called?",
+      "Where is this project located?",
+      "Give me a summary of this project",
+      "How many storeys does this project have?\n\n# Example\n```ts\nconst info = await snaptrude.core.project.getInfo()\nconsole.log(info.name, info.units, info.storeyCount)\n```"
+    ],
+    "argsType": null,
+    "resultType": "PluginProjectInfo"
+  },
   {
     "path": "core.project.settings.getTolerance",
     "namespace": "core.project.settings",
@@ -3771,6 +3843,17 @@
     "argsType": "number",
     "resultType": "PluginStoryGetResult"
   },
+  {
+    "path": "core.storeys.getActive",
+    "namespace": "core.storeys",
+    "summary": "Get the active storey's value. Paired with {@linkcode PluginCoreStoreysApi.setActive}.",
+    "examplePrompts": [
+      "Which storey am I on?",
+      "What is the current storey?\n\n# Example\n```ts\nconst storey = await snaptrude.core.storeys.getActive()\n```"
+    ],
+    "argsType": null,
+    "resultType": "number"
+  },
   {
     "path": "core.storeys.list",
     "namespace": "core.storeys",
@@ -4274,6 +4357,18 @@
     "argsType": "BrepHandle",
     "resultType": "ComponentHandle"
   },
+  {
+    "path": "design.create.opening",
+    "namespace": "design.create",
+    "summary": "Place a catalog **door or window** into a host wall with optional size overrides.",
+    "examplePrompts": [
+      "Add a 1m wide door to this wall here",
+      "Place a window with a 0.9m sill height on the selected wall"
+    ],
+    "argsType": "PluginDesignCreateOpeningOptions",
+    "resultType": "ComponentHandle",
+    "performance": "Single-opening creator — use it for one hosted opening. A plural API is intentionally unavailable until host placement can be atomic. # Example ```ts const opening = await snaptrude.design.create.opening({ kind: \"window\", catalogId: windowType.id, hostWall: wall, position: await snaptrude.core.math.vec3.new(3, 0, 5), width: 1.2, height: 1.5, sillHeight: 0.9, }) ```"
+  },
   {
     "path": "design.create.referenceLines",
     "namespace": "design.create",
@@ -4697,6 +4792,17 @@
     "argsType": "\"team\" | \"general\"",
     "resultType": "PluginFurnitureCatalogItem[]"
   },
+  {
+    "path": "design.furniture.listCatalogGroups",
+    "namespace": "design.furniture",
+    "summary": "List the furniture catalog's groups. Matches {@linkcode PluginDesignDoorsApi.listCatalogGroups} and {@linkcode PluginDesignWindowsApi.listCatalogGroups}, so all three catalog surfaces are named alike.",
+    "examplePrompts": [
+      "What furniture groups are available?",
+      "List the furniture categories in this project\n\n# Example\n```ts\nconst groups = await snaptrude.design.furniture.listCatalogGroups()\nfor (const g of groups) console.log(g.dbType, g.label, g.source)\n```"
+    ],
+    "argsType": null,
+    "resultType": "PluginObjectCatalogGroup[]"
+  },
   {
     "path": "design.furniture.listCategories",
     "namespace": "design.furniture",
@@ -4708,7 +4814,8 @@
       "Which furniture categories can I filter by?\n\n# Example\n```ts\nconst categories = await snaptrude.design.furniture.listCategories()\nconst [first] = categories\nconst items = await snaptrude.design.furniture.listCatalog(undefined, first)\nconsole.log(first, \"→\", items.length, \"items\")\n```"
     ],
     "argsType": null,
-    "resultType": "string[]"
+    "resultType": "string[]",
+    "deprecated": "design.furniture.listCatalogGroups"
   },
   {
     "path": "design.furniture.setDimensions",
@@ -5471,6 +5578,19 @@
     "argsType": "ComponentHandle",
     "resultType": "ContourHandle | null"
   },
+  {
+    "path": "design.query.storeyOutline",
+    "namespace": "design.query",
+    "summary": "Compute the plan **outline of what is built on a storey** — the union of the storey's wall (by default) footprints as polygons-with-holes. This is the footprint-from-the-built-model query: by the time slabs are needed the walls exist, and the engine's own solids (snapped, joined and mitred at creation) are the cleanest wall network available — no CAD re-tracing.",
+    "examplePrompts": [
+      "What is the building footprint on the ground floor?",
+      "Create a floor slab covering the whole storey",
+      "Get the outline of the walls on storey 1",
+      "How much area do the ground-floor walls enclose?\n\n# Example\n```ts\nconst r = await snaptrude.design.query.storeyOutline({ storey: 1 })\nconst main = r.footprints.find((f) => f.enclosed)\nif (main) {\nconst profile = await snaptrude.core.geom.create.profileFromLinePoints(\nmain.outline.map((p) => ({ x: p.x, y: 0, z: p.z })),\n)\n// → design.create.slab with the profile's contour\n}\n```"
+    ],
+    "argsType": "PluginStoreyOutlineOptions",
+    "resultType": "PluginStoreyOutlineResult"
+  },
   {
     "path": "design.selection.add",
     "namespace": "design.selection",
@@ -5863,6 +5983,17 @@
     "argsType": "ComponentHandle[]",
     "resultType": "PluginDesignChangeResult"
   },
+  {
+    "path": "design.visibility.show",
+    "namespace": "design.visibility",
+    "summary": "Reveal specific hidden components — the inverse of {@linkcode PluginDesignVisibilityApi.hide}. Use {@linkcode PluginDesignVisibilityApi.showAll} to reveal everything.",
+    "examplePrompts": [
+      "Show these walls again",
+      "Unhide the selected furniture\n\n# Example\n```ts\nawait snaptrude.design.visibility.show([wall])\n```"
+    ],
+    "argsType": "ComponentHandle[]",
+    "resultType": "PluginDesignChangeResult"
+  },
   {
     "path": "design.visibility.showAll",
     "namespace": "design.visibility",
@@ -7551,6 +7682,17 @@
     "argsType": null,
     "resultType": "PluginProgramSiteNorthAngleResult"
   },
+  {
+    "path": "program.site.getSiteAnalysis",
+    "namespace": "program.site",
+    "summary": "Read the persisted Site Analysis sheet for the active proposal.",
+    "examplePrompts": [
+      "Read the current Site Analysis sheet",
+      "What zoning constraints are recorded for this proposal?\n\n# Example\n```ts\nconst analysis = await snaptrude.program.site.getSiteAnalysis()\nif (analysis) console.log(analysis.sheetName, analysis.rows)\n```"
+    ],
+    "argsType": null,
+    "resultType": "PluginProgramSiteAnalysisResult"
+  },
   {
     "path": "program.site.getTimezone",
     "namespace": "program.site",
@@ -7615,6 +7757,17 @@
     "argsType": null,
     "resultType": "PluginProgramSiteListPolygonsResult"
   },
+  {
+    "path": "program.site.updateSiteAnalysis",
+    "namespace": "program.site",
+    "summary": "Merge sourced site/zoning constraints into the active proposal's persisted Site Analysis sheet.",
+    "examplePrompts": [
+      "Save these zoning constraints to Site Analysis",
+      "Update the FAR and setbacks in the Site Analysis sheet\n\n# Example\n```ts\nconst result = await snaptrude.program.site.updateSiteAnalysis([\n{ category: \"FAR\", description: \"Floor Area Ratio\", quantity: 3.5, unit: \"ratio\" },\n{ category: \"Set backs\", description: \"Front setbacks\", quantity: 6, unit: \"m\" },\n])\nconsole.log(result.sheetName, result.updatedRows, result.appendedRows)\n```"
+    ],
+    "argsType": "PluginSiteAnalysisRow[]",
+    "resultType": "PluginProgramSiteAnalysisUpdateResult"
+  },
   {
     "path": "program.spreadsheet.addChart",
     "namespace": "program.spreadsheet",

package/dist/api/core/camera/index.d.ts

@@ -53,6 +53,22 @@ export declare abstract class PluginCameraApi {
      * ```
      */
     abstract setStandardView(view: PluginStandardView): PluginApiReturn<boolean>;
+    /**
+     * Get the current camera mode. Paired with {@linkcode PluginCameraApi.setMode}.
+     *
+     * @returns `"2d"` when the editor is in plan view, `"3d"` otherwise.
+     *
+     * @examplePrompt Am I in 2D or 3D?
+     * @examplePrompt What view mode is the editor in?
+     *
+     * # Example
+     * ```ts
+     * if ((await snaptrude.core.camera.getMode()) === "2d") {
+     *   await snaptrude.core.camera.setMode("3d")
+     * }
+     * ```
+     */
+    abstract getMode(): PluginApiReturn<PluginCameraMode>;
     /**
      * Toggle the modelling mode between `2d` (plan) and `3d`. Mirrors the canvas
      * 2D/3D toggle: `3d` enters the isometric perspective view, `2d` drops to the

package/dist/api/core/camera/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/core/camera/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAE7C;;;;;;;;GAQG;AACH,8BAAsB,eAAe;;IAGnC;;;;;;;;;;;;;;;;;;OAkBG;aACa,QAAQ,CACtB,GAAG,EAAE,UAAU,EACf,MAAM,EAAE,UAAU,GACjB,eAAe,CAAC,OAAO,CAAC;IAE3B;;;;;;;;;;;;;;;;;;;OAmBG;aACa,eAAe,CAC7B,IAAI,EAAE,kBAAkB,GACvB,eAAe,CAAC,OAAO,CAAC;IAE3B;;;;;;;;;;;;;;;;;OAiBG;aACa,OAAO,CAAC,IAAI,EAAE,gBAAgB,GAAG,eAAe,CAAC,OAAO,CAAC;IAEzE;;;;;;;;;;;;;;;;OAgBG;aACa,aAAa,IAAI,eAAe,CAAC,sBAAsB,CAAC;IAExE;;;;;;;;;;;;;;;;;;;;;;;OAuBG;aACa,aAAa,CAC3B,UAAU,EAAE,sBAAsB,GACjC,eAAe,CAAC,OAAO,CAAC;IAE3B;;;;;;;;;;;;;;;;OAgBG;aACa,WAAW,IAAI,eAAe,CAAC,OAAO,CAAC;IAEvD;;;;;;;;;;;;;;;;;OAiBG;aACa,aAAa,IAAI,eAAe,CAAC,OAAO,CAAC;CAC1D;AAED;;;GAGG;AACH,eAAO,MAAM,kBAAkB;;;;;;;EAO7B,CAAA;AACF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAEnE;;GAEG;AACH,eAAO,MAAM,gBAAgB;;;EAAuB,CAAA;AACpD,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AAE/D;;;GAGG;AACH,eAAO,MAAM,sBAAsB;;;EAA0C,CAAA;AAC7E,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;;GAOG;AACH,eAAO,MAAM,wBAAwB;;;iBAGnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;GAMG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;iBAE1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB;;;;;iBAElC,CAAA;AACF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;GAMG;AACH,eAAO,MAAM,6BAA6B;;;;;iBAExC,CAAA;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/core/camera/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAE7C;;;;;;;;GAQG;AACH,8BAAsB,eAAe;;IAGnC;;;;;;;;;;;;;;;;;;OAkBG;aACa,QAAQ,CACtB,GAAG,EAAE,UAAU,EACf,MAAM,EAAE,UAAU,GACjB,eAAe,CAAC,OAAO,CAAC;IAE3B;;;;;;;;;;;;;;;;;;;OAmBG;aACa,eAAe,CAC7B,IAAI,EAAE,kBAAkB,GACvB,eAAe,CAAC,OAAO,CAAC;IAE3B;;;;;;;;;;;;;;OAcG;aACa,OAAO,IAAI,eAAe,CAAC,gBAAgB,CAAC;IAE5D;;;;;;;;;;;;;;;;;OAiBG;aACa,OAAO,CAAC,IAAI,EAAE,gBAAgB,GAAG,eAAe,CAAC,OAAO,CAAC;IAEzE;;;;;;;;;;;;;;;;OAgBG;aACa,aAAa,IAAI,eAAe,CAAC,sBAAsB,CAAC;IAExE;;;;;;;;;;;;;;;;;;;;;;;OAuBG;aACa,aAAa,CAC3B,UAAU,EAAE,sBAAsB,GACjC,eAAe,CAAC,OAAO,CAAC;IAE3B;;;;;;;;;;;;;;;;OAgBG;aACa,WAAW,IAAI,eAAe,CAAC,OAAO,CAAC;IAEvD;;;;;;;;;;;;;;;;;OAiBG;aACa,aAAa,IAAI,eAAe,CAAC,OAAO,CAAC;CAC1D;AAED;;;GAGG;AACH,eAAO,MAAM,kBAAkB;;;;;;;EAO7B,CAAA;AACF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAEnE;;GAEG;AACH,eAAO,MAAM,gBAAgB;;;EAAuB,CAAA;AACpD,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AAE/D;;;GAGG;AACH,eAAO,MAAM,sBAAsB;;;EAA0C,CAAA;AAC7E,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;;GAOG;AACH,eAAO,MAAM,wBAAwB;;;iBAGnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;GAMG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;iBAE1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB;;;;;iBAElC,CAAA;AACF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;GAMG;AACH,eAAO,MAAM,6BAA6B;;;;;iBAExC,CAAA;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA"}