@snaptrude/plugin-core 0.0.0-bimsvg-20260928124803

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (383) hide show
  1. package/AGENTS.md +231 -0
  2. package/CHANGELOG.md +341 -0
  3. package/CLAUDE.md +11 -0
  4. package/api-manifest.json +9120 -0
  5. package/dist/api/analysis/daylight.d.ts +603 -0
  6. package/dist/api/analysis/daylight.d.ts.map +1 -0
  7. package/dist/api/analysis/heatmaps.d.ts +658 -0
  8. package/dist/api/analysis/heatmaps.d.ts.map +1 -0
  9. package/dist/api/analysis/illuminance.d.ts +145 -0
  10. package/dist/api/analysis/illuminance.d.ts.map +1 -0
  11. package/dist/api/analysis/index.d.ts +59 -0
  12. package/dist/api/analysis/index.d.ts.map +1 -0
  13. package/dist/api/analysis/shadows.d.ts +165 -0
  14. package/dist/api/analysis/shadows.d.ts.map +1 -0
  15. package/dist/api/analysis/solar.d.ts +249 -0
  16. package/dist/api/analysis/solar.d.ts.map +1 -0
  17. package/dist/api/analysis/sunlightHours.d.ts +208 -0
  18. package/dist/api/analysis/sunlightHours.d.ts.map +1 -0
  19. package/dist/api/analysis/sunpath.d.ts +80 -0
  20. package/dist/api/analysis/sunpath.d.ts.map +1 -0
  21. package/dist/api/analysis/weather.d.ts +193 -0
  22. package/dist/api/analysis/weather.d.ts.map +1 -0
  23. package/dist/api/core/buildings.d.ts +427 -0
  24. package/dist/api/core/buildings.d.ts.map +1 -0
  25. package/dist/api/core/camera/index.d.ts +261 -0
  26. package/dist/api/core/camera/index.d.ts.map +1 -0
  27. package/dist/api/core/comment/index.d.ts +333 -0
  28. package/dist/api/core/comment/index.d.ts.map +1 -0
  29. package/dist/api/core/geom/create/index.d.ts +1073 -0
  30. package/dist/api/core/geom/create/index.d.ts.map +1 -0
  31. package/dist/api/core/geom/delete/index.d.ts +78 -0
  32. package/dist/api/core/geom/delete/index.d.ts.map +1 -0
  33. package/dist/api/core/geom/index.d.ts +33 -0
  34. package/dist/api/core/geom/index.d.ts.map +1 -0
  35. package/dist/api/core/geom/query/arc.d.ts +169 -0
  36. package/dist/api/core/geom/query/arc.d.ts.map +1 -0
  37. package/dist/api/core/geom/query/brep.d.ts +514 -0
  38. package/dist/api/core/geom/query/brep.d.ts.map +1 -0
  39. package/dist/api/core/geom/query/circle.d.ts +378 -0
  40. package/dist/api/core/geom/query/circle.d.ts.map +1 -0
  41. package/dist/api/core/geom/query/contour.d.ts +450 -0
  42. package/dist/api/core/geom/query/contour.d.ts.map +1 -0
  43. package/dist/api/core/geom/query/curve.d.ts +918 -0
  44. package/dist/api/core/geom/query/curve.d.ts.map +1 -0
  45. package/dist/api/core/geom/query/edge.d.ts +128 -0
  46. package/dist/api/core/geom/query/edge.d.ts.map +1 -0
  47. package/dist/api/core/geom/query/face.d.ts +363 -0
  48. package/dist/api/core/geom/query/face.d.ts.map +1 -0
  49. package/dist/api/core/geom/query/halfedge.d.ts +206 -0
  50. package/dist/api/core/geom/query/halfedge.d.ts.map +1 -0
  51. package/dist/api/core/geom/query/index.d.ts +61 -0
  52. package/dist/api/core/geom/query/index.d.ts.map +1 -0
  53. package/dist/api/core/geom/query/profile.d.ts +410 -0
  54. package/dist/api/core/geom/query/profile.d.ts.map +1 -0
  55. package/dist/api/core/geom/query/vertex.d.ts +187 -0
  56. package/dist/api/core/geom/query/vertex.d.ts.map +1 -0
  57. package/dist/api/core/geom/update/contour.d.ts +272 -0
  58. package/dist/api/core/geom/update/contour.d.ts.map +1 -0
  59. package/dist/api/core/geom/update/curve.d.ts +180 -0
  60. package/dist/api/core/geom/update/curve.d.ts.map +1 -0
  61. package/dist/api/core/geom/update/index.d.ts +27 -0
  62. package/dist/api/core/geom/update/index.d.ts.map +1 -0
  63. package/dist/api/core/geom/update/profile.d.ts +329 -0
  64. package/dist/api/core/geom/update/profile.d.ts.map +1 -0
  65. package/dist/api/core/groups.d.ts +485 -0
  66. package/dist/api/core/groups.d.ts.map +1 -0
  67. package/dist/api/core/handles/index.d.ts +210 -0
  68. package/dist/api/core/handles/index.d.ts.map +1 -0
  69. package/dist/api/core/history/index.d.ts +78 -0
  70. package/dist/api/core/history/index.d.ts.map +1 -0
  71. package/dist/api/core/index.d.ts +97 -0
  72. package/dist/api/core/index.d.ts.map +1 -0
  73. package/dist/api/core/io/export/index.d.ts +134 -0
  74. package/dist/api/core/io/export/index.d.ts.map +1 -0
  75. package/dist/api/core/io/import/index.d.ts +455 -0
  76. package/dist/api/core/io/import/index.d.ts.map +1 -0
  77. package/dist/api/core/io/index.d.ts +40 -0
  78. package/dist/api/core/io/index.d.ts.map +1 -0
  79. package/dist/api/core/io/job/index.d.ts +139 -0
  80. package/dist/api/core/io/job/index.d.ts.map +1 -0
  81. package/dist/api/core/io/query/index.d.ts +74 -0
  82. package/dist/api/core/io/query/index.d.ts.map +1 -0
  83. package/dist/api/core/io/terrain/index.d.ts +341 -0
  84. package/dist/api/core/io/terrain/index.d.ts.map +1 -0
  85. package/dist/api/core/io/underlay/index.d.ts +805 -0
  86. package/dist/api/core/io/underlay/index.d.ts.map +1 -0
  87. package/dist/api/core/layers.d.ts +402 -0
  88. package/dist/api/core/layers.d.ts.map +1 -0
  89. package/dist/api/core/math/index.d.ts +18 -0
  90. package/dist/api/core/math/index.d.ts.map +1 -0
  91. package/dist/api/core/math/quat.d.ts +170 -0
  92. package/dist/api/core/math/quat.d.ts.map +1 -0
  93. package/dist/api/core/math/vec3.d.ts +174 -0
  94. package/dist/api/core/math/vec3.d.ts.map +1 -0
  95. package/dist/api/core/mode/index.d.ts +111 -0
  96. package/dist/api/core/mode/index.d.ts.map +1 -0
  97. package/dist/api/core/project/index.d.ts +466 -0
  98. package/dist/api/core/project/index.d.ts.map +1 -0
  99. package/dist/api/core/proposals/index.d.ts +531 -0
  100. package/dist/api/core/proposals/index.d.ts.map +1 -0
  101. package/dist/api/core/storeys/index.d.ts +265 -0
  102. package/dist/api/core/storeys/index.d.ts.map +1 -0
  103. package/dist/api/core/tags.d.ts +860 -0
  104. package/dist/api/core/tags.d.ts.map +1 -0
  105. package/dist/api/core/units/index.d.ts +175 -0
  106. package/dist/api/core/units/index.d.ts.map +1 -0
  107. package/dist/api/core/user.d.ts +44 -0
  108. package/dist/api/core/user.d.ts.map +1 -0
  109. package/dist/api/core/zoom/index.d.ts +49 -0
  110. package/dist/api/core/zoom/index.d.ts.map +1 -0
  111. package/dist/api/design/boolean/index.d.ts +168 -0
  112. package/dist/api/design/boolean/index.d.ts.map +1 -0
  113. package/dist/api/design/create/bulk-items.d.ts +185 -0
  114. package/dist/api/design/create/bulk-items.d.ts.map +1 -0
  115. package/dist/api/design/create/grids.d.ts +132 -0
  116. package/dist/api/design/create/grids.d.ts.map +1 -0
  117. package/dist/api/design/create/index.d.ts +1747 -0
  118. package/dist/api/design/create/index.d.ts.map +1 -0
  119. package/dist/api/design/create/opening-fields.d.ts +37 -0
  120. package/dist/api/design/create/opening-fields.d.ts.map +1 -0
  121. package/dist/api/design/delete/index.d.ts +70 -0
  122. package/dist/api/design/delete/index.d.ts.map +1 -0
  123. package/dist/api/design/dimensions.d.ts +427 -0
  124. package/dist/api/design/dimensions.d.ts.map +1 -0
  125. package/dist/api/design/doors/index.d.ts +470 -0
  126. package/dist/api/design/doors/index.d.ts.map +1 -0
  127. package/dist/api/design/edit/index.d.ts +49 -0
  128. package/dist/api/design/edit/index.d.ts.map +1 -0
  129. package/dist/api/design/erase/index.d.ts +160 -0
  130. package/dist/api/design/erase/index.d.ts.map +1 -0
  131. package/dist/api/design/family.d.ts +611 -0
  132. package/dist/api/design/family.d.ts.map +1 -0
  133. package/dist/api/design/furniture/index.d.ts +296 -0
  134. package/dist/api/design/furniture/index.d.ts.map +1 -0
  135. package/dist/api/design/grids.d.ts +237 -0
  136. package/dist/api/design/grids.d.ts.map +1 -0
  137. package/dist/api/design/index.d.ts +260 -0
  138. package/dist/api/design/index.d.ts.map +1 -0
  139. package/dist/api/design/lock.d.ts +67 -0
  140. package/dist/api/design/lock.d.ts.map +1 -0
  141. package/dist/api/design/materials/index.d.ts +551 -0
  142. package/dist/api/design/materials/index.d.ts.map +1 -0
  143. package/dist/api/design/query/geometry/index.d.ts +252 -0
  144. package/dist/api/design/query/geometry/index.d.ts.map +1 -0
  145. package/dist/api/design/query/grids.d.ts +287 -0
  146. package/dist/api/design/query/grids.d.ts.map +1 -0
  147. package/dist/api/design/query/index.d.ts +1318 -0
  148. package/dist/api/design/query/index.d.ts.map +1 -0
  149. package/dist/api/design/query/referenceLines.d.ts +45 -0
  150. package/dist/api/design/query/referenceLines.d.ts.map +1 -0
  151. package/dist/api/design/query/spaces.d.ts +394 -0
  152. package/dist/api/design/query/spaces.d.ts.map +1 -0
  153. package/dist/api/design/selection/index.d.ts +282 -0
  154. package/dist/api/design/selection/index.d.ts.map +1 -0
  155. package/dist/api/design/shared.d.ts +38 -0
  156. package/dist/api/design/shared.d.ts.map +1 -0
  157. package/dist/api/design/transform/index.d.ts +249 -0
  158. package/dist/api/design/transform/index.d.ts.map +1 -0
  159. package/dist/api/design/types/index.d.ts +181 -0
  160. package/dist/api/design/types/index.d.ts.map +1 -0
  161. package/dist/api/design/update/index.d.ts +803 -0
  162. package/dist/api/design/update/index.d.ts.map +1 -0
  163. package/dist/api/design/visibility.d.ts +126 -0
  164. package/dist/api/design/visibility.d.ts.map +1 -0
  165. package/dist/api/design/windows/index.d.ts +300 -0
  166. package/dist/api/design/windows/index.d.ts.map +1 -0
  167. package/dist/api/entity/buildableEnvelope.d.ts +265 -0
  168. package/dist/api/entity/buildableEnvelope.d.ts.map +1 -0
  169. package/dist/api/entity/department.d.ts +1 -0
  170. package/dist/api/entity/department.d.ts.map +1 -0
  171. package/dist/api/entity/index.d.ts +28 -0
  172. package/dist/api/entity/index.d.ts.map +1 -0
  173. package/dist/api/entity/referenceLine.d.ts +210 -0
  174. package/dist/api/entity/referenceLine.d.ts.map +1 -0
  175. package/dist/api/entity/space.d.ts +846 -0
  176. package/dist/api/entity/space.d.ts.map +1 -0
  177. package/dist/api/entity/story.d.ts +476 -0
  178. package/dist/api/entity/story.d.ts.map +1 -0
  179. package/dist/api/index.d.ts +45 -0
  180. package/dist/api/index.d.ts.map +1 -0
  181. package/dist/api/presentation/aiInspiration.d.ts +2400 -0
  182. package/dist/api/presentation/aiInspiration.d.ts.map +1 -0
  183. package/dist/api/presentation/annotate.d.ts +483 -0
  184. package/dist/api/presentation/annotate.d.ts.map +1 -0
  185. package/dist/api/presentation/diagrams.d.ts +184 -0
  186. package/dist/api/presentation/diagrams.d.ts.map +1 -0
  187. package/dist/api/presentation/drawings.d.ts +2900 -0
  188. package/dist/api/presentation/drawings.d.ts.map +1 -0
  189. package/dist/api/presentation/export.d.ts +126 -0
  190. package/dist/api/presentation/export.d.ts.map +1 -0
  191. package/dist/api/presentation/import.d.ts +164 -0
  192. package/dist/api/presentation/import.d.ts.map +1 -0
  193. package/dist/api/presentation/index.d.ts +114 -0
  194. package/dist/api/presentation/index.d.ts.map +1 -0
  195. package/dist/api/presentation/placedViews.d.ts +1232 -0
  196. package/dist/api/presentation/placedViews.d.ts.map +1 -0
  197. package/dist/api/presentation/shapes.d.ts +481 -0
  198. package/dist/api/presentation/shapes.d.ts.map +1 -0
  199. package/dist/api/presentation/sheets.d.ts +643 -0
  200. package/dist/api/presentation/sheets.d.ts.map +1 -0
  201. package/dist/api/presentation/slideshow.d.ts +125 -0
  202. package/dist/api/presentation/slideshow.d.ts.map +1 -0
  203. package/dist/api/presentation/tables.d.ts +81 -0
  204. package/dist/api/presentation/tables.d.ts.map +1 -0
  205. package/dist/api/presentation/viewPresets.d.ts +70 -0
  206. package/dist/api/presentation/viewPresets.d.ts.map +1 -0
  207. package/dist/api/presentation/views.d.ts +741 -0
  208. package/dist/api/presentation/views.d.ts.map +1 -0
  209. package/dist/api/program/adjacency.d.ts +155 -0
  210. package/dist/api/program/adjacency.d.ts.map +1 -0
  211. package/dist/api/program/areas.d.ts +450 -0
  212. package/dist/api/program/areas.d.ts.map +1 -0
  213. package/dist/api/program/classification.d.ts +135 -0
  214. package/dist/api/program/classification.d.ts.map +1 -0
  215. package/dist/api/program/cores.d.ts +78 -0
  216. package/dist/api/program/cores.d.ts.map +1 -0
  217. package/dist/api/program/departments.d.ts +487 -0
  218. package/dist/api/program/departments.d.ts.map +1 -0
  219. package/dist/api/program/index.d.ts +71 -0
  220. package/dist/api/program/index.d.ts.map +1 -0
  221. package/dist/api/program/labels.d.ts +355 -0
  222. package/dist/api/program/labels.d.ts.map +1 -0
  223. package/dist/api/program/layout.d.ts +398 -0
  224. package/dist/api/program/layout.d.ts.map +1 -0
  225. package/dist/api/program/metadata.d.ts +328 -0
  226. package/dist/api/program/metadata.d.ts.map +1 -0
  227. package/dist/api/program/metrics.d.ts +108 -0
  228. package/dist/api/program/metrics.d.ts.map +1 -0
  229. package/dist/api/program/site.d.ts +823 -0
  230. package/dist/api/program/site.d.ts.map +1 -0
  231. package/dist/api/program/spreadsheet.d.ts +2628 -0
  232. package/dist/api/program/spreadsheet.d.ts.map +1 -0
  233. package/dist/api/workspace/index.d.ts +552 -0
  234. package/dist/api/workspace/index.d.ts.map +1 -0
  235. package/dist/errors/codes.d.ts +34 -0
  236. package/dist/errors/codes.d.ts.map +1 -0
  237. package/dist/errors/envelope.d.ts +56 -0
  238. package/dist/errors/envelope.d.ts.map +1 -0
  239. package/dist/errors/index.d.ts +6 -0
  240. package/dist/errors/index.d.ts.map +1 -0
  241. package/dist/errors/plugin-error.d.ts +69 -0
  242. package/dist/errors/plugin-error.d.ts.map +1 -0
  243. package/dist/handles.d.ts +229 -0
  244. package/dist/handles.d.ts.map +1 -0
  245. package/dist/host-utils.d.ts +47 -0
  246. package/dist/host-utils.d.ts.map +1 -0
  247. package/dist/index.cjs +8836 -0
  248. package/dist/index.cjs.map +1 -0
  249. package/dist/index.d.ts +6 -0
  250. package/dist/index.d.ts.map +1 -0
  251. package/dist/index.js +7568 -0
  252. package/dist/index.js.map +1 -0
  253. package/dist/types.d.ts +16 -0
  254. package/dist/types.d.ts.map +1 -0
  255. package/package.json +41 -0
  256. package/scripts/generate-manifest.mjs +238 -0
  257. package/scripts/generate-manifest.test.mjs +292 -0
  258. package/src/api/analysis/daylight.ts +470 -0
  259. package/src/api/analysis/heatmaps.ts +683 -0
  260. package/src/api/analysis/illuminance.ts +155 -0
  261. package/src/api/analysis/index.ts +61 -0
  262. package/src/api/analysis/shadows.ts +183 -0
  263. package/src/api/analysis/solar.ts +237 -0
  264. package/src/api/analysis/sunlightHours.ts +211 -0
  265. package/src/api/analysis/sunpath.ts +83 -0
  266. package/src/api/analysis/weather.ts +179 -0
  267. package/src/api/core/buildings.ts +485 -0
  268. package/src/api/core/camera/index.ts +268 -0
  269. package/src/api/core/comment/index.ts +376 -0
  270. package/src/api/core/geom/create/index.ts +1204 -0
  271. package/src/api/core/geom/delete/index.ts +84 -0
  272. package/src/api/core/geom/index.ts +35 -0
  273. package/src/api/core/geom/query/arc.ts +169 -0
  274. package/src/api/core/geom/query/brep.ts +563 -0
  275. package/src/api/core/geom/query/circle.ts +404 -0
  276. package/src/api/core/geom/query/contour.ts +540 -0
  277. package/src/api/core/geom/query/curve.ts +1078 -0
  278. package/src/api/core/geom/query/edge.ts +130 -0
  279. package/src/api/core/geom/query/face.ts +403 -0
  280. package/src/api/core/geom/query/halfedge.ts +210 -0
  281. package/src/api/core/geom/query/index.ts +63 -0
  282. package/src/api/core/geom/query/profile.ts +473 -0
  283. package/src/api/core/geom/query/vertex.ts +205 -0
  284. package/src/api/core/geom/update/contour.ts +315 -0
  285. package/src/api/core/geom/update/curve.ts +209 -0
  286. package/src/api/core/geom/update/index.ts +29 -0
  287. package/src/api/core/geom/update/profile.ts +377 -0
  288. package/src/api/core/groups.ts +521 -0
  289. package/src/api/core/handles/index.ts +233 -0
  290. package/src/api/core/history/index.ts +84 -0
  291. package/src/api/core/index.ts +99 -0
  292. package/src/api/core/io/export/index.ts +126 -0
  293. package/src/api/core/io/import/index.ts +504 -0
  294. package/src/api/core/io/index.ts +42 -0
  295. package/src/api/core/io/job/index.ts +140 -0
  296. package/src/api/core/io/query/index.ts +71 -0
  297. package/src/api/core/io/terrain/index.ts +360 -0
  298. package/src/api/core/io/underlay/index.ts +705 -0
  299. package/src/api/core/layers.ts +333 -0
  300. package/src/api/core/math/index.ts +20 -0
  301. package/src/api/core/math/quat.ts +172 -0
  302. package/src/api/core/math/vec3.ts +179 -0
  303. package/src/api/core/mode/index.ts +108 -0
  304. package/src/api/core/project/index.ts +479 -0
  305. package/src/api/core/proposals/index.ts +569 -0
  306. package/src/api/core/storeys/index.ts +294 -0
  307. package/src/api/core/tags.ts +911 -0
  308. package/src/api/core/units/index.ts +164 -0
  309. package/src/api/core/user.ts +46 -0
  310. package/src/api/core/zoom/index.ts +51 -0
  311. package/src/api/design/boolean/index.ts +179 -0
  312. package/src/api/design/create/bulk-items.ts +186 -0
  313. package/src/api/design/create/grids.ts +137 -0
  314. package/src/api/design/create/index.ts +1954 -0
  315. package/src/api/design/create/opening-fields.ts +37 -0
  316. package/src/api/design/delete/index.ts +74 -0
  317. package/src/api/design/dimensions.ts +453 -0
  318. package/src/api/design/doors/index.ts +500 -0
  319. package/src/api/design/edit/index.ts +54 -0
  320. package/src/api/design/erase/index.ts +151 -0
  321. package/src/api/design/family.ts +646 -0
  322. package/src/api/design/furniture/index.ts +319 -0
  323. package/src/api/design/grids.ts +237 -0
  324. package/src/api/design/index.ts +274 -0
  325. package/src/api/design/lock.ts +69 -0
  326. package/src/api/design/materials/index.ts +608 -0
  327. package/src/api/design/query/geometry/index.ts +288 -0
  328. package/src/api/design/query/grids.ts +197 -0
  329. package/src/api/design/query/index.ts +1176 -0
  330. package/src/api/design/query/referenceLines.ts +52 -0
  331. package/src/api/design/query/spaces.ts +275 -0
  332. package/src/api/design/selection/index.ts +273 -0
  333. package/src/api/design/shared.ts +40 -0
  334. package/src/api/design/transform/index.ts +254 -0
  335. package/src/api/design/types/index.ts +156 -0
  336. package/src/api/design/update/index.ts +798 -0
  337. package/src/api/design/visibility.ts +143 -0
  338. package/src/api/design/windows/index.ts +333 -0
  339. package/src/api/entity/buildableEnvelope.ts +322 -0
  340. package/src/api/entity/department.ts +0 -0
  341. package/src/api/entity/index.ts +30 -0
  342. package/src/api/entity/referenceLine.ts +235 -0
  343. package/src/api/entity/space.ts +612 -0
  344. package/src/api/entity/story.ts +517 -0
  345. package/src/api/index.ts +47 -0
  346. package/src/api/presentation/aiInspiration.ts +1116 -0
  347. package/src/api/presentation/annotate.ts +417 -0
  348. package/src/api/presentation/diagrams.ts +194 -0
  349. package/src/api/presentation/drawings.ts +529 -0
  350. package/src/api/presentation/export.ts +133 -0
  351. package/src/api/presentation/import.ts +159 -0
  352. package/src/api/presentation/index.ts +129 -0
  353. package/src/api/presentation/placedViews.ts +1203 -0
  354. package/src/api/presentation/shapes.ts +274 -0
  355. package/src/api/presentation/sheets.ts +616 -0
  356. package/src/api/presentation/slideshow.ts +134 -0
  357. package/src/api/presentation/tables.ts +84 -0
  358. package/src/api/presentation/viewPresets.ts +83 -0
  359. package/src/api/presentation/views.ts +698 -0
  360. package/src/api/program/adjacency.ts +164 -0
  361. package/src/api/program/areas.ts +408 -0
  362. package/src/api/program/classification.ts +138 -0
  363. package/src/api/program/cores.ts +83 -0
  364. package/src/api/program/departments.ts +517 -0
  365. package/src/api/program/index.ts +73 -0
  366. package/src/api/program/labels.ts +332 -0
  367. package/src/api/program/layout.ts +422 -0
  368. package/src/api/program/metadata.ts +364 -0
  369. package/src/api/program/metrics.ts +120 -0
  370. package/src/api/program/site.ts +748 -0
  371. package/src/api/program/spreadsheet.ts +2698 -0
  372. package/src/api/workspace/index.ts +612 -0
  373. package/src/errors/codes.ts +136 -0
  374. package/src/errors/envelope.ts +75 -0
  375. package/src/errors/index.ts +21 -0
  376. package/src/errors/plugin-error.ts +134 -0
  377. package/src/handles.ts +282 -0
  378. package/src/host-utils.ts +68 -0
  379. package/src/index.ts +5 -0
  380. package/src/types.ts +16 -0
  381. package/test/errors.test.mjs +184 -0
  382. package/tsconfig.json +22 -0
  383. package/tsup.config.ts +12 -0
@@ -0,0 +1,37 @@
1
+ import * as z from "zod"
2
+ import { ComponentHandle, Vec3Handle } from "../../../handles"
3
+
4
+ /**
5
+ * The shared field bag every hosted opening (door / window) carries — used by
6
+ * {@linkcode PluginDesignCreateOpeningOptions} and by the bulk item schemas in
7
+ * `bulk-items.ts`, so singular and plural openings validate identically.
8
+ *
9
+ * `facing` and `hinge` are WORLD POINTS, not directions: `facing` sits on the
10
+ * side of the wall the leaf swings open to (where the plan symbol draws the
11
+ * swing arc); `hinge` sits near the jamb the leaf is hinged on — the item is
12
+ * reflected along the wall so its hinged jamb is the one nearer that point.
13
+ * Either may be omitted (engine-chosen side / the catalog item's authored
14
+ * hinge side). Neither has a visible effect on symmetric items such as
15
+ * sliders or fixed windows.
16
+ *
17
+ * | Property | Type | Description |
18
+ * |---|---|---|
19
+ * | `catalogId` | `string` | Library id: team `_id` or general `fullName` |
20
+ * | `hostWall` | {@linkcode ComponentHandle} | The wall to host the opening |
21
+ * | `position` | {@linkcode Vec3Handle} | World point projected onto the wall |
22
+ * | `facing` | {@linkcode Vec3Handle}? | World point on the side of the wall the opening swings open to (default engine-chosen) |
23
+ * | `hinge` | {@linkcode Vec3Handle}? | World point near the jamb the opening is hinged on (default the catalog item's authored side) |
24
+ * | `label` | `string`? | Instance name (optional) |
25
+ * | `width` | `number`? | Width override (Snaptrude units, > 0; default the catalog item's) |
26
+ * | `height` | `number`? | Height override (Snaptrude units, > 0; default the catalog item's) |
27
+ */
28
+ export const PluginOpeningBaseOptions = {
29
+ catalogId: z.string().min(1),
30
+ hostWall: ComponentHandle,
31
+ position: Vec3Handle,
32
+ facing: Vec3Handle.optional(),
33
+ hinge: Vec3Handle.optional(),
34
+ label: z.string().optional(),
35
+ width: z.number().finite().positive().optional(),
36
+ height: z.number().finite().positive().optional(),
37
+ }
@@ -0,0 +1,74 @@
1
+ import * as z from "zod"
2
+ import { PluginApiReturn } from "../../../types"
3
+ import { ComponentHandle } from "../../../handles"
4
+ import { PluginDesignChangeResult } from "../lock"
5
+
6
+ /**
7
+ * Arguments for {@linkcode PluginDesignDeleteApi.entities}.
8
+ *
9
+ * | Property | Type | Description |
10
+ * |---|---|---|
11
+ * | `components` | {@linkcode ComponentHandle}`[]` | Entities to delete. Unknown/forged handles reject the whole call (fail-fast). |
12
+ *
13
+ * `.min(1)` is deliberately stricter than the shipped `PluginDesignLockArgs`
14
+ * (which allows an empty array) — an empty delete is a caller error, not a no-op.
15
+ *
16
+ * TRANSPORT: positional args — validated host-side as `{ components }`.
17
+ */
18
+ export const PluginDesignDeleteEntitiesArgs = z.object({
19
+ components: z.array(ComponentHandle).min(1),
20
+ })
21
+ export type PluginDesignDeleteEntitiesArgs = z.infer<typeof PluginDesignDeleteEntitiesArgs>
22
+
23
+ /**
24
+ * `snaptrude.design.delete.*` — **hard removal** of scene BIM entities.
25
+ *
26
+ * This is hard entity delete — distinct from `design.erase.edge` (a plan-level
27
+ * adjacency-edge topology op) and `design.boolean.subtract` (a CSG geometry
28
+ * delete). The constitution forbids `erase`/`clear`/`remove` as synonyms for
29
+ * `delete`; these are three separate operations.
30
+ *
31
+ * TRANSPORT: positional args per method.
32
+ */
33
+ export abstract class PluginDesignDeleteApi {
34
+ constructor() {}
35
+
36
+ /**
37
+ * Delete one or more entities. Generic hard delete (backed by the same batched,
38
+ * undoable path as `entity.space.delete`). Cascade is opinionated by the engine:
39
+ * children are removed and linked-list neighbours are fixed up — not caller-tunable
40
+ * in v1. Undoable — commits as a **single** undo entry.
41
+ *
42
+ * Dimension lines anchored to a deleted entity are removed with it, in the same undo
43
+ * entry, exactly as the editor's Delete key does — see `design.dimensions`. They are
44
+ * NOT listed in `affected`, which reports component handles only.
45
+ *
46
+ * @param components - Entities to delete. Unknown/forged handles reject the whole call (fail-fast).
47
+ * @returns The entities that were deleted, as {@linkcode ComponentHandle}`[]`
48
+ * (echoed host-side from the resolved+deleted set — the engine returns no ids).
49
+ * Deleted handles are **stale** afterwards: re-resolving one throws `HANDLE_INVALID`.
50
+ * @throws If any supplied handle is unknown/forged (`HANDLE_INVALID`) — the whole
51
+ * call rejects before anything is deleted (all-or-nothing resolution).
52
+ *
53
+ * @examplePrompt Delete the selected objects
54
+ * @examplePrompt Remove these walls from the model
55
+ * @examplePrompt Get rid of this mass entirely
56
+ * @examplePrompt Delete all the furniture I picked
57
+ * @examplePrompt Remove the door and window I just created
58
+ *
59
+ * @performance Array delete — pass every target in one call (one host round-trip). There is
60
+ * no per-item delete; collect the whole set and never loop this per entity.
61
+ *
62
+ * # Example
63
+ * ```ts
64
+ * // Hard-delete every furniture item on storey 2 (a single undo entry)
65
+ * const furniture = await snaptrude.design.query.listFurniture({ storeys: [2] })
66
+ * if (furniture.length > 0) {
67
+ * const { affected } = await snaptrude.design.delete.entities(furniture)
68
+ * }
69
+ * ```
70
+ */
71
+ public abstract entities(
72
+ components: ComponentHandle[],
73
+ ): PluginApiReturn<PluginDesignChangeResult>
74
+ }
@@ -0,0 +1,453 @@
1
+ import * as z from "zod"
2
+ import { PluginApiReturn } from "../../types"
3
+ import {
4
+ ComponentHandle,
5
+ DimensionHandle,
6
+ Vec3Components,
7
+ Vec3Handle,
8
+ } from "../../handles"
9
+
10
+ /**
11
+ * Dimension lines (Measuring Tape) — the measurement annotations the Measuring
12
+ * Tape tool leaves in the 3D scene, NOT an entity's width/height/depth
13
+ * properties (for those see `design.windows.getDimensions`,
14
+ * `design.create.staircase`'s `dimensions`, or `design.query.measure`).
15
+ *
16
+ * A dimension line is a scene object: two endpoints anchored to the geometry
17
+ * they were measured on, an offset that pushes the drawn line clear of the
18
+ * span, and a label showing the distance in the project's units. Because the
19
+ * endpoints are anchored, the line follows its host when the host is moved,
20
+ * edited, or resized, and it is removed with the host when the host is deleted.
21
+ * Dimension lines are storey-scoped, render in both plan and 3D, and are drawn
22
+ * into Present-mode sheets (style them with
23
+ * `presentation.placedViews.updateStyles(shapeId, "Dimension", …)`).
24
+ *
25
+ * **Units.** Every length here — `offset` and the record's `length` — is in
26
+ * **Babylon units** (BU), the engine's storage unit: 1 BU = 10 in = 0.254 m.
27
+ * Convert with `core.units.convert(value, from, await core.units.getBabylonType())`.
28
+ *
29
+ * **Offset convention.** `options.offset` is a **signed** distance in BU:
30
+ * positive pushes the drawn line to the **left** of the `from` → `to`
31
+ * direction in plan (`cross(up, direction)`), negative to the right. It
32
+ * defaults to `3.937` BU (1 m). The placement mode is always `"across"` (the
33
+ * tape tool's perpendicular mode), which re-perpendicularises when the host
34
+ * geometry is edited.
35
+ *
36
+ * Every mutator here (`create`, `delete`, `hide`, `show`) commits through the
37
+ * engine's command manager, so each call is a single undo entry, is autosaved,
38
+ * and replays to collaborators.
39
+ *
40
+ * Accessed via `snaptrude.design.dimensions`.
41
+ */
42
+ export abstract class PluginDesignDimensionsApi {
43
+ constructor() {}
44
+
45
+ /**
46
+ * Draw one dimension line between two world points, anchored to a component.
47
+ *
48
+ * `anchor` is **required**: the endpoints are stored relative to the anchor's
49
+ * mesh, and only component-anchored dimension lines survive a reload. A
50
+ * free-point dimension anchors to a scene helper mesh whose id is not stable
51
+ * across reloads, so it is dropped or corrupted when the project is reopened
52
+ * — the host therefore rejects a non-component anchor rather than writing a
53
+ * record that silently disappears. Pass `options.anchorTo` to anchor the
54
+ * second endpoint to a different component (it defaults to `anchor`).
55
+ *
56
+ * The dimension is created flat (never plan-projected) so the same call
57
+ * produces the same record whatever the current camera; it still draws in
58
+ * plan.
59
+ *
60
+ * @param from - World-space first endpoint.
61
+ * @param to - World-space second endpoint.
62
+ * @param anchor - The component the first endpoint is anchored to (required).
63
+ * @param options - `anchorTo` (component for the second endpoint; defaults to
64
+ * `anchor`), `offset` (signed perpendicular offset in Babylon units,
65
+ * positive = left of the `from` → `to` direction in plan; default `3.937`
66
+ * BU = 1 m).
67
+ * @returns The new dimension line's {@linkcode DimensionHandle}.
68
+ * @throws `VALIDATION` for malformed arguments or a degenerate span (`from`
69
+ * and `to` closer than the engine's minimum); `HANDLE_INVALID` for an
70
+ * unknown `anchor` / `anchorTo`; `PRECONDITION_FAILED` when the anchor is
71
+ * outside the active proposal or the editor is not mounted;
72
+ * `METHOD_NOT_PERMITTED` when plugin writes are disabled.
73
+ *
74
+ * @examplePrompt Dimension every wall on level 2
75
+ * @examplePrompt Add a dimension line along this wall
76
+ * @examplePrompt Measure the width of this room and label it on the plan
77
+ *
78
+ * # Example
79
+ * ```ts
80
+ * const { design, core } = snaptrude
81
+ * const v = core.math.vec3
82
+ * const curve = core.geom.query.curve
83
+ * for (const wall of await design.query.listWalls({ storeys: [2] })) {
84
+ * const cl = await design.query.geometry.getCenterline(wall)
85
+ * if (!cl) continue
86
+ * const a = await curve.getStartPoint(cl)
87
+ * const b = await curve.getEndPoint(cl)
88
+ * await design.dimensions.create(
89
+ * await v.new(a.x, a.y, a.z),
90
+ * await v.new(b.x, b.y, b.z),
91
+ * wall,
92
+ * )
93
+ * }
94
+ * ```
95
+ */
96
+ public abstract create(
97
+ from: Vec3Handle,
98
+ to: Vec3Handle,
99
+ anchor: ComponentHandle,
100
+ options?: { anchorTo?: ComponentHandle; offset?: number },
101
+ ): PluginApiReturn<DimensionHandle>
102
+
103
+ /**
104
+ * List the dimension lines in the project as full records.
105
+ *
106
+ * Filters combine with AND. `storeys` keeps only the dimensions on those
107
+ * storey numbers, `anchors` only the ones anchored to those components
108
+ * (matching either endpoint, and matching an instanced anchor's source mesh
109
+ * too), `isHidden` only the ones whose user Hide flag equals the value given.
110
+ *
111
+ * Dimension lines drawn by the Measuring Tape onto a scene helper mesh rather
112
+ * than a component come back with `anchor: null` and are not proposal-scoped.
113
+ *
114
+ * @param options - `storeys`, `anchors`, `isHidden` filters (all optional,
115
+ * ANDed).
116
+ * @returns The matching {@linkcode PluginDimensionLine} records (`[]` when
117
+ * nothing matches).
118
+ * @throws `VALIDATION` for malformed filters; `HANDLE_INVALID` for an unknown
119
+ * handle in `anchors`.
120
+ *
121
+ * @examplePrompt List all the dimension lines in this model
122
+ * @examplePrompt Which dimensions are on level 3?
123
+ * @examplePrompt Flag any dimension line shorter than 600 mm
124
+ *
125
+ * @performance Array read — one host round-trip returns every record. Filter
126
+ * in one call rather than calling `get` per dimension.
127
+ *
128
+ * # Example
129
+ * ```ts
130
+ * const units = snaptrude.core.units
131
+ * const min = await units.convert(600, "millimeters", await units.getBabylonType())
132
+ * const short = (await snaptrude.design.dimensions.list()).filter(
133
+ * (d) => d.length < min,
134
+ * )
135
+ * console.log(short.map((d) => `${d.label} on storey ${d.storey}`))
136
+ * ```
137
+ */
138
+ public abstract list(options?: {
139
+ storeys?: number[]
140
+ anchors?: ComponentHandle[]
141
+ isHidden?: boolean
142
+ }): PluginApiReturn<PluginDimensionLine[]>
143
+
144
+ /**
145
+ * Read one dimension line by handle.
146
+ *
147
+ * Returns `null` — rather than throwing — when the dimension no longer
148
+ * exists, so a handle kept across a delete or an undo can be polled safely.
149
+ *
150
+ * @param dimension - The dimension line to read.
151
+ * @returns Its {@linkcode PluginDimensionLine} record, or `null` if it is
152
+ * gone.
153
+ * @throws `VALIDATION` if `dimension` is not a non-empty id string.
154
+ *
155
+ * @examplePrompt Read the dimension line I just created
156
+ * @examplePrompt How long is this dimension and what does its label say?
157
+ * @examplePrompt Check whether that dimension line still exists
158
+ *
159
+ * # Example
160
+ * ```ts
161
+ * const dim = await snaptrude.design.dimensions.get(handle)
162
+ * if (dim) console.log(dim.label, dim.length, dim.storey)
163
+ * ```
164
+ */
165
+ public abstract get(
166
+ dimension: DimensionHandle,
167
+ ): PluginApiReturn<PluginDimensionLine | null>
168
+
169
+ /**
170
+ * Delete dimension lines — the same hard removal as selecting them and
171
+ * pressing Delete. Undoable as a **single** entry for the whole batch.
172
+ *
173
+ * Deleted handles are stale afterwards: {@linkcode
174
+ * PluginDesignDimensionsApi.get} returns `null` for them and the other
175
+ * mutators throw `HANDLE_INVALID`.
176
+ *
177
+ * @param dimensions - The dimension lines to delete (at least one — an empty
178
+ * array is a caller error, not a no-op).
179
+ * @returns The dimensions that were deleted, as
180
+ * {@linkcode PluginDimensionsChangeResult}.
181
+ * @throws `VALIDATION` for an empty or malformed array; `HANDLE_INVALID` if
182
+ * any handle is unknown (the whole call rejects before anything is
183
+ * deleted); `PRECONDITION_FAILED` if any dimension's anchor is outside the
184
+ * active proposal; `METHOD_NOT_PERMITTED` when plugin writes are disabled.
185
+ *
186
+ * @examplePrompt Remove all dimension lines
187
+ * @examplePrompt Delete the dimensions on this wall
188
+ * @examplePrompt Clear the measurements I added to level 2
189
+ *
190
+ * @performance Array API — pass the whole set in one call (one host
191
+ * round-trip, one undo entry). Never loop this per dimension.
192
+ *
193
+ * # Example
194
+ * ```ts
195
+ * const dims = snaptrude.design.dimensions
196
+ * const onWall = await dims.list({ anchors: [wall] })
197
+ * if (onWall.length > 0) await dims.delete(onWall.map((d) => d.id))
198
+ * ```
199
+ */
200
+ public abstract delete(
201
+ dimensions: DimensionHandle[],
202
+ ): PluginApiReturn<PluginDimensionsChangeResult>
203
+
204
+ /**
205
+ * Hide dimension lines from the viewport — the same as the right-click "Hide"
206
+ * action (it sets the user Hide flag, `isHidden`). Undoable. Already-hidden
207
+ * dimensions are skipped and are not reported in `affected`.
208
+ *
209
+ * @param dimensions - The dimension lines to hide.
210
+ * @returns The dimensions actually hidden, as
211
+ * {@linkcode PluginDimensionsChangeResult} — already-hidden inputs are
212
+ * omitted, so `affected` can be shorter than the input.
213
+ * @throws `VALIDATION` for a malformed array; `HANDLE_INVALID` if any handle
214
+ * is unknown; `PRECONDITION_FAILED` if any dimension's anchor is outside
215
+ * the active proposal; `METHOD_NOT_PERMITTED` when plugin writes are
216
+ * disabled.
217
+ *
218
+ * @examplePrompt Hide the dimensions on this storey
219
+ * @examplePrompt Hide every dimension line while I present
220
+ * @examplePrompt Temporarily hide the measurements on level 3
221
+ *
222
+ * @performance Array API — one host round-trip and one undo entry for the
223
+ * whole set.
224
+ *
225
+ * # Example
226
+ * ```ts
227
+ * const dims = snaptrude.design.dimensions
228
+ * const onLevel3 = await dims.list({ storeys: [3] })
229
+ * const { affected } = await dims.hide(onLevel3.map((d) => d.id))
230
+ * ```
231
+ */
232
+ public abstract hide(
233
+ dimensions: DimensionHandle[],
234
+ ): PluginApiReturn<PluginDimensionsChangeResult>
235
+
236
+ /**
237
+ * Reveal hidden dimension lines — clear the user Hide flag, the inverse of
238
+ * {@linkcode PluginDesignDimensionsApi.hide}. Undoable. Already-visible
239
+ * dimensions are skipped and are not reported in `affected`.
240
+ *
241
+ * Clearing the flag does not guarantee the dimension is on screen: a
242
+ * dimension whose anchor component is itself hidden stays off screen with
243
+ * `isHidden: false` and `isVisible: false`.
244
+ *
245
+ * @param dimensions - The dimension lines to reveal.
246
+ * @returns The dimensions actually revealed, as
247
+ * {@linkcode PluginDimensionsChangeResult} — already-visible inputs are
248
+ * omitted, so `affected` can be shorter than the input.
249
+ * @throws `VALIDATION` for a malformed array; `HANDLE_INVALID` if any handle
250
+ * is unknown; `PRECONDITION_FAILED` if any dimension's anchor is outside
251
+ * the active proposal; `METHOD_NOT_PERMITTED` when plugin writes are
252
+ * disabled.
253
+ *
254
+ * @examplePrompt Show the dimension lines again
255
+ * @examplePrompt Unhide all the hidden dimensions
256
+ * @examplePrompt Bring back the measurements I hid on this storey
257
+ *
258
+ * @performance Array API — one host round-trip and one undo entry for the
259
+ * whole set.
260
+ *
261
+ * # Example
262
+ * ```ts
263
+ * const dims = snaptrude.design.dimensions
264
+ * const hidden = await dims.list({ isHidden: true })
265
+ * await dims.show(hidden.map((d) => d.id))
266
+ * ```
267
+ */
268
+ public abstract show(
269
+ dimensions: DimensionHandle[],
270
+ ): PluginApiReturn<PluginDimensionsChangeResult>
271
+ }
272
+
273
+ /**
274
+ * How a dimension line's drawn offset is constrained.
275
+ *
276
+ * - `"across"` — perpendicular to the span (the tape tool's default, and what
277
+ * every plugin-created dimension uses); re-perpendicularises when the host
278
+ * geometry is edited.
279
+ * - `"x"` / `"y"` / `"z"` — the offset is locked to that world axis.
280
+ * - `"none"` — no placement mode recorded (a plain world-space offset).
281
+ */
282
+ export const PluginDimensionPlacement = z.enum([
283
+ "across",
284
+ "x",
285
+ "y",
286
+ "z",
287
+ "none",
288
+ ])
289
+ export type PluginDimensionPlacement = z.infer<typeof PluginDimensionPlacement>
290
+
291
+ /**
292
+ * One dimension line (Measuring Tape annotation). Lengths are in **Babylon
293
+ * units** (1 BU = 0.254 m — convert with `core.units.convert`).
294
+ *
295
+ * | Property | Type | Description |
296
+ * |---|---|---|
297
+ * | `id` | {@linkcode DimensionHandle} | The dimension line's handle |
298
+ * | `from` | {@linkcode Vec3Components} | Live world position of the first endpoint |
299
+ * | `to` | {@linkcode Vec3Components} | Live world position of the second endpoint |
300
+ * | `length` | `number` | Straight-line distance between `from` and `to`, in Babylon units |
301
+ * | `label` | `string` | The text drawn on the canvas, in the project's units (a bare number for metric/inch projects, `27' 7"` style for feet-inches). For a span whose x, y and z all differ the drawn line is the plan projection, so `label` reads the horizontal distance while `length` is the true 3D one |
302
+ * | `offset` | {@linkcode Vec3Components} | World vector from the measured span to the drawn line |
303
+ * | `placement` | {@linkcode PluginDimensionPlacement} | How that offset is constrained |
304
+ * | `anchor` | {@linkcode ComponentHandle}` \| null` | Component the first endpoint is anchored to; `null` for a free point or a non-component host mesh |
305
+ * | `anchorTo` | {@linkcode ComponentHandle}` \| null` | Component the second endpoint is anchored to; equals `anchor` when both endpoints share a host |
306
+ * | `storey` | `number` | Storey the dimension belongs to |
307
+ * | `buildingId` | `string \| null` | Building it belongs to, when it has one |
308
+ * | `isHidden` | `boolean` | The user Hide flag (what `hide` / `show` toggle) |
309
+ * | `isVisible` | `boolean` | Whether it is actually drawn — `false` when hidden, and also when an anchor component is hidden |
310
+ * | `isPlanProjected` | `boolean` | Whether it is drawn flattened onto the storey base (Measuring Tape dimensions drawn in 2D are; plugin-created ones never are) |
311
+ */
312
+ export const PluginDimensionLine = z.object({
313
+ id: DimensionHandle,
314
+ from: Vec3Components,
315
+ to: Vec3Components,
316
+ length: z.number(),
317
+ label: z.string(),
318
+ offset: Vec3Components,
319
+ placement: PluginDimensionPlacement,
320
+ anchor: ComponentHandle.nullable(),
321
+ anchorTo: ComponentHandle.nullable(),
322
+ storey: z.number(),
323
+ buildingId: z.string().nullable(),
324
+ isHidden: z.boolean(),
325
+ isVisible: z.boolean(),
326
+ isPlanProjected: z.boolean(),
327
+ })
328
+ export type PluginDimensionLine = z.infer<typeof PluginDimensionLine>
329
+
330
+ /**
331
+ * Result of every `design.dimensions` mutation that takes a batch
332
+ * ({@linkcode PluginDesignDimensionsApi.delete} /
333
+ * {@linkcode PluginDesignDimensionsApi.hide} /
334
+ * {@linkcode PluginDesignDimensionsApi.show}) — the dimensions actually
335
+ * affected. `hide` / `show` skip dimensions already in the target state, so
336
+ * `affected` can be shorter than the input; `delete` echoes the whole batch.
337
+ * Failures throw (the RPC rejects); there is no `Result<>` monad in the SDK.
338
+ *
339
+ * | Property | Type | Description |
340
+ * |---|---|---|
341
+ * | `affected` | {@linkcode DimensionHandle}`[]` | The dimension lines the call changed |
342
+ */
343
+ export const PluginDimensionsChangeResult = z.object({
344
+ affected: z.array(DimensionHandle),
345
+ })
346
+ export type PluginDimensionsChangeResult = z.infer<
347
+ typeof PluginDimensionsChangeResult
348
+ >
349
+
350
+ /**
351
+ * Arguments for {@linkcode PluginDesignDimensionsApi.create} (options
352
+ * flattened).
353
+ *
354
+ * | Property | Type | Description |
355
+ * |---|---|---|
356
+ * | `from` | {@linkcode Vec3Handle} | World-space first endpoint |
357
+ * | `to` | {@linkcode Vec3Handle} | World-space second endpoint |
358
+ * | `anchor` | {@linkcode ComponentHandle} | Component the first endpoint anchors to (required — free-point dimensions do not survive a reload) |
359
+ * | `anchorTo` | {@linkcode ComponentHandle}? | Component for the second endpoint (default: `anchor`) |
360
+ * | `offset` | `number`? | Signed perpendicular offset in Babylon units, positive = left of the `from` → `to` direction in plan (default `3.937` BU = 1 m) |
361
+ *
362
+ * TRANSPORT: positional args — validated host-side as this object.
363
+ */
364
+ export const PluginDesignDimensionsCreateArgs = z.object({
365
+ from: Vec3Handle,
366
+ to: Vec3Handle,
367
+ anchor: ComponentHandle,
368
+ anchorTo: ComponentHandle.optional(),
369
+ offset: z.number().finite().optional(),
370
+ })
371
+ export type PluginDesignDimensionsCreateArgs = z.infer<
372
+ typeof PluginDesignDimensionsCreateArgs
373
+ >
374
+
375
+ /**
376
+ * Arguments for {@linkcode PluginDesignDimensionsApi.list} (options flattened).
377
+ * Filters combine with AND; omitting all of them lists every dimension line.
378
+ *
379
+ * | Property | Type | Description |
380
+ * |---|---|---|
381
+ * | `storeys` | `number[]`? | Only dimensions on these storey numbers |
382
+ * | `anchors` | {@linkcode ComponentHandle}`[]`? | Only dimensions anchored to these components (either endpoint) |
383
+ * | `isHidden` | `boolean`? | user-hidden flag === |
384
+ */
385
+ export const PluginDesignDimensionsListArgs = z.object({
386
+ storeys: z.array(z.number()).optional(),
387
+ anchors: z.array(ComponentHandle).optional(),
388
+ isHidden: z.boolean().optional(),
389
+ })
390
+ export type PluginDesignDimensionsListArgs = z.infer<
391
+ typeof PluginDesignDimensionsListArgs
392
+ >
393
+
394
+ /**
395
+ * Arguments for {@linkcode PluginDesignDimensionsApi.get}.
396
+ *
397
+ * | Property | Type | Description |
398
+ * |---|---|---|
399
+ * | `dimension` | {@linkcode DimensionHandle} | The dimension line to read |
400
+ */
401
+ export const PluginDesignDimensionsGetArgs = z.object({
402
+ dimension: DimensionHandle,
403
+ })
404
+ export type PluginDesignDimensionsGetArgs = z.infer<
405
+ typeof PluginDesignDimensionsGetArgs
406
+ >
407
+
408
+ /**
409
+ * Arguments for {@linkcode PluginDesignDimensionsApi.delete}.
410
+ *
411
+ * `.min(1)` mirrors {@linkcode PluginDesignDeleteEntitiesArgs}: an empty delete
412
+ * is a caller error, not a no-op.
413
+ *
414
+ * | Property | Type | Description |
415
+ * |---|---|---|
416
+ * | `dimensions` | {@linkcode DimensionHandle}`[]` | Dimension lines to delete. Unknown handles reject the whole call (fail-fast). |
417
+ */
418
+ export const PluginDesignDimensionsDeleteArgs = z.object({
419
+ dimensions: z.array(DimensionHandle).min(1),
420
+ })
421
+ export type PluginDesignDimensionsDeleteArgs = z.infer<
422
+ typeof PluginDesignDimensionsDeleteArgs
423
+ >
424
+
425
+ /**
426
+ * Arguments for {@linkcode PluginDesignDimensionsApi.hide}. An empty array is
427
+ * allowed and is a no-op (mirroring {@linkcode PluginDesignVisibilityHideArgs}).
428
+ *
429
+ * | Property | Type | Description |
430
+ * |---|---|---|
431
+ * | `dimensions` | {@linkcode DimensionHandle}`[]` | Dimension lines to hide |
432
+ */
433
+ export const PluginDesignDimensionsHideArgs = z.object({
434
+ dimensions: z.array(DimensionHandle),
435
+ })
436
+ export type PluginDesignDimensionsHideArgs = z.infer<
437
+ typeof PluginDesignDimensionsHideArgs
438
+ >
439
+
440
+ /**
441
+ * Arguments for {@linkcode PluginDesignDimensionsApi.show}. An empty array is
442
+ * allowed and is a no-op.
443
+ *
444
+ * | Property | Type | Description |
445
+ * |---|---|---|
446
+ * | `dimensions` | {@linkcode DimensionHandle}`[]` | Dimension lines to reveal |
447
+ */
448
+ export const PluginDesignDimensionsShowArgs = z.object({
449
+ dimensions: z.array(DimensionHandle),
450
+ })
451
+ export type PluginDesignDimensionsShowArgs = z.infer<
452
+ typeof PluginDesignDimensionsShowArgs
453
+ >