@snaptrude/plugin-core 0.9.16 → 0.9.18-edgesetbacks-20261021.1

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 (221) hide show
  1. package/AGENTS.md +231 -231
  2. package/CHANGELOG.md +408 -402
  3. package/CLAUDE.md +11 -11
  4. package/api-manifest.json +1510 -701
  5. package/dist/api/analysis/daylight.d.ts +5 -5
  6. package/dist/api/analysis/solar.d.ts +2 -2
  7. package/dist/api/core/camera/index.d.ts +29 -0
  8. package/dist/api/core/camera/index.d.ts.map +1 -1
  9. package/dist/api/core/geom/create/index.d.ts +7 -1
  10. package/dist/api/core/geom/create/index.d.ts.map +1 -1
  11. package/dist/api/core/geom/update/contour.d.ts +8 -2
  12. package/dist/api/core/geom/update/contour.d.ts.map +1 -1
  13. package/dist/api/core/storeys/index.d.ts +5 -2
  14. package/dist/api/core/storeys/index.d.ts.map +1 -1
  15. package/dist/api/core/zoom/index.d.ts +13 -0
  16. package/dist/api/core/zoom/index.d.ts.map +1 -1
  17. package/dist/api/design/bim.d.ts +299 -0
  18. package/dist/api/design/bim.d.ts.map +1 -0
  19. package/dist/api/design/boolean/index.d.ts +2 -0
  20. package/dist/api/design/boolean/index.d.ts.map +1 -1
  21. package/dist/api/design/catalog.d.ts +320 -0
  22. package/dist/api/design/catalog.d.ts.map +1 -0
  23. package/dist/api/design/create/bulk-items.d.ts +65 -25
  24. package/dist/api/design/create/bulk-items.d.ts.map +1 -1
  25. package/dist/api/design/create/index.d.ts +299 -100
  26. package/dist/api/design/create/index.d.ts.map +1 -1
  27. package/dist/api/design/create/opening-fields.d.ts +13 -12
  28. package/dist/api/design/create/opening-fields.d.ts.map +1 -1
  29. package/dist/api/design/delete/index.d.ts +1 -0
  30. package/dist/api/design/delete/index.d.ts.map +1 -1
  31. package/dist/api/design/doors/index.d.ts +18 -24
  32. package/dist/api/design/doors/index.d.ts.map +1 -1
  33. package/dist/api/design/family.d.ts +813 -35
  34. package/dist/api/design/family.d.ts.map +1 -1
  35. package/dist/api/design/index.d.ts +16 -0
  36. package/dist/api/design/index.d.ts.map +1 -1
  37. package/dist/api/design/networks.d.ts +1703 -0
  38. package/dist/api/design/networks.d.ts.map +1 -0
  39. package/dist/api/design/query/grids.d.ts +2 -2
  40. package/dist/api/design/query/index.d.ts +42 -32
  41. package/dist/api/design/query/index.d.ts.map +1 -1
  42. package/dist/api/design/selection/index.d.ts +10 -10
  43. package/dist/api/design/types/index.d.ts +40 -24
  44. package/dist/api/design/types/index.d.ts.map +1 -1
  45. package/dist/api/design/update/index.d.ts +111 -6
  46. package/dist/api/design/update/index.d.ts.map +1 -1
  47. package/dist/api/design/windows/index.d.ts +8 -8
  48. package/dist/api/design/windows/index.d.ts.map +1 -1
  49. package/dist/api/entity/buildableEnvelope.d.ts +84 -2
  50. package/dist/api/entity/buildableEnvelope.d.ts.map +1 -1
  51. package/dist/api/presentation/aiInspiration.d.ts +10 -10
  52. package/dist/api/presentation/annotate.d.ts +38 -22
  53. package/dist/api/presentation/annotate.d.ts.map +1 -1
  54. package/dist/api/presentation/drawingContract.d.ts +32 -0
  55. package/dist/api/presentation/drawingContract.d.ts.map +1 -0
  56. package/dist/api/presentation/drawings.d.ts +3523 -0
  57. package/dist/api/presentation/drawings.d.ts.map +1 -0
  58. package/dist/api/presentation/export.d.ts +23 -5
  59. package/dist/api/presentation/export.d.ts.map +1 -1
  60. package/dist/api/presentation/index.d.ts +41 -12
  61. package/dist/api/presentation/index.d.ts.map +1 -1
  62. package/dist/api/presentation/placedViews.d.ts +106 -6
  63. package/dist/api/presentation/placedViews.d.ts.map +1 -1
  64. package/dist/api/presentation/sections.d.ts +461 -0
  65. package/dist/api/presentation/sections.d.ts.map +1 -0
  66. package/dist/api/presentation/shapes.d.ts +2 -2
  67. package/dist/api/presentation/sheets.d.ts +175 -19
  68. package/dist/api/presentation/sheets.d.ts.map +1 -1
  69. package/dist/api/presentation/viewPresets.d.ts +222 -0
  70. package/dist/api/presentation/viewPresets.d.ts.map +1 -0
  71. package/dist/api/presentation/views.d.ts +141 -8
  72. package/dist/api/presentation/views.d.ts.map +1 -1
  73. package/dist/api/presentation/walkthroughs.d.ts +6 -6
  74. package/dist/errors/codes.d.ts +3 -1
  75. package/dist/errors/codes.d.ts.map +1 -1
  76. package/dist/index.cjs +3883 -2385
  77. package/dist/index.cjs.map +1 -1
  78. package/dist/index.js +3744 -2385
  79. package/dist/index.js.map +1 -1
  80. package/package.json +1 -1
  81. package/scripts/check-dist-fresh.mjs +22 -22
  82. package/scripts/generate-manifest.mjs +243 -238
  83. package/scripts/generate-manifest.test.mjs +303 -303
  84. package/src/api/analysis/daylight.ts +470 -470
  85. package/src/api/analysis/heatmaps.ts +683 -683
  86. package/src/api/analysis/illuminance.ts +155 -155
  87. package/src/api/analysis/index.ts +61 -61
  88. package/src/api/analysis/shadows.ts +183 -183
  89. package/src/api/analysis/solar.ts +237 -237
  90. package/src/api/analysis/sunlightHours.ts +211 -211
  91. package/src/api/analysis/sunpath.ts +83 -83
  92. package/src/api/analysis/weather.ts +179 -179
  93. package/src/api/core/buildings.ts +485 -485
  94. package/src/api/core/camera/index.ts +696 -667
  95. package/src/api/core/comment/index.ts +376 -376
  96. package/src/api/core/geom/create/index.ts +2139 -2133
  97. package/src/api/core/geom/delete/index.ts +84 -84
  98. package/src/api/core/geom/index.ts +35 -35
  99. package/src/api/core/geom/query/arc.ts +169 -169
  100. package/src/api/core/geom/query/brep.ts +621 -621
  101. package/src/api/core/geom/query/circle.ts +404 -404
  102. package/src/api/core/geom/query/contour.ts +540 -540
  103. package/src/api/core/geom/query/curve.ts +1102 -1102
  104. package/src/api/core/geom/query/edge.ts +130 -130
  105. package/src/api/core/geom/query/face.ts +508 -508
  106. package/src/api/core/geom/query/halfedge.ts +210 -210
  107. package/src/api/core/geom/query/index.ts +63 -63
  108. package/src/api/core/geom/query/profile.ts +473 -473
  109. package/src/api/core/geom/query/vertex.ts +205 -205
  110. package/src/api/core/geom/update/contour.ts +323 -317
  111. package/src/api/core/geom/update/curve.ts +209 -209
  112. package/src/api/core/geom/update/index.ts +29 -29
  113. package/src/api/core/geom/update/profile.ts +379 -379
  114. package/src/api/core/groups.ts +521 -521
  115. package/src/api/core/handles/index.ts +234 -234
  116. package/src/api/core/history/index.ts +84 -84
  117. package/src/api/core/index.ts +99 -99
  118. package/src/api/core/io/export/index.ts +126 -126
  119. package/src/api/core/io/import/index.ts +504 -504
  120. package/src/api/core/io/index.ts +42 -42
  121. package/src/api/core/io/job/index.ts +140 -140
  122. package/src/api/core/io/query/index.ts +71 -71
  123. package/src/api/core/io/terrain/index.ts +360 -360
  124. package/src/api/core/io/underlay/index.ts +705 -705
  125. package/src/api/core/layers.ts +540 -540
  126. package/src/api/core/math/index.ts +20 -20
  127. package/src/api/core/math/quat.ts +172 -172
  128. package/src/api/core/math/vec3.ts +179 -179
  129. package/src/api/core/mode/index.ts +108 -108
  130. package/src/api/core/project/index.ts +479 -479
  131. package/src/api/core/proposals/index.ts +570 -570
  132. package/src/api/core/storeys/index.ts +311 -308
  133. package/src/api/core/storeys/layers.ts +339 -339
  134. package/src/api/core/tags.ts +911 -911
  135. package/src/api/core/units/index.ts +164 -164
  136. package/src/api/core/user.ts +46 -46
  137. package/src/api/core/zoom/index.ts +64 -51
  138. package/src/api/design/bim.ts +210 -0
  139. package/src/api/design/boolean/index.ts +181 -179
  140. package/src/api/design/catalog.ts +203 -0
  141. package/src/api/design/create/bulk-items.ts +294 -254
  142. package/src/api/design/create/grids.ts +137 -137
  143. package/src/api/design/create/index.ts +2178 -1980
  144. package/src/api/design/create/opening-fields.ts +40 -37
  145. package/src/api/design/delete/index.ts +75 -74
  146. package/src/api/design/dimensions.ts +453 -453
  147. package/src/api/design/doors/index.ts +516 -500
  148. package/src/api/design/edit/index.ts +54 -54
  149. package/src/api/design/erase/index.ts +151 -151
  150. package/src/api/design/family.ts +1342 -704
  151. package/src/api/design/furniture/index.ts +319 -319
  152. package/src/api/design/grids.ts +237 -237
  153. package/src/api/design/index.ts +304 -274
  154. package/src/api/design/lock.ts +69 -69
  155. package/src/api/design/materials/index.ts +608 -608
  156. package/src/api/design/networks.ts +607 -0
  157. package/src/api/design/query/geometry/index.ts +319 -319
  158. package/src/api/design/query/grids.ts +197 -197
  159. package/src/api/design/query/index.ts +1236 -1226
  160. package/src/api/design/query/referenceLines.ts +52 -52
  161. package/src/api/design/query/spaces.ts +275 -275
  162. package/src/api/design/selection/index.ts +273 -273
  163. package/src/api/design/shared.ts +40 -40
  164. package/src/api/design/transform/index.ts +254 -254
  165. package/src/api/design/types/index.ts +163 -156
  166. package/src/api/design/update/index.ts +1096 -983
  167. package/src/api/design/visibility.ts +143 -143
  168. package/src/api/design/windows/index.ts +351 -333
  169. package/src/api/entity/buildableEnvelope.ts +397 -322
  170. package/src/api/entity/index.ts +30 -30
  171. package/src/api/entity/referenceLine.ts +235 -235
  172. package/src/api/entity/space.ts +612 -612
  173. package/src/api/entity/story.ts +517 -517
  174. package/src/api/index.ts +47 -47
  175. package/src/api/presentation/aiInspiration.ts +1116 -1116
  176. package/src/api/presentation/annotate.ts +417 -385
  177. package/src/api/presentation/camera.ts +289 -289
  178. package/src/api/presentation/diagrams.ts +194 -194
  179. package/src/api/presentation/drawingContract.ts +70 -0
  180. package/src/api/presentation/drawings.ts +1179 -0
  181. package/src/api/presentation/export.ts +134 -108
  182. package/src/api/presentation/import.ts +159 -159
  183. package/src/api/presentation/index.ts +160 -126
  184. package/src/api/presentation/placedViews.ts +1211 -1120
  185. package/src/api/presentation/sections.ts +420 -0
  186. package/src/api/presentation/shapes.ts +274 -274
  187. package/src/api/presentation/sheets.ts +746 -585
  188. package/src/api/presentation/slideshow.ts +134 -134
  189. package/src/api/presentation/tables.ts +84 -84
  190. package/src/api/presentation/viewPresets.ts +241 -0
  191. package/src/api/presentation/views.ts +742 -673
  192. package/src/api/presentation/walkthroughs.ts +1201 -1201
  193. package/src/api/program/adjacency.ts +164 -164
  194. package/src/api/program/areas.ts +408 -408
  195. package/src/api/program/classification.ts +138 -138
  196. package/src/api/program/cores.ts +83 -83
  197. package/src/api/program/departments.ts +517 -517
  198. package/src/api/program/index.ts +73 -73
  199. package/src/api/program/labels.ts +332 -332
  200. package/src/api/program/layout.ts +422 -422
  201. package/src/api/program/metadata.ts +364 -364
  202. package/src/api/program/metrics.ts +120 -120
  203. package/src/api/program/site.ts +748 -748
  204. package/src/api/program/spreadsheet.ts +2698 -2698
  205. package/src/api/workspace/index.ts +612 -612
  206. package/src/errors/codes.ts +143 -136
  207. package/src/errors/envelope.ts +75 -75
  208. package/src/errors/index.ts +21 -21
  209. package/src/errors/plugin-error.ts +134 -134
  210. package/src/handles.ts +297 -297
  211. package/src/host-utils.ts +67 -67
  212. package/src/index.ts +7 -7
  213. package/src/massParameters.ops.ts +246 -246
  214. package/src/massParameters.ts +427 -427
  215. package/src/types.ts +16 -16
  216. package/test/drawingContract.test.mjs +288 -0
  217. package/test/errors.test.mjs +185 -184
  218. package/test/massParameters.test.mjs +952 -952
  219. package/test/presentationViewSettings.test.mjs +85 -0
  220. package/tsconfig.json +22 -22
  221. package/tsup.config.ts +12 -12
@@ -1,52 +1,52 @@
1
- import * as z from "zod"
2
- import { PluginApiReturn } from "../../../types"
3
- import {
4
- PluginReferenceLineGetProperty,
5
- PluginReferenceLineGetResult,
6
- } from "../../entity/referenceLine"
7
-
8
- /**
9
- * `design.query.referenceLines.*` — reference-line-specific reads.
10
- *
11
- * A **reference line** is a 2D guide line (or arc) in the scene, typically used
12
- * for grid lines and alignment guides. Enumerate reference lines with
13
- * `design.query.listReferenceLines`; read an individual line's properties here.
14
- * This is the canonical home of the read formerly at `entity.referenceLine.get`
15
- * (now deprecated).
16
- *
17
- * Accessed via `snaptrude.design.query.referenceLines`.
18
- */
19
- export abstract class PluginDesignQueryReferenceLinesApi {
20
- constructor() {}
21
-
22
- /**
23
- * Get properties of a reference line by its ID.
24
- *
25
- * Only the properties listed in `properties` are returned — unlisted
26
- * properties will be `undefined` in the result.
27
- *
28
- * @param referenceLineId - The unique reference line ID
29
- * @param properties - Array of property names to retrieve. See
30
- * {@linkcode PluginReferenceLineGetProperty}.
31
- * @returns A partial {@linkcode PluginReferenceLineGetResult} containing only the
32
- * requested properties
33
- * @throws If the reference line does not exist
34
- *
35
- * @examplePrompt Get the curve geometry of this reference line
36
- * @examplePrompt Where does this grid line run?
37
- * @examplePrompt Read the geometry of a guide line by its id
38
- * @examplePrompt Look up the curve of the selected reference line
39
- *
40
- * # Example
41
- * ```ts
42
- * const [refLine] = await snaptrude.design.query.listReferenceLines()
43
- * const result = await snaptrude.design.query.referenceLines.get(refLine, ["curve"])
44
- * // result.curve is an opaque CurveHandle; read its coordinates via
45
- * // `snaptrude.core.geom.curve`.
46
- * ```
47
- */
48
- public abstract get(
49
- referenceLineId: string,
50
- properties: z.infer<typeof PluginReferenceLineGetProperty>[],
51
- ): PluginApiReturn<PluginReferenceLineGetResult>
52
- }
1
+ import * as z from "zod"
2
+ import { PluginApiReturn } from "../../../types"
3
+ import {
4
+ PluginReferenceLineGetProperty,
5
+ PluginReferenceLineGetResult,
6
+ } from "../../entity/referenceLine"
7
+
8
+ /**
9
+ * `design.query.referenceLines.*` — reference-line-specific reads.
10
+ *
11
+ * A **reference line** is a 2D guide line (or arc) in the scene, typically used
12
+ * for grid lines and alignment guides. Enumerate reference lines with
13
+ * `design.query.listReferenceLines`; read an individual line's properties here.
14
+ * This is the canonical home of the read formerly at `entity.referenceLine.get`
15
+ * (now deprecated).
16
+ *
17
+ * Accessed via `snaptrude.design.query.referenceLines`.
18
+ */
19
+ export abstract class PluginDesignQueryReferenceLinesApi {
20
+ constructor() {}
21
+
22
+ /**
23
+ * Get properties of a reference line by its ID.
24
+ *
25
+ * Only the properties listed in `properties` are returned — unlisted
26
+ * properties will be `undefined` in the result.
27
+ *
28
+ * @param referenceLineId - The unique reference line ID
29
+ * @param properties - Array of property names to retrieve. See
30
+ * {@linkcode PluginReferenceLineGetProperty}.
31
+ * @returns A partial {@linkcode PluginReferenceLineGetResult} containing only the
32
+ * requested properties
33
+ * @throws If the reference line does not exist
34
+ *
35
+ * @examplePrompt Get the curve geometry of this reference line
36
+ * @examplePrompt Where does this grid line run?
37
+ * @examplePrompt Read the geometry of a guide line by its id
38
+ * @examplePrompt Look up the curve of the selected reference line
39
+ *
40
+ * # Example
41
+ * ```ts
42
+ * const [refLine] = await snaptrude.design.query.listReferenceLines()
43
+ * const result = await snaptrude.design.query.referenceLines.get(refLine, ["curve"])
44
+ * // result.curve is an opaque CurveHandle; read its coordinates via
45
+ * // `snaptrude.core.geom.curve`.
46
+ * ```
47
+ */
48
+ public abstract get(
49
+ referenceLineId: string,
50
+ properties: z.infer<typeof PluginReferenceLineGetProperty>[],
51
+ ): PluginApiReturn<PluginReferenceLineGetResult>
52
+ }
@@ -1,275 +1,275 @@
1
- import * as z from "zod"
2
- import { PluginApiReturn } from "../../../types"
3
- import { ComponentHandle, ContourHandle } from "../../../handles"
4
- import { PluginSpaceGetProperty, PluginSpaceGetResult } from "../../entity/space"
5
-
6
- /**
7
- * `design.query.spaces.*` — space-specific reads (a space is a room mass).
8
- *
9
- * Only the space queries feasible against the engine today are exposed here.
10
- * `getFloor` / `listBoundingWalls` (space↔wall topology) are deferred — they need
11
- * engine work that does not exist yet. `listAdjacent` stays deferred because the
12
- * shipped surfaces already answer it with value semantics: per-space via the
13
- * `adjacency` field of `design.query.getProperties`, in bulk via
14
- * `program.adjacency.getMatrix`.
15
- *
16
- * Accessed via `snaptrude.design.query.spaces`.
17
- */
18
- export abstract class PluginDesignQuerySpacesApi {
19
- constructor() {}
20
-
21
- /**
22
- * Get selected properties of a space — the selective multi-property read.
23
- *
24
- * Only the properties listed in `properties` are returned — unlisted
25
- * properties will be `undefined` in the result. This is the canonical home of
26
- * the read formerly at `entity.space.get` (now deprecated). Adjacency is not
27
- * part of this read — it is an entity property: read it via the `adjacency`
28
- * field of {@linkcode PluginDesignQueryApi.getProperties}.
29
- *
30
- * @param space - The space (room mass) to read
31
- * @param properties - Array of property names to retrieve. See
32
- * {@linkcode PluginDesignQuerySpacesGetProperty} for available values.
33
- * @returns A partial {@linkcode PluginDesignQuerySpacesGetResult} containing only
34
- * the requested properties
35
- * @throws If the space does not exist or the component is not a space/mass
36
- *
37
- * @examplePrompt What is the area of this room?
38
- * @examplePrompt Get the name, storey and height of the selected space
39
- * @examplePrompt Which department does this room belong to?
40
- * @examplePrompt Where is this space positioned on the plan?
41
- * @examplePrompt Read the room type and dimensions of the selected room
42
- *
43
- * # Example
44
- * ```ts
45
- * const [space] = await snaptrude.design.query.listSpaces()
46
- * const info = await snaptrude.design.query.spaces.get(space, ["name", "area", "position"])
47
- * console.log(info.name, info.area, info.position)
48
- * ```
49
- */
50
- public abstract get(
51
- space: ComponentHandle,
52
- properties: PluginDesignQuerySpacesGetArgs["properties"],
53
- ): PluginApiReturn<PluginDesignQuerySpacesGetResult>
54
-
55
- /**
56
- * Get the **footprint** of a space — its bottom-face contour (outer profile +
57
- * holes) as a reusable {@linkcode ContourHandle}. Equivalent to
58
- * {@linkcode PluginDesignQueryGeometryApi.getBottomContour} narrowed to spaces.
59
- *
60
- * @param space - The space (room mass) to read
61
- * @returns the footprint {@linkcode ContourHandle}, or `null` if the space has
62
- * no extractable footprint
63
- *
64
- * @examplePrompt Get the footprint of this room
65
- * @examplePrompt Trace the floor outline of the selected space
66
- * @examplePrompt What is the plan boundary of this room, including any holes?
67
- * @examplePrompt Give me the base profile of the selected room mass
68
- *
69
- * # Example
70
- * ```ts
71
- * const [space] = await snaptrude.design.query.listSpaces()
72
- * const footprint = await snaptrude.design.query.spaces.getFootprint(space)
73
- * ```
74
- */
75
- public abstract getFootprint(
76
- space: ComponentHandle,
77
- ): PluginApiReturn<ContourHandle | null>
78
-
79
- /**
80
- * Get the **enclosure** of a space — the floor and ceiling that cap it, the
81
- * bounding walls around it (with each wall's door/window openings), and the
82
- * neighbouring spaces it shares a boundary with.
83
- *
84
- * **Geometric v1 — best effort.** The engine has no persisted space→surface
85
- * topology, so this read is derived purely from *plan geometry*: the space
86
- * footprint is matched against the plan footprints/baselines of the slabs and
87
- * walls on the same storey. Consequences a caller must account for:
88
- *
89
- * - `faceIndices` is **always `[]`**. The triangle→B-rep-face provenance that
90
- * would populate it is a separate engine capability that does not exist yet;
91
- * read a surface's full geometry via
92
- * {@linkcode PluginDesignQueryGeometryApi.getBrep} on its `component` instead.
93
- * - After heavy edits (move / stretch / boolean) or on imported models the plan
94
- * match can miss or mis-attribute a surface — treat the result as advisory,
95
- * not authoritative.
96
- * - `adjacentSpaces` comes from the same adjacency data as
97
- * {@linkcode PluginProgramAdjacencyApi.getMatrix} (so the two agree on which
98
- * spaces neighbour). `sharedEdgeLength` is `0` because that data exposes no
99
- * edge length, and `sharedSurface` is the common boundary wall only when one
100
- * is found geometrically (else `null`).
101
- *
102
- * Read-only; never mutates the model.
103
- *
104
- * @param space - The space (room mass) to read
105
- * @returns the {@linkcode PluginSpaceEnclosure}, or `null` when `space` is not a
106
- * space (room mass) or has no extractable plan footprint
107
- *
108
- * @examplePrompt What walls, floor and ceiling enclose this room?
109
- * @examplePrompt Which of this room's walls are external?
110
- * @examplePrompt List the doors and windows around the selected space
111
- * @examplePrompt Which spaces are adjacent to this room, and through which wall?
112
- *
113
- * # Example
114
- * ```ts
115
- * const [space] = await snaptrude.design.query.listSpaces()
116
- * const enclosure = await snaptrude.design.query.spaces.getEnclosure(space)
117
- * if (enclosure) {
118
- * const walls = enclosure.surfaces.filter((s) => s.role === "wall")
119
- * const external = walls.filter((s) => s.isExternal)
120
- * console.log(`${walls.length} walls, ${external.length} external`)
121
- * }
122
- * ```
123
- */
124
- public abstract getEnclosure(
125
- space: ComponentHandle,
126
- ): PluginApiReturn<PluginSpaceEnclosure | null>
127
- }
128
-
129
- /**
130
- * Arguments for {@linkcode PluginDesignQuerySpacesApi.getFootprint}.
131
- *
132
- * | Property | Type | Description |
133
- * |---|---|---|
134
- * | `space` | {@linkcode ComponentHandle} | The space (room mass) to read |
135
- */
136
- export const PluginDesignQueryGetFootprintArgs = z.object({
137
- space: ComponentHandle,
138
- })
139
- export type PluginDesignQueryGetFootprintArgs = z.infer<
140
- typeof PluginDesignQueryGetFootprintArgs
141
- >
142
-
143
- /**
144
- * Property names readable via {@linkcode PluginDesignQuerySpacesApi.get} — the
145
- * legacy {@linkcode PluginSpaceGetProperty} set minus `"adjacency"` (adjacency is
146
- * an entity property: see the `adjacency` field of
147
- * {@linkcode PluginDesignQueryApi.getProperties}).
148
- */
149
- export const PluginDesignQuerySpacesGetProperty =
150
- PluginSpaceGetProperty.exclude(["adjacency"])
151
- export type PluginDesignQuerySpacesGetProperty = z.infer<
152
- typeof PluginDesignQuerySpacesGetProperty
153
- >
154
-
155
- /**
156
- * Arguments for {@linkcode PluginDesignQuerySpacesApi.get}.
157
- *
158
- * | Property | Type | Description |
159
- * |---|---|---|
160
- * | `space` | {@linkcode ComponentHandle} | The space (room mass) to read |
161
- * | `properties` | {@linkcode PluginDesignQuerySpacesGetProperty}`[]` | Properties to retrieve |
162
- */
163
- export const PluginDesignQuerySpacesGetArgs = z.object({
164
- space: ComponentHandle,
165
- properties: z.array(PluginDesignQuerySpacesGetProperty),
166
- })
167
- export type PluginDesignQuerySpacesGetArgs = z.infer<
168
- typeof PluginDesignQuerySpacesGetArgs
169
- >
170
-
171
- /**
172
- * Result of {@linkcode PluginDesignQuerySpacesApi.get} — the legacy
173
- * {@linkcode PluginSpaceGetResult} record minus `adjacency`. Partial: only the
174
- * requested properties are present.
175
- */
176
- export const PluginDesignQuerySpacesGetResult = PluginSpaceGetResult.omit({
177
- adjacency: true,
178
- })
179
- export type PluginDesignQuerySpacesGetResult = z.infer<
180
- typeof PluginDesignQuerySpacesGetResult
181
- >
182
-
183
- /**
184
- * Arguments for {@linkcode PluginDesignQuerySpacesApi.getEnclosure}.
185
- *
186
- * | Property | Type | Description |
187
- * |---|---|---|
188
- * | `space` | {@linkcode ComponentHandle} | The space (room mass) to read |
189
- */
190
- export const PluginDesignQuerySpacesGetEnclosureArgs = z.object({
191
- space: ComponentHandle,
192
- })
193
- export type PluginDesignQuerySpacesGetEnclosureArgs = z.infer<
194
- typeof PluginDesignQuerySpacesGetEnclosureArgs
195
- >
196
-
197
- /**
198
- * The role a bounding surface plays in a {@linkcode PluginSpaceEnclosure}:
199
- * `"floor"` (slab below), `"ceiling"` (slab/roof above), or `"wall"`.
200
- */
201
- export const PluginEnclosureRole = z.enum(["floor", "ceiling", "wall"])
202
- export type PluginEnclosureRole = z.infer<typeof PluginEnclosureRole>
203
-
204
- /** The kind of opening hosted in a bounding wall. */
205
- export const PluginEnclosureOpeningKind = z.enum(["door", "window", "void"])
206
- export type PluginEnclosureOpeningKind = z.infer<
207
- typeof PluginEnclosureOpeningKind
208
- >
209
-
210
- /**
211
- * One opening (door / window / void) in a bounding wall.
212
- *
213
- * | Property | Type | Description |
214
- * |---|---|---|
215
- * | `kind` | {@linkcode PluginEnclosureOpeningKind} | `"door"`, `"window"`, or `"void"` |
216
- * | `component` | {@linkcode ComponentHandle} | The opening entity |
217
- */
218
- export const PluginEnclosureOpening = z.object({
219
- kind: PluginEnclosureOpeningKind,
220
- component: ComponentHandle,
221
- })
222
- export type PluginEnclosureOpening = z.infer<typeof PluginEnclosureOpening>
223
-
224
- /**
225
- * One bounding surface of a space's enclosure.
226
- *
227
- * | Property | Type | Description |
228
- * |---|---|---|
229
- * | `role` | {@linkcode PluginEnclosureRole} | `"floor"`, `"ceiling"`, or `"wall"` |
230
- * | `component` | {@linkcode ComponentHandle} | The wall / slab / roof entity |
231
- * | `faceIndices` | `number[]` | B-rep face indices facing the space. **Always `[]` in geometric v1** (no triangle→face provenance yet) |
232
- * | `isExternal` | `boolean` | No space on the other side — for a wall, no other room bounds it; for a floor/ceiling, no room caps the storey below/above |
233
- * | `openings` | {@linkcode PluginEnclosureOpening}`[]` | Doors/windows/voids in the surface (walls only; `[]` for floor/ceiling in v1) |
234
- */
235
- export const PluginEnclosureSurface = z.object({
236
- role: PluginEnclosureRole,
237
- component: ComponentHandle,
238
- faceIndices: z.array(z.number()),
239
- isExternal: z.boolean(),
240
- openings: z.array(PluginEnclosureOpening),
241
- })
242
- export type PluginEnclosureSurface = z.infer<typeof PluginEnclosureSurface>
243
-
244
- /**
245
- * A space that neighbours the queried space.
246
- *
247
- * | Property | Type | Description |
248
- * |---|---|---|
249
- * | `space` | {@linkcode ComponentHandle} | The neighbouring space |
250
- * | `sharedSurface` | {@linkcode ComponentHandle}` \| null` | The common boundary wall when one is found geometrically, else `null` (e.g. an open-plan or non-physical adjacency) |
251
- * | `sharedEdgeLength` | `number` | Plan-unit length of the shared boundary — **always `0` in geometric v1** (the adjacency data exposes no edge length) |
252
- */
253
- export const PluginAdjacentSpace = z.object({
254
- space: ComponentHandle,
255
- sharedSurface: ComponentHandle.nullable(),
256
- sharedEdgeLength: z.number(),
257
- })
258
- export type PluginAdjacentSpace = z.infer<typeof PluginAdjacentSpace>
259
-
260
- /**
261
- * Result of {@linkcode PluginDesignQuerySpacesApi.getEnclosure} — the geometric
262
- * v1 enclosure of a space.
263
- *
264
- * | Property | Type | Description |
265
- * |---|---|---|
266
- * | `space` | {@linkcode ComponentHandle} | The queried space |
267
- * | `surfaces` | {@linkcode PluginEnclosureSurface}`[]` | Floor + ceiling + bounding walls, as a flat list (any of the three may be absent when no plan match is found) |
268
- * | `adjacentSpaces` | {@linkcode PluginAdjacentSpace}`[]` | Neighbouring spaces from the adjacency data (`[]` when adjacency was never computed) |
269
- */
270
- export const PluginSpaceEnclosure = z.object({
271
- space: ComponentHandle,
272
- surfaces: z.array(PluginEnclosureSurface),
273
- adjacentSpaces: z.array(PluginAdjacentSpace),
274
- })
275
- export type PluginSpaceEnclosure = z.infer<typeof PluginSpaceEnclosure>
1
+ import * as z from "zod"
2
+ import { PluginApiReturn } from "../../../types"
3
+ import { ComponentHandle, ContourHandle } from "../../../handles"
4
+ import { PluginSpaceGetProperty, PluginSpaceGetResult } from "../../entity/space"
5
+
6
+ /**
7
+ * `design.query.spaces.*` — space-specific reads (a space is a room mass).
8
+ *
9
+ * Only the space queries feasible against the engine today are exposed here.
10
+ * `getFloor` / `listBoundingWalls` (space↔wall topology) are deferred — they need
11
+ * engine work that does not exist yet. `listAdjacent` stays deferred because the
12
+ * shipped surfaces already answer it with value semantics: per-space via the
13
+ * `adjacency` field of `design.query.getProperties`, in bulk via
14
+ * `program.adjacency.getMatrix`.
15
+ *
16
+ * Accessed via `snaptrude.design.query.spaces`.
17
+ */
18
+ export abstract class PluginDesignQuerySpacesApi {
19
+ constructor() {}
20
+
21
+ /**
22
+ * Get selected properties of a space — the selective multi-property read.
23
+ *
24
+ * Only the properties listed in `properties` are returned — unlisted
25
+ * properties will be `undefined` in the result. This is the canonical home of
26
+ * the read formerly at `entity.space.get` (now deprecated). Adjacency is not
27
+ * part of this read — it is an entity property: read it via the `adjacency`
28
+ * field of {@linkcode PluginDesignQueryApi.getProperties}.
29
+ *
30
+ * @param space - The space (room mass) to read
31
+ * @param properties - Array of property names to retrieve. See
32
+ * {@linkcode PluginDesignQuerySpacesGetProperty} for available values.
33
+ * @returns A partial {@linkcode PluginDesignQuerySpacesGetResult} containing only
34
+ * the requested properties
35
+ * @throws If the space does not exist or the component is not a space/mass
36
+ *
37
+ * @examplePrompt What is the area of this room?
38
+ * @examplePrompt Get the name, storey and height of the selected space
39
+ * @examplePrompt Which department does this room belong to?
40
+ * @examplePrompt Where is this space positioned on the plan?
41
+ * @examplePrompt Read the room type and dimensions of the selected room
42
+ *
43
+ * # Example
44
+ * ```ts
45
+ * const [space] = await snaptrude.design.query.listSpaces()
46
+ * const info = await snaptrude.design.query.spaces.get(space, ["name", "area", "position"])
47
+ * console.log(info.name, info.area, info.position)
48
+ * ```
49
+ */
50
+ public abstract get(
51
+ space: ComponentHandle,
52
+ properties: PluginDesignQuerySpacesGetArgs["properties"],
53
+ ): PluginApiReturn<PluginDesignQuerySpacesGetResult>
54
+
55
+ /**
56
+ * Get the **footprint** of a space — its bottom-face contour (outer profile +
57
+ * holes) as a reusable {@linkcode ContourHandle}. Equivalent to
58
+ * {@linkcode PluginDesignQueryGeometryApi.getBottomContour} narrowed to spaces.
59
+ *
60
+ * @param space - The space (room mass) to read
61
+ * @returns the footprint {@linkcode ContourHandle}, or `null` if the space has
62
+ * no extractable footprint
63
+ *
64
+ * @examplePrompt Get the footprint of this room
65
+ * @examplePrompt Trace the floor outline of the selected space
66
+ * @examplePrompt What is the plan boundary of this room, including any holes?
67
+ * @examplePrompt Give me the base profile of the selected room mass
68
+ *
69
+ * # Example
70
+ * ```ts
71
+ * const [space] = await snaptrude.design.query.listSpaces()
72
+ * const footprint = await snaptrude.design.query.spaces.getFootprint(space)
73
+ * ```
74
+ */
75
+ public abstract getFootprint(
76
+ space: ComponentHandle,
77
+ ): PluginApiReturn<ContourHandle | null>
78
+
79
+ /**
80
+ * Get the **enclosure** of a space — the floor and ceiling that cap it, the
81
+ * bounding walls around it (with each wall's door/window openings), and the
82
+ * neighbouring spaces it shares a boundary with.
83
+ *
84
+ * **Geometric v1 — best effort.** The engine has no persisted space→surface
85
+ * topology, so this read is derived purely from *plan geometry*: the space
86
+ * footprint is matched against the plan footprints/baselines of the slabs and
87
+ * walls on the same storey. Consequences a caller must account for:
88
+ *
89
+ * - `faceIndices` is **always `[]`**. The triangle→B-rep-face provenance that
90
+ * would populate it is a separate engine capability that does not exist yet;
91
+ * read a surface's full geometry via
92
+ * {@linkcode PluginDesignQueryGeometryApi.getBrep} on its `component` instead.
93
+ * - After heavy edits (move / stretch / boolean) or on imported models the plan
94
+ * match can miss or mis-attribute a surface — treat the result as advisory,
95
+ * not authoritative.
96
+ * - `adjacentSpaces` comes from the same adjacency data as
97
+ * {@linkcode PluginProgramAdjacencyApi.getMatrix} (so the two agree on which
98
+ * spaces neighbour). `sharedEdgeLength` is `0` because that data exposes no
99
+ * edge length, and `sharedSurface` is the common boundary wall only when one
100
+ * is found geometrically (else `null`).
101
+ *
102
+ * Read-only; never mutates the model.
103
+ *
104
+ * @param space - The space (room mass) to read
105
+ * @returns the {@linkcode PluginSpaceEnclosure}, or `null` when `space` is not a
106
+ * space (room mass) or has no extractable plan footprint
107
+ *
108
+ * @examplePrompt What walls, floor and ceiling enclose this room?
109
+ * @examplePrompt Which of this room's walls are external?
110
+ * @examplePrompt List the doors and windows around the selected space
111
+ * @examplePrompt Which spaces are adjacent to this room, and through which wall?
112
+ *
113
+ * # Example
114
+ * ```ts
115
+ * const [space] = await snaptrude.design.query.listSpaces()
116
+ * const enclosure = await snaptrude.design.query.spaces.getEnclosure(space)
117
+ * if (enclosure) {
118
+ * const walls = enclosure.surfaces.filter((s) => s.role === "wall")
119
+ * const external = walls.filter((s) => s.isExternal)
120
+ * console.log(`${walls.length} walls, ${external.length} external`)
121
+ * }
122
+ * ```
123
+ */
124
+ public abstract getEnclosure(
125
+ space: ComponentHandle,
126
+ ): PluginApiReturn<PluginSpaceEnclosure | null>
127
+ }
128
+
129
+ /**
130
+ * Arguments for {@linkcode PluginDesignQuerySpacesApi.getFootprint}.
131
+ *
132
+ * | Property | Type | Description |
133
+ * |---|---|---|
134
+ * | `space` | {@linkcode ComponentHandle} | The space (room mass) to read |
135
+ */
136
+ export const PluginDesignQueryGetFootprintArgs = z.object({
137
+ space: ComponentHandle,
138
+ })
139
+ export type PluginDesignQueryGetFootprintArgs = z.infer<
140
+ typeof PluginDesignQueryGetFootprintArgs
141
+ >
142
+
143
+ /**
144
+ * Property names readable via {@linkcode PluginDesignQuerySpacesApi.get} — the
145
+ * legacy {@linkcode PluginSpaceGetProperty} set minus `"adjacency"` (adjacency is
146
+ * an entity property: see the `adjacency` field of
147
+ * {@linkcode PluginDesignQueryApi.getProperties}).
148
+ */
149
+ export const PluginDesignQuerySpacesGetProperty =
150
+ PluginSpaceGetProperty.exclude(["adjacency"])
151
+ export type PluginDesignQuerySpacesGetProperty = z.infer<
152
+ typeof PluginDesignQuerySpacesGetProperty
153
+ >
154
+
155
+ /**
156
+ * Arguments for {@linkcode PluginDesignQuerySpacesApi.get}.
157
+ *
158
+ * | Property | Type | Description |
159
+ * |---|---|---|
160
+ * | `space` | {@linkcode ComponentHandle} | The space (room mass) to read |
161
+ * | `properties` | {@linkcode PluginDesignQuerySpacesGetProperty}`[]` | Properties to retrieve |
162
+ */
163
+ export const PluginDesignQuerySpacesGetArgs = z.object({
164
+ space: ComponentHandle,
165
+ properties: z.array(PluginDesignQuerySpacesGetProperty),
166
+ })
167
+ export type PluginDesignQuerySpacesGetArgs = z.infer<
168
+ typeof PluginDesignQuerySpacesGetArgs
169
+ >
170
+
171
+ /**
172
+ * Result of {@linkcode PluginDesignQuerySpacesApi.get} — the legacy
173
+ * {@linkcode PluginSpaceGetResult} record minus `adjacency`. Partial: only the
174
+ * requested properties are present.
175
+ */
176
+ export const PluginDesignQuerySpacesGetResult = PluginSpaceGetResult.omit({
177
+ adjacency: true,
178
+ })
179
+ export type PluginDesignQuerySpacesGetResult = z.infer<
180
+ typeof PluginDesignQuerySpacesGetResult
181
+ >
182
+
183
+ /**
184
+ * Arguments for {@linkcode PluginDesignQuerySpacesApi.getEnclosure}.
185
+ *
186
+ * | Property | Type | Description |
187
+ * |---|---|---|
188
+ * | `space` | {@linkcode ComponentHandle} | The space (room mass) to read |
189
+ */
190
+ export const PluginDesignQuerySpacesGetEnclosureArgs = z.object({
191
+ space: ComponentHandle,
192
+ })
193
+ export type PluginDesignQuerySpacesGetEnclosureArgs = z.infer<
194
+ typeof PluginDesignQuerySpacesGetEnclosureArgs
195
+ >
196
+
197
+ /**
198
+ * The role a bounding surface plays in a {@linkcode PluginSpaceEnclosure}:
199
+ * `"floor"` (slab below), `"ceiling"` (slab/roof above), or `"wall"`.
200
+ */
201
+ export const PluginEnclosureRole = z.enum(["floor", "ceiling", "wall"])
202
+ export type PluginEnclosureRole = z.infer<typeof PluginEnclosureRole>
203
+
204
+ /** The kind of opening hosted in a bounding wall. */
205
+ export const PluginEnclosureOpeningKind = z.enum(["door", "window", "void"])
206
+ export type PluginEnclosureOpeningKind = z.infer<
207
+ typeof PluginEnclosureOpeningKind
208
+ >
209
+
210
+ /**
211
+ * One opening (door / window / void) in a bounding wall.
212
+ *
213
+ * | Property | Type | Description |
214
+ * |---|---|---|
215
+ * | `kind` | {@linkcode PluginEnclosureOpeningKind} | `"door"`, `"window"`, or `"void"` |
216
+ * | `component` | {@linkcode ComponentHandle} | The opening entity |
217
+ */
218
+ export const PluginEnclosureOpening = z.object({
219
+ kind: PluginEnclosureOpeningKind,
220
+ component: ComponentHandle,
221
+ })
222
+ export type PluginEnclosureOpening = z.infer<typeof PluginEnclosureOpening>
223
+
224
+ /**
225
+ * One bounding surface of a space's enclosure.
226
+ *
227
+ * | Property | Type | Description |
228
+ * |---|---|---|
229
+ * | `role` | {@linkcode PluginEnclosureRole} | `"floor"`, `"ceiling"`, or `"wall"` |
230
+ * | `component` | {@linkcode ComponentHandle} | The wall / slab / roof entity |
231
+ * | `faceIndices` | `number[]` | B-rep face indices facing the space. **Always `[]` in geometric v1** (no triangle→face provenance yet) |
232
+ * | `isExternal` | `boolean` | No space on the other side — for a wall, no other room bounds it; for a floor/ceiling, no room caps the storey below/above |
233
+ * | `openings` | {@linkcode PluginEnclosureOpening}`[]` | Doors/windows/voids in the surface (walls only; `[]` for floor/ceiling in v1) |
234
+ */
235
+ export const PluginEnclosureSurface = z.object({
236
+ role: PluginEnclosureRole,
237
+ component: ComponentHandle,
238
+ faceIndices: z.array(z.number()),
239
+ isExternal: z.boolean(),
240
+ openings: z.array(PluginEnclosureOpening),
241
+ })
242
+ export type PluginEnclosureSurface = z.infer<typeof PluginEnclosureSurface>
243
+
244
+ /**
245
+ * A space that neighbours the queried space.
246
+ *
247
+ * | Property | Type | Description |
248
+ * |---|---|---|
249
+ * | `space` | {@linkcode ComponentHandle} | The neighbouring space |
250
+ * | `sharedSurface` | {@linkcode ComponentHandle}` \| null` | The common boundary wall when one is found geometrically, else `null` (e.g. an open-plan or non-physical adjacency) |
251
+ * | `sharedEdgeLength` | `number` | Plan-unit length of the shared boundary — **always `0` in geometric v1** (the adjacency data exposes no edge length) |
252
+ */
253
+ export const PluginAdjacentSpace = z.object({
254
+ space: ComponentHandle,
255
+ sharedSurface: ComponentHandle.nullable(),
256
+ sharedEdgeLength: z.number(),
257
+ })
258
+ export type PluginAdjacentSpace = z.infer<typeof PluginAdjacentSpace>
259
+
260
+ /**
261
+ * Result of {@linkcode PluginDesignQuerySpacesApi.getEnclosure} — the geometric
262
+ * v1 enclosure of a space.
263
+ *
264
+ * | Property | Type | Description |
265
+ * |---|---|---|
266
+ * | `space` | {@linkcode ComponentHandle} | The queried space |
267
+ * | `surfaces` | {@linkcode PluginEnclosureSurface}`[]` | Floor + ceiling + bounding walls, as a flat list (any of the three may be absent when no plan match is found) |
268
+ * | `adjacentSpaces` | {@linkcode PluginAdjacentSpace}`[]` | Neighbouring spaces from the adjacency data (`[]` when adjacency was never computed) |
269
+ */
270
+ export const PluginSpaceEnclosure = z.object({
271
+ space: ComponentHandle,
272
+ surfaces: z.array(PluginEnclosureSurface),
273
+ adjacentSpaces: z.array(PluginAdjacentSpace),
274
+ })
275
+ export type PluginSpaceEnclosure = z.infer<typeof PluginSpaceEnclosure>