@snaptrude/plugin-core 0.9.16 → 0.9.18-networks-20261016.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 (215) hide show
  1. package/AGENTS.md +231 -231
  2. package/CHANGELOG.md +408 -402
  3. package/CLAUDE.md +11 -11
  4. package/dist/api/analysis/daylight.d.ts +5 -5
  5. package/dist/api/analysis/solar.d.ts +2 -2
  6. package/dist/api/core/camera/index.d.ts +29 -0
  7. package/dist/api/core/camera/index.d.ts.map +1 -1
  8. package/dist/api/core/geom/create/index.d.ts +7 -1
  9. package/dist/api/core/geom/create/index.d.ts.map +1 -1
  10. package/dist/api/core/geom/update/contour.d.ts +8 -2
  11. package/dist/api/core/geom/update/contour.d.ts.map +1 -1
  12. package/dist/api/core/zoom/index.d.ts +13 -0
  13. package/dist/api/core/zoom/index.d.ts.map +1 -1
  14. package/dist/api/design/bim.d.ts +209 -0
  15. package/dist/api/design/bim.d.ts.map +1 -0
  16. package/dist/api/design/boolean/index.d.ts +2 -0
  17. package/dist/api/design/boolean/index.d.ts.map +1 -1
  18. package/dist/api/design/catalog.d.ts +320 -0
  19. package/dist/api/design/catalog.d.ts.map +1 -0
  20. package/dist/api/design/create/bulk-items.d.ts +65 -25
  21. package/dist/api/design/create/bulk-items.d.ts.map +1 -1
  22. package/dist/api/design/create/index.d.ts +272 -99
  23. package/dist/api/design/create/index.d.ts.map +1 -1
  24. package/dist/api/design/create/opening-fields.d.ts +13 -12
  25. package/dist/api/design/create/opening-fields.d.ts.map +1 -1
  26. package/dist/api/design/delete/index.d.ts +1 -0
  27. package/dist/api/design/delete/index.d.ts.map +1 -1
  28. package/dist/api/design/doors/index.d.ts +18 -24
  29. package/dist/api/design/doors/index.d.ts.map +1 -1
  30. package/dist/api/design/family.d.ts +797 -27
  31. package/dist/api/design/family.d.ts.map +1 -1
  32. package/dist/api/design/index.d.ts +16 -0
  33. package/dist/api/design/index.d.ts.map +1 -1
  34. package/dist/api/design/networks.d.ts +1763 -0
  35. package/dist/api/design/networks.d.ts.map +1 -0
  36. package/dist/api/design/query/index.d.ts +42 -32
  37. package/dist/api/design/query/index.d.ts.map +1 -1
  38. package/dist/api/design/selection/index.d.ts +10 -10
  39. package/dist/api/design/types/index.d.ts +40 -24
  40. package/dist/api/design/types/index.d.ts.map +1 -1
  41. package/dist/api/design/update/index.d.ts +43 -3
  42. package/dist/api/design/update/index.d.ts.map +1 -1
  43. package/dist/api/design/windows/index.d.ts +8 -8
  44. package/dist/api/design/windows/index.d.ts.map +1 -1
  45. package/dist/api/presentation/aiInspiration.d.ts +10 -10
  46. package/dist/api/presentation/annotate.d.ts +38 -22
  47. package/dist/api/presentation/annotate.d.ts.map +1 -1
  48. package/dist/api/presentation/drawingContract.d.ts +32 -0
  49. package/dist/api/presentation/drawingContract.d.ts.map +1 -0
  50. package/dist/api/presentation/drawings.d.ts +3523 -0
  51. package/dist/api/presentation/drawings.d.ts.map +1 -0
  52. package/dist/api/presentation/export.d.ts +23 -5
  53. package/dist/api/presentation/export.d.ts.map +1 -1
  54. package/dist/api/presentation/index.d.ts +41 -12
  55. package/dist/api/presentation/index.d.ts.map +1 -1
  56. package/dist/api/presentation/placedViews.d.ts +106 -6
  57. package/dist/api/presentation/placedViews.d.ts.map +1 -1
  58. package/dist/api/presentation/sections.d.ts +461 -0
  59. package/dist/api/presentation/sections.d.ts.map +1 -0
  60. package/dist/api/presentation/shapes.d.ts +2 -2
  61. package/dist/api/presentation/sheets.d.ts +175 -19
  62. package/dist/api/presentation/sheets.d.ts.map +1 -1
  63. package/dist/api/presentation/viewPresets.d.ts +222 -0
  64. package/dist/api/presentation/viewPresets.d.ts.map +1 -0
  65. package/dist/api/presentation/views.d.ts +103 -5
  66. package/dist/api/presentation/views.d.ts.map +1 -1
  67. package/dist/api/presentation/walkthroughs.d.ts +6 -6
  68. package/dist/errors/codes.d.ts +3 -1
  69. package/dist/errors/codes.d.ts.map +1 -1
  70. package/dist/index.cjs +3788 -2328
  71. package/dist/index.cjs.map +1 -1
  72. package/dist/index.js +3650 -2328
  73. package/dist/index.js.map +1 -1
  74. package/package.json +42 -42
  75. package/scripts/check-dist-fresh.mjs +22 -22
  76. package/scripts/generate-manifest.mjs +243 -238
  77. package/scripts/generate-manifest.test.mjs +303 -303
  78. package/src/api/analysis/daylight.ts +470 -470
  79. package/src/api/analysis/heatmaps.ts +683 -683
  80. package/src/api/analysis/illuminance.ts +155 -155
  81. package/src/api/analysis/index.ts +61 -61
  82. package/src/api/analysis/shadows.ts +183 -183
  83. package/src/api/analysis/solar.ts +237 -237
  84. package/src/api/analysis/sunlightHours.ts +211 -211
  85. package/src/api/analysis/sunpath.ts +83 -83
  86. package/src/api/analysis/weather.ts +179 -179
  87. package/src/api/core/buildings.ts +485 -485
  88. package/src/api/core/camera/index.ts +696 -667
  89. package/src/api/core/comment/index.ts +376 -376
  90. package/src/api/core/geom/create/index.ts +2139 -2133
  91. package/src/api/core/geom/delete/index.ts +84 -84
  92. package/src/api/core/geom/index.ts +35 -35
  93. package/src/api/core/geom/query/arc.ts +169 -169
  94. package/src/api/core/geom/query/brep.ts +621 -621
  95. package/src/api/core/geom/query/circle.ts +404 -404
  96. package/src/api/core/geom/query/contour.ts +540 -540
  97. package/src/api/core/geom/query/curve.ts +1102 -1102
  98. package/src/api/core/geom/query/edge.ts +130 -130
  99. package/src/api/core/geom/query/face.ts +508 -508
  100. package/src/api/core/geom/query/halfedge.ts +210 -210
  101. package/src/api/core/geom/query/index.ts +63 -63
  102. package/src/api/core/geom/query/profile.ts +473 -473
  103. package/src/api/core/geom/query/vertex.ts +205 -205
  104. package/src/api/core/geom/update/contour.ts +323 -317
  105. package/src/api/core/geom/update/curve.ts +209 -209
  106. package/src/api/core/geom/update/index.ts +29 -29
  107. package/src/api/core/geom/update/profile.ts +379 -379
  108. package/src/api/core/groups.ts +521 -521
  109. package/src/api/core/handles/index.ts +234 -234
  110. package/src/api/core/history/index.ts +84 -84
  111. package/src/api/core/index.ts +99 -99
  112. package/src/api/core/io/export/index.ts +126 -126
  113. package/src/api/core/io/import/index.ts +504 -504
  114. package/src/api/core/io/index.ts +42 -42
  115. package/src/api/core/io/job/index.ts +140 -140
  116. package/src/api/core/io/query/index.ts +71 -71
  117. package/src/api/core/io/terrain/index.ts +360 -360
  118. package/src/api/core/io/underlay/index.ts +705 -705
  119. package/src/api/core/layers.ts +540 -540
  120. package/src/api/core/math/index.ts +20 -20
  121. package/src/api/core/math/quat.ts +172 -172
  122. package/src/api/core/math/vec3.ts +179 -179
  123. package/src/api/core/mode/index.ts +108 -108
  124. package/src/api/core/project/index.ts +479 -479
  125. package/src/api/core/proposals/index.ts +570 -570
  126. package/src/api/core/storeys/index.ts +308 -308
  127. package/src/api/core/storeys/layers.ts +339 -339
  128. package/src/api/core/tags.ts +911 -911
  129. package/src/api/core/units/index.ts +164 -164
  130. package/src/api/core/user.ts +46 -46
  131. package/src/api/core/zoom/index.ts +64 -51
  132. package/src/api/design/bim.ts +121 -0
  133. package/src/api/design/boolean/index.ts +181 -179
  134. package/src/api/design/catalog.ts +203 -0
  135. package/src/api/design/create/bulk-items.ts +294 -254
  136. package/src/api/design/create/grids.ts +137 -137
  137. package/src/api/design/create/index.ts +2148 -1980
  138. package/src/api/design/create/opening-fields.ts +40 -37
  139. package/src/api/design/delete/index.ts +75 -74
  140. package/src/api/design/dimensions.ts +453 -453
  141. package/src/api/design/doors/index.ts +516 -500
  142. package/src/api/design/edit/index.ts +54 -54
  143. package/src/api/design/erase/index.ts +151 -151
  144. package/src/api/design/family.ts +1334 -704
  145. package/src/api/design/furniture/index.ts +319 -319
  146. package/src/api/design/grids.ts +237 -237
  147. package/src/api/design/index.ts +304 -274
  148. package/src/api/design/lock.ts +69 -69
  149. package/src/api/design/materials/index.ts +608 -608
  150. package/src/api/design/networks.ts +667 -0
  151. package/src/api/design/query/geometry/index.ts +319 -319
  152. package/src/api/design/query/grids.ts +197 -197
  153. package/src/api/design/query/index.ts +1236 -1226
  154. package/src/api/design/query/referenceLines.ts +52 -52
  155. package/src/api/design/query/spaces.ts +275 -275
  156. package/src/api/design/selection/index.ts +273 -273
  157. package/src/api/design/shared.ts +40 -40
  158. package/src/api/design/transform/index.ts +254 -254
  159. package/src/api/design/types/index.ts +163 -156
  160. package/src/api/design/update/index.ts +1024 -983
  161. package/src/api/design/visibility.ts +143 -143
  162. package/src/api/design/windows/index.ts +351 -333
  163. package/src/api/entity/buildableEnvelope.ts +322 -322
  164. package/src/api/entity/index.ts +30 -30
  165. package/src/api/entity/referenceLine.ts +235 -235
  166. package/src/api/entity/space.ts +612 -612
  167. package/src/api/entity/story.ts +517 -517
  168. package/src/api/index.ts +47 -47
  169. package/src/api/presentation/aiInspiration.ts +1116 -1116
  170. package/src/api/presentation/annotate.ts +417 -385
  171. package/src/api/presentation/camera.ts +289 -289
  172. package/src/api/presentation/diagrams.ts +194 -194
  173. package/src/api/presentation/drawingContract.ts +70 -0
  174. package/src/api/presentation/drawings.ts +1179 -0
  175. package/src/api/presentation/export.ts +134 -108
  176. package/src/api/presentation/import.ts +159 -159
  177. package/src/api/presentation/index.ts +160 -126
  178. package/src/api/presentation/placedViews.ts +1211 -1120
  179. package/src/api/presentation/sections.ts +420 -0
  180. package/src/api/presentation/shapes.ts +274 -274
  181. package/src/api/presentation/sheets.ts +746 -585
  182. package/src/api/presentation/slideshow.ts +134 -134
  183. package/src/api/presentation/tables.ts +84 -84
  184. package/src/api/presentation/viewPresets.ts +241 -0
  185. package/src/api/presentation/views.ts +713 -673
  186. package/src/api/presentation/walkthroughs.ts +1201 -1201
  187. package/src/api/program/adjacency.ts +164 -164
  188. package/src/api/program/areas.ts +408 -408
  189. package/src/api/program/classification.ts +138 -138
  190. package/src/api/program/cores.ts +83 -83
  191. package/src/api/program/departments.ts +517 -517
  192. package/src/api/program/index.ts +73 -73
  193. package/src/api/program/labels.ts +332 -332
  194. package/src/api/program/layout.ts +422 -422
  195. package/src/api/program/metadata.ts +364 -364
  196. package/src/api/program/metrics.ts +120 -120
  197. package/src/api/program/site.ts +748 -748
  198. package/src/api/program/spreadsheet.ts +2698 -2698
  199. package/src/api/workspace/index.ts +612 -612
  200. package/src/errors/codes.ts +143 -136
  201. package/src/errors/envelope.ts +75 -75
  202. package/src/errors/index.ts +21 -21
  203. package/src/errors/plugin-error.ts +134 -134
  204. package/src/handles.ts +297 -297
  205. package/src/host-utils.ts +67 -67
  206. package/src/index.ts +7 -7
  207. package/src/massParameters.ops.ts +246 -246
  208. package/src/massParameters.ts +427 -427
  209. package/src/types.ts +16 -16
  210. package/test/drawingContract.test.mjs +288 -0
  211. package/test/errors.test.mjs +185 -184
  212. package/test/massParameters.test.mjs +952 -952
  213. package/tsconfig.json +22 -22
  214. package/tsup.config.ts +12 -12
  215. package/api-manifest.json +0 -9618
@@ -1,379 +1,379 @@
1
- import * as z from "zod"
2
- import { PluginApiReturn } from "../../../../types"
3
- import {
4
- ProfileHandle,
5
- Vec3Handle,
6
- CurveHandle,
7
- Vec3Components,
8
- } from "../../../../handles"
9
-
10
- /**
11
- * Profile editing — produce NEW profiles from an existing one (all-handle model, §11).
12
- *
13
- * Every method is an immutable derive-new operation: it takes an opaque
14
- * {@linkcode ProfileHandle} (plus any extra inputs) and returns a fresh
15
- * {@linkcode ProfileHandle} for the resulting profile. The input profile is never
16
- * mutated — the original handle keeps referring to the unchanged profile. Read the
17
- * resulting geometry back as plain values with the query namespace.
18
- *
19
- * Accessed via `snaptrude.core.geom.update.profile`.
20
- */
21
- export abstract class PluginGeomUpdateProfileApi {
22
- constructor() {}
23
-
24
- /**
25
- * Offset a closed profile inward/outward by a signed distance. Immutable —
26
- * returns a NEW profile and leaves the input unchanged.
27
- *
28
- * @param profile The closed profile to offset
29
- * @param distance Signed offset distance (outward when positive, inward when negative)
30
- * @returns The offset profile as a NEW {@linkcode ProfileHandle}
31
- * @throws PRECONDITION_FAILED if the profile has a spline run (splines cannot
32
- * be offset yet)
33
- *
34
- * @examplePrompt Offset this outline 300mm inward
35
- * @examplePrompt Inset this boundary by a foot all around
36
- *
37
- * # Example
38
- * ```ts
39
- * const rect = await snaptrude.core.geom.create.profileRect(10, 8)
40
- * const inset = await snaptrude.core.geom.update.profile.offset(rect, -0.3)
41
- * const area = await snaptrude.core.geom.query.profile.getArea(inset)
42
- * ```
43
- */
44
- public abstract offset(
45
- profile: ProfileHandle,
46
- distance: number,
47
- ): PluginApiReturn<ProfileHandle>
48
-
49
- /**
50
- * Translate a profile by a vector. Immutable — returns a NEW profile and leaves
51
- * the input unchanged.
52
- *
53
- * @param profile The profile to move
54
- * @param translation Translation vector to move the profile by
55
- * @returns The moved profile as a NEW {@linkcode ProfileHandle}
56
- *
57
- * @examplePrompt Move this outline 3 metres along the x axis
58
- * @examplePrompt Shift this boundary to a new position
59
- *
60
- * # Example
61
- * ```ts
62
- * const rect = await snaptrude.core.geom.create.profileRect(6, 4)
63
- * const shift = await snaptrude.core.math.vec3.new(3, 0, 0)
64
- * const moved = await snaptrude.core.geom.update.profile.move(rect, shift)
65
- * ```
66
- */
67
- public abstract move(
68
- profile: ProfileHandle,
69
- translation: Vec3Handle,
70
- ): PluginApiReturn<ProfileHandle>
71
-
72
- /**
73
- * Rotate a profile about an axis through an optional pivot. Immutable — returns a
74
- * NEW profile and leaves the input unchanged.
75
- *
76
- * @param profile The profile to rotate
77
- * @param axis Rotation axis direction
78
- * @param angle Rotation angle in radians
79
- * @param pivot Optional pivot point to rotate about (defaults to the origin)
80
- * @returns The rotated profile as a NEW {@linkcode ProfileHandle}
81
- *
82
- * @examplePrompt Rotate this outline 30 degrees
83
- * @examplePrompt Turn this boundary about its centre point
84
- *
85
- * # Example
86
- * ```ts
87
- * const rect = await snaptrude.core.geom.create.profileRect(6, 4)
88
- * const axis = await snaptrude.core.math.vec3.new(0, 1, 0)
89
- * const rotated = await snaptrude.core.geom.update.profile.rotate(rect, axis, Math.PI / 6)
90
- * ```
91
- */
92
- public abstract rotate(
93
- profile: ProfileHandle,
94
- axis: Vec3Handle,
95
- angle: number,
96
- pivot?: Vec3Handle,
97
- ): PluginApiReturn<ProfileHandle>
98
-
99
- /**
100
- * Scale a profile uniformly or per-axis about an optional pivot. Immutable —
101
- * returns a NEW profile and leaves the input unchanged.
102
- *
103
- * @param profile The profile to scale
104
- * @param factor Uniform scale factor, or per-axis factors
105
- * @param pivot Optional pivot point to scale about (defaults to the origin)
106
- * @returns The scaled profile as a NEW {@linkcode ProfileHandle}
107
- *
108
- * @examplePrompt Scale this outline down to half size
109
- * @examplePrompt Enlarge this boundary by 50 percent
110
- *
111
- * # Example
112
- * ```ts
113
- * const rect = await snaptrude.core.geom.create.profileRect(6, 4)
114
- * const half = await snaptrude.core.geom.update.profile.scale(rect, 0.5)
115
- * const stretched = await snaptrude.core.geom.update.profile.scale(rect, { x: 2, y: 1, z: 1 })
116
- * ```
117
- */
118
- public abstract scale(
119
- profile: ProfileHandle,
120
- factor: number | Vec3Components,
121
- pivot?: Vec3Handle,
122
- ): PluginApiReturn<ProfileHandle>
123
-
124
- /**
125
- * Mirror a profile across a plane. Immutable — returns a NEW profile and leaves
126
- * the input unchanged.
127
- *
128
- * @param profile The profile to mirror
129
- * @param plane Mirror plane defined by a point on it and its normal
130
- * @returns The mirrored profile as a NEW {@linkcode ProfileHandle}
131
- *
132
- * @examplePrompt Mirror this outline across the vertical plane
133
- * @examplePrompt Flip this boundary to its mirror image
134
- *
135
- * # Example
136
- * ```ts
137
- * const rect = await snaptrude.core.geom.create.profileRect(6, 4)
138
- * const point = await snaptrude.core.math.vec3.new(0, 0, 0)
139
- * const normal = await snaptrude.core.math.vec3.new(1, 0, 0)
140
- * const mirrored = await snaptrude.core.geom.update.profile.mirror(rect, { point, normal })
141
- * ```
142
- */
143
- public abstract mirror(
144
- profile: ProfileHandle,
145
- plane: { point: Vec3Handle; normal: Vec3Handle },
146
- ): PluginApiReturn<ProfileHandle>
147
-
148
- /**
149
- * Append a curve to the start or end of a profile. The curve must connect to the
150
- * chosen end. Immutable — returns a NEW profile and leaves the input unchanged.
151
- *
152
- * @param profile The profile to append to
153
- * @param curve The curve to append; it must connect to the chosen end
154
- * @param position Optional end to append at (defaults to `"end"`)
155
- * @returns The extended profile as a NEW {@linkcode ProfileHandle}
156
- *
157
- * # Example
158
- * ```ts
159
- * const rect = await snaptrude.core.geom.create.profileRect(4, 3)
160
- * const open = await snaptrude.core.geom.update.profile.remove(rect, "end")
161
- * const pts = await snaptrude.core.geom.query.profile.listPoints(open)
162
- * const last = pts[pts.length - 1]
163
- * const from = await snaptrude.core.math.vec3.new(last.x, last.y, last.z)
164
- * const to = await snaptrude.core.math.vec3.new(pts[0].x, pts[0].y, pts[0].z)
165
- * const closer = await snaptrude.core.geom.create.line(from, to)
166
- * const closed = await snaptrude.core.geom.update.profile.add(open, closer, "end")
167
- * ```
168
- */
169
- public abstract add(
170
- profile: ProfileHandle,
171
- curve: CurveHandle,
172
- position?: "start" | "end",
173
- ): PluginApiReturn<ProfileHandle>
174
-
175
- /**
176
- * Remove the curve at the start or end of a profile. Immutable — returns a NEW
177
- * profile and leaves the input unchanged.
178
- *
179
- * @param profile The profile to remove a curve from
180
- * @param position Optional end to remove from (defaults to `"end"`)
181
- * @returns The trimmed profile as a NEW {@linkcode ProfileHandle}
182
- *
183
- * # Example
184
- * ```ts
185
- * const rect = await snaptrude.core.geom.create.profileRect(4, 3)
186
- * const open = await snaptrude.core.geom.update.profile.remove(rect, "end")
187
- * const isClosed = await snaptrude.core.geom.query.profile.isClosed(open) // false
188
- * ```
189
- */
190
- public abstract remove(
191
- profile: ProfileHandle,
192
- position?: "start" | "end",
193
- ): PluginApiReturn<ProfileHandle>
194
-
195
- /**
196
- * Reverse the orientation of a profile. Immutable — returns a NEW profile and
197
- * leaves the input unchanged.
198
- *
199
- * @param profile The profile to reverse
200
- * @returns The reversed profile as a NEW {@linkcode ProfileHandle}
201
- *
202
- * # Example
203
- * ```ts
204
- * const rect = await snaptrude.core.geom.create.profileRect(4, 3)
205
- * const reversed = await snaptrude.core.geom.update.profile.reverse(rect)
206
- * const clockwise = await snaptrude.core.geom.query.profile.isClockwise(reversed)
207
- * ```
208
- */
209
- public abstract reverse(
210
- profile: ProfileHandle,
211
- ): PluginApiReturn<ProfileHandle>
212
-
213
- /**
214
- * Simplify a profile by merging collinear/redundant segments. Immutable —
215
- * returns a NEW profile and leaves the input unchanged.
216
- *
217
- * @param profile The profile to simplify
218
- * @returns The simplified profile as a NEW {@linkcode ProfileHandle}
219
- *
220
- * @examplePrompt Clean up this outline by merging collinear segments
221
- * @examplePrompt Simplify this polyline and remove redundant points
222
- *
223
- * # Example
224
- * ```ts
225
- * const p0 = await snaptrude.core.math.vec3.new(0, 0, 0)
226
- * const p1 = await snaptrude.core.math.vec3.new(2, 0, 0) // collinear with p0 and p2
227
- * const p2 = await snaptrude.core.math.vec3.new(4, 0, 0)
228
- * const p3 = await snaptrude.core.math.vec3.new(4, 0, 3)
229
- * const jagged = await snaptrude.core.geom.create.profileFromLinePoints([p0, p1, p2, p3])
230
- * const clean = await snaptrude.core.geom.update.profile.simplify(jagged)
231
- * const curves = await snaptrude.core.geom.query.profile.listCurves(clean) // p0→p2 merged
232
- * ```
233
- */
234
- public abstract simplify(
235
- profile: ProfileHandle,
236
- ): PluginApiReturn<ProfileHandle>
237
- }
238
-
239
- /**
240
- * Arguments for {@linkcode PluginGeomUpdateProfileApi.offset}.
241
- *
242
- * | Property | Type | Description |
243
- * |---|---|---|
244
- * | `profile` | {@linkcode ProfileHandle} | The closed profile to offset |
245
- * | `distance` | `number` | Signed offset distance (outward when positive, inward when negative) |
246
- */
247
- export const PluginGeomUpdateProfileOffsetArgs = z.object({
248
- profile: ProfileHandle,
249
- distance: z.number(),
250
- })
251
-
252
- export type PluginGeomUpdateProfileOffsetArgs = z.infer<typeof PluginGeomUpdateProfileOffsetArgs>
253
-
254
- /**
255
- * Arguments for {@linkcode PluginGeomUpdateProfileApi.move}.
256
- *
257
- * | Property | Type | Description |
258
- * |---|---|---|
259
- * | `profile` | {@linkcode ProfileHandle} | The profile to move |
260
- * | `translation` | {@linkcode Vec3Handle} | Translation vector to move the profile by |
261
- */
262
- export const PluginGeomUpdateProfileMoveArgs = z.object({
263
- profile: ProfileHandle,
264
- translation: Vec3Handle,
265
- })
266
-
267
- export type PluginGeomUpdateProfileMoveArgs = z.infer<typeof PluginGeomUpdateProfileMoveArgs>
268
-
269
- /**
270
- * Arguments for {@linkcode PluginGeomUpdateProfileApi.rotate}.
271
- *
272
- * | Property | Type | Description |
273
- * |---|---|---|
274
- * | `profile` | {@linkcode ProfileHandle} | The profile to rotate |
275
- * | `axis` | {@linkcode Vec3Handle} | Rotation axis direction |
276
- * | `angle` | `number` | Rotation angle in radians |
277
- * | `pivot` | {@linkcode Vec3Handle} | Optional pivot point to rotate about (defaults to the origin) |
278
- */
279
- export const PluginGeomUpdateProfileRotateArgs = z.object({
280
- profile: ProfileHandle,
281
- axis: Vec3Handle,
282
- angle: z.number(),
283
- pivot: Vec3Handle.optional(),
284
- })
285
-
286
- export type PluginGeomUpdateProfileRotateArgs = z.infer<typeof PluginGeomUpdateProfileRotateArgs>
287
-
288
- /**
289
- * Arguments for {@linkcode PluginGeomUpdateProfileApi.scale}.
290
- *
291
- * | Property | Type | Description |
292
- * |---|---|---|
293
- * | `profile` | {@linkcode ProfileHandle} | The profile to scale |
294
- * | `factor` | `number` \| {@linkcode Vec3Components} | Uniform scale factor, or per-axis factors |
295
- * | `pivot` | {@linkcode Vec3Handle} | Optional pivot point to scale about (defaults to the origin) |
296
- */
297
- export const PluginGeomUpdateProfileScaleArgs = z.object({
298
- profile: ProfileHandle,
299
- factor: z.union([z.number(), Vec3Components]),
300
- pivot: Vec3Handle.optional(),
301
- })
302
-
303
- export type PluginGeomUpdateProfileScaleArgs = z.infer<typeof PluginGeomUpdateProfileScaleArgs>
304
-
305
- /**
306
- * Arguments for {@linkcode PluginGeomUpdateProfileApi.mirror}.
307
- *
308
- * | Property | Type | Description |
309
- * |---|---|---|
310
- * | `profile` | {@linkcode ProfileHandle} | The profile to mirror |
311
- * | `plane` | `{ point: `{@linkcode Vec3Handle}`, normal: `{@linkcode Vec3Handle}` }` | Mirror plane defined by a point on it and its normal |
312
- */
313
- export const PluginGeomUpdateProfileMirrorArgs = z.object({
314
- profile: ProfileHandle,
315
- plane: z.object({
316
- point: Vec3Handle,
317
- normal: Vec3Handle,
318
- }),
319
- })
320
-
321
- export type PluginGeomUpdateProfileMirrorArgs = z.infer<typeof PluginGeomUpdateProfileMirrorArgs>
322
-
323
- /**
324
- * Arguments for {@linkcode PluginGeomUpdateProfileApi.add}.
325
- *
326
- * | Property | Type | Description |
327
- * |---|---|---|
328
- * | `profile` | {@linkcode ProfileHandle} | The profile to append to |
329
- * | `curve` | {@linkcode CurveHandle} | The curve to append; it must connect to the chosen end |
330
- * | `position` | `"start"` \| `"end"` | Optional end to append at (defaults to `"end"`) |
331
- */
332
- export const PluginGeomUpdateProfileAddArgs = z.object({
333
- profile: ProfileHandle,
334
- curve: CurveHandle,
335
- position: z.enum(["start", "end"]).optional(),
336
- })
337
-
338
- export type PluginGeomUpdateProfileAddArgs = z.infer<typeof PluginGeomUpdateProfileAddArgs>
339
-
340
- /**
341
- * Arguments for {@linkcode PluginGeomUpdateProfileApi.remove}.
342
- *
343
- * | Property | Type | Description |
344
- * |---|---|---|
345
- * | `profile` | {@linkcode ProfileHandle} | The profile to remove a curve from |
346
- * | `position` | `"start"` \| `"end"` | Optional end to remove from (defaults to `"end"`) |
347
- */
348
- export const PluginGeomUpdateProfileRemoveArgs = z.object({
349
- profile: ProfileHandle,
350
- position: z.enum(["start", "end"]).optional(),
351
- })
352
-
353
- export type PluginGeomUpdateProfileRemoveArgs = z.infer<typeof PluginGeomUpdateProfileRemoveArgs>
354
-
355
- /**
356
- * Arguments for {@linkcode PluginGeomUpdateProfileApi.reverse}.
357
- *
358
- * | Property | Type | Description |
359
- * |---|---|---|
360
- * | `profile` | {@linkcode ProfileHandle} | The profile to reverse |
361
- */
362
- export const PluginGeomUpdateProfileReverseArgs = z.object({
363
- profile: ProfileHandle,
364
- })
365
-
366
- export type PluginGeomUpdateProfileReverseArgs = z.infer<typeof PluginGeomUpdateProfileReverseArgs>
367
-
368
- /**
369
- * Arguments for {@linkcode PluginGeomUpdateProfileApi.simplify}.
370
- *
371
- * | Property | Type | Description |
372
- * |---|---|---|
373
- * | `profile` | {@linkcode ProfileHandle} | The profile to simplify |
374
- */
375
- export const PluginGeomUpdateProfileSimplifyArgs = z.object({
376
- profile: ProfileHandle,
377
- })
378
-
379
- export type PluginGeomUpdateProfileSimplifyArgs = z.infer<typeof PluginGeomUpdateProfileSimplifyArgs>
1
+ import * as z from "zod"
2
+ import { PluginApiReturn } from "../../../../types"
3
+ import {
4
+ ProfileHandle,
5
+ Vec3Handle,
6
+ CurveHandle,
7
+ Vec3Components,
8
+ } from "../../../../handles"
9
+
10
+ /**
11
+ * Profile editing — produce NEW profiles from an existing one (all-handle model, §11).
12
+ *
13
+ * Every method is an immutable derive-new operation: it takes an opaque
14
+ * {@linkcode ProfileHandle} (plus any extra inputs) and returns a fresh
15
+ * {@linkcode ProfileHandle} for the resulting profile. The input profile is never
16
+ * mutated — the original handle keeps referring to the unchanged profile. Read the
17
+ * resulting geometry back as plain values with the query namespace.
18
+ *
19
+ * Accessed via `snaptrude.core.geom.update.profile`.
20
+ */
21
+ export abstract class PluginGeomUpdateProfileApi {
22
+ constructor() {}
23
+
24
+ /**
25
+ * Offset a closed profile inward/outward by a signed distance. Immutable —
26
+ * returns a NEW profile and leaves the input unchanged.
27
+ *
28
+ * @param profile The closed profile to offset
29
+ * @param distance Signed offset distance (outward when positive, inward when negative)
30
+ * @returns The offset profile as a NEW {@linkcode ProfileHandle}
31
+ * @throws PRECONDITION_FAILED if the profile has a spline run (splines cannot
32
+ * be offset yet)
33
+ *
34
+ * @examplePrompt Offset this outline 300mm inward
35
+ * @examplePrompt Inset this boundary by a foot all around
36
+ *
37
+ * # Example
38
+ * ```ts
39
+ * const rect = await snaptrude.core.geom.create.profileRect(10, 8)
40
+ * const inset = await snaptrude.core.geom.update.profile.offset(rect, -0.3)
41
+ * const area = await snaptrude.core.geom.query.profile.getArea(inset)
42
+ * ```
43
+ */
44
+ public abstract offset(
45
+ profile: ProfileHandle,
46
+ distance: number,
47
+ ): PluginApiReturn<ProfileHandle>
48
+
49
+ /**
50
+ * Translate a profile by a vector. Immutable — returns a NEW profile and leaves
51
+ * the input unchanged.
52
+ *
53
+ * @param profile The profile to move
54
+ * @param translation Translation vector to move the profile by
55
+ * @returns The moved profile as a NEW {@linkcode ProfileHandle}
56
+ *
57
+ * @examplePrompt Move this outline 3 metres along the x axis
58
+ * @examplePrompt Shift this boundary to a new position
59
+ *
60
+ * # Example
61
+ * ```ts
62
+ * const rect = await snaptrude.core.geom.create.profileRect(6, 4)
63
+ * const shift = await snaptrude.core.math.vec3.new(3, 0, 0)
64
+ * const moved = await snaptrude.core.geom.update.profile.move(rect, shift)
65
+ * ```
66
+ */
67
+ public abstract move(
68
+ profile: ProfileHandle,
69
+ translation: Vec3Handle,
70
+ ): PluginApiReturn<ProfileHandle>
71
+
72
+ /**
73
+ * Rotate a profile about an axis through an optional pivot. Immutable — returns a
74
+ * NEW profile and leaves the input unchanged.
75
+ *
76
+ * @param profile The profile to rotate
77
+ * @param axis Rotation axis direction
78
+ * @param angle Rotation angle in radians
79
+ * @param pivot Optional pivot point to rotate about (defaults to the origin)
80
+ * @returns The rotated profile as a NEW {@linkcode ProfileHandle}
81
+ *
82
+ * @examplePrompt Rotate this outline 30 degrees
83
+ * @examplePrompt Turn this boundary about its centre point
84
+ *
85
+ * # Example
86
+ * ```ts
87
+ * const rect = await snaptrude.core.geom.create.profileRect(6, 4)
88
+ * const axis = await snaptrude.core.math.vec3.new(0, 1, 0)
89
+ * const rotated = await snaptrude.core.geom.update.profile.rotate(rect, axis, Math.PI / 6)
90
+ * ```
91
+ */
92
+ public abstract rotate(
93
+ profile: ProfileHandle,
94
+ axis: Vec3Handle,
95
+ angle: number,
96
+ pivot?: Vec3Handle,
97
+ ): PluginApiReturn<ProfileHandle>
98
+
99
+ /**
100
+ * Scale a profile uniformly or per-axis about an optional pivot. Immutable —
101
+ * returns a NEW profile and leaves the input unchanged.
102
+ *
103
+ * @param profile The profile to scale
104
+ * @param factor Uniform scale factor, or per-axis factors
105
+ * @param pivot Optional pivot point to scale about (defaults to the origin)
106
+ * @returns The scaled profile as a NEW {@linkcode ProfileHandle}
107
+ *
108
+ * @examplePrompt Scale this outline down to half size
109
+ * @examplePrompt Enlarge this boundary by 50 percent
110
+ *
111
+ * # Example
112
+ * ```ts
113
+ * const rect = await snaptrude.core.geom.create.profileRect(6, 4)
114
+ * const half = await snaptrude.core.geom.update.profile.scale(rect, 0.5)
115
+ * const stretched = await snaptrude.core.geom.update.profile.scale(rect, { x: 2, y: 1, z: 1 })
116
+ * ```
117
+ */
118
+ public abstract scale(
119
+ profile: ProfileHandle,
120
+ factor: number | Vec3Components,
121
+ pivot?: Vec3Handle,
122
+ ): PluginApiReturn<ProfileHandle>
123
+
124
+ /**
125
+ * Mirror a profile across a plane. Immutable — returns a NEW profile and leaves
126
+ * the input unchanged.
127
+ *
128
+ * @param profile The profile to mirror
129
+ * @param plane Mirror plane defined by a point on it and its normal
130
+ * @returns The mirrored profile as a NEW {@linkcode ProfileHandle}
131
+ *
132
+ * @examplePrompt Mirror this outline across the vertical plane
133
+ * @examplePrompt Flip this boundary to its mirror image
134
+ *
135
+ * # Example
136
+ * ```ts
137
+ * const rect = await snaptrude.core.geom.create.profileRect(6, 4)
138
+ * const point = await snaptrude.core.math.vec3.new(0, 0, 0)
139
+ * const normal = await snaptrude.core.math.vec3.new(1, 0, 0)
140
+ * const mirrored = await snaptrude.core.geom.update.profile.mirror(rect, { point, normal })
141
+ * ```
142
+ */
143
+ public abstract mirror(
144
+ profile: ProfileHandle,
145
+ plane: { point: Vec3Handle; normal: Vec3Handle },
146
+ ): PluginApiReturn<ProfileHandle>
147
+
148
+ /**
149
+ * Append a curve to the start or end of a profile. The curve must connect to the
150
+ * chosen end. Immutable — returns a NEW profile and leaves the input unchanged.
151
+ *
152
+ * @param profile The profile to append to
153
+ * @param curve The curve to append; it must connect to the chosen end
154
+ * @param position Optional end to append at (defaults to `"end"`)
155
+ * @returns The extended profile as a NEW {@linkcode ProfileHandle}
156
+ *
157
+ * # Example
158
+ * ```ts
159
+ * const rect = await snaptrude.core.geom.create.profileRect(4, 3)
160
+ * const open = await snaptrude.core.geom.update.profile.remove(rect, "end")
161
+ * const pts = await snaptrude.core.geom.query.profile.listPoints(open)
162
+ * const last = pts[pts.length - 1]
163
+ * const from = await snaptrude.core.math.vec3.new(last.x, last.y, last.z)
164
+ * const to = await snaptrude.core.math.vec3.new(pts[0].x, pts[0].y, pts[0].z)
165
+ * const closer = await snaptrude.core.geom.create.line(from, to)
166
+ * const closed = await snaptrude.core.geom.update.profile.add(open, closer, "end")
167
+ * ```
168
+ */
169
+ public abstract add(
170
+ profile: ProfileHandle,
171
+ curve: CurveHandle,
172
+ position?: "start" | "end",
173
+ ): PluginApiReturn<ProfileHandle>
174
+
175
+ /**
176
+ * Remove the curve at the start or end of a profile. Immutable — returns a NEW
177
+ * profile and leaves the input unchanged.
178
+ *
179
+ * @param profile The profile to remove a curve from
180
+ * @param position Optional end to remove from (defaults to `"end"`)
181
+ * @returns The trimmed profile as a NEW {@linkcode ProfileHandle}
182
+ *
183
+ * # Example
184
+ * ```ts
185
+ * const rect = await snaptrude.core.geom.create.profileRect(4, 3)
186
+ * const open = await snaptrude.core.geom.update.profile.remove(rect, "end")
187
+ * const isClosed = await snaptrude.core.geom.query.profile.isClosed(open) // false
188
+ * ```
189
+ */
190
+ public abstract remove(
191
+ profile: ProfileHandle,
192
+ position?: "start" | "end",
193
+ ): PluginApiReturn<ProfileHandle>
194
+
195
+ /**
196
+ * Reverse the orientation of a profile. Immutable — returns a NEW profile and
197
+ * leaves the input unchanged.
198
+ *
199
+ * @param profile The profile to reverse
200
+ * @returns The reversed profile as a NEW {@linkcode ProfileHandle}
201
+ *
202
+ * # Example
203
+ * ```ts
204
+ * const rect = await snaptrude.core.geom.create.profileRect(4, 3)
205
+ * const reversed = await snaptrude.core.geom.update.profile.reverse(rect)
206
+ * const clockwise = await snaptrude.core.geom.query.profile.isClockwise(reversed)
207
+ * ```
208
+ */
209
+ public abstract reverse(
210
+ profile: ProfileHandle,
211
+ ): PluginApiReturn<ProfileHandle>
212
+
213
+ /**
214
+ * Simplify a profile by merging collinear/redundant segments. Immutable —
215
+ * returns a NEW profile and leaves the input unchanged.
216
+ *
217
+ * @param profile The profile to simplify
218
+ * @returns The simplified profile as a NEW {@linkcode ProfileHandle}
219
+ *
220
+ * @examplePrompt Clean up this outline by merging collinear segments
221
+ * @examplePrompt Simplify this polyline and remove redundant points
222
+ *
223
+ * # Example
224
+ * ```ts
225
+ * const p0 = await snaptrude.core.math.vec3.new(0, 0, 0)
226
+ * const p1 = await snaptrude.core.math.vec3.new(2, 0, 0) // collinear with p0 and p2
227
+ * const p2 = await snaptrude.core.math.vec3.new(4, 0, 0)
228
+ * const p3 = await snaptrude.core.math.vec3.new(4, 0, 3)
229
+ * const jagged = await snaptrude.core.geom.create.profileFromLinePoints([p0, p1, p2, p3])
230
+ * const clean = await snaptrude.core.geom.update.profile.simplify(jagged)
231
+ * const curves = await snaptrude.core.geom.query.profile.listCurves(clean) // p0→p2 merged
232
+ * ```
233
+ */
234
+ public abstract simplify(
235
+ profile: ProfileHandle,
236
+ ): PluginApiReturn<ProfileHandle>
237
+ }
238
+
239
+ /**
240
+ * Arguments for {@linkcode PluginGeomUpdateProfileApi.offset}.
241
+ *
242
+ * | Property | Type | Description |
243
+ * |---|---|---|
244
+ * | `profile` | {@linkcode ProfileHandle} | The closed profile to offset |
245
+ * | `distance` | `number` | Signed offset distance (outward when positive, inward when negative) |
246
+ */
247
+ export const PluginGeomUpdateProfileOffsetArgs = z.object({
248
+ profile: ProfileHandle,
249
+ distance: z.number(),
250
+ })
251
+
252
+ export type PluginGeomUpdateProfileOffsetArgs = z.infer<typeof PluginGeomUpdateProfileOffsetArgs>
253
+
254
+ /**
255
+ * Arguments for {@linkcode PluginGeomUpdateProfileApi.move}.
256
+ *
257
+ * | Property | Type | Description |
258
+ * |---|---|---|
259
+ * | `profile` | {@linkcode ProfileHandle} | The profile to move |
260
+ * | `translation` | {@linkcode Vec3Handle} | Translation vector to move the profile by |
261
+ */
262
+ export const PluginGeomUpdateProfileMoveArgs = z.object({
263
+ profile: ProfileHandle,
264
+ translation: Vec3Handle,
265
+ })
266
+
267
+ export type PluginGeomUpdateProfileMoveArgs = z.infer<typeof PluginGeomUpdateProfileMoveArgs>
268
+
269
+ /**
270
+ * Arguments for {@linkcode PluginGeomUpdateProfileApi.rotate}.
271
+ *
272
+ * | Property | Type | Description |
273
+ * |---|---|---|
274
+ * | `profile` | {@linkcode ProfileHandle} | The profile to rotate |
275
+ * | `axis` | {@linkcode Vec3Handle} | Rotation axis direction |
276
+ * | `angle` | `number` | Rotation angle in radians |
277
+ * | `pivot` | {@linkcode Vec3Handle} | Optional pivot point to rotate about (defaults to the origin) |
278
+ */
279
+ export const PluginGeomUpdateProfileRotateArgs = z.object({
280
+ profile: ProfileHandle,
281
+ axis: Vec3Handle,
282
+ angle: z.number(),
283
+ pivot: Vec3Handle.optional(),
284
+ })
285
+
286
+ export type PluginGeomUpdateProfileRotateArgs = z.infer<typeof PluginGeomUpdateProfileRotateArgs>
287
+
288
+ /**
289
+ * Arguments for {@linkcode PluginGeomUpdateProfileApi.scale}.
290
+ *
291
+ * | Property | Type | Description |
292
+ * |---|---|---|
293
+ * | `profile` | {@linkcode ProfileHandle} | The profile to scale |
294
+ * | `factor` | `number` \| {@linkcode Vec3Components} | Uniform scale factor, or per-axis factors |
295
+ * | `pivot` | {@linkcode Vec3Handle} | Optional pivot point to scale about (defaults to the origin) |
296
+ */
297
+ export const PluginGeomUpdateProfileScaleArgs = z.object({
298
+ profile: ProfileHandle,
299
+ factor: z.union([z.number(), Vec3Components]),
300
+ pivot: Vec3Handle.optional(),
301
+ })
302
+
303
+ export type PluginGeomUpdateProfileScaleArgs = z.infer<typeof PluginGeomUpdateProfileScaleArgs>
304
+
305
+ /**
306
+ * Arguments for {@linkcode PluginGeomUpdateProfileApi.mirror}.
307
+ *
308
+ * | Property | Type | Description |
309
+ * |---|---|---|
310
+ * | `profile` | {@linkcode ProfileHandle} | The profile to mirror |
311
+ * | `plane` | `{ point: `{@linkcode Vec3Handle}`, normal: `{@linkcode Vec3Handle}` }` | Mirror plane defined by a point on it and its normal |
312
+ */
313
+ export const PluginGeomUpdateProfileMirrorArgs = z.object({
314
+ profile: ProfileHandle,
315
+ plane: z.object({
316
+ point: Vec3Handle,
317
+ normal: Vec3Handle,
318
+ }),
319
+ })
320
+
321
+ export type PluginGeomUpdateProfileMirrorArgs = z.infer<typeof PluginGeomUpdateProfileMirrorArgs>
322
+
323
+ /**
324
+ * Arguments for {@linkcode PluginGeomUpdateProfileApi.add}.
325
+ *
326
+ * | Property | Type | Description |
327
+ * |---|---|---|
328
+ * | `profile` | {@linkcode ProfileHandle} | The profile to append to |
329
+ * | `curve` | {@linkcode CurveHandle} | The curve to append; it must connect to the chosen end |
330
+ * | `position` | `"start"` \| `"end"` | Optional end to append at (defaults to `"end"`) |
331
+ */
332
+ export const PluginGeomUpdateProfileAddArgs = z.object({
333
+ profile: ProfileHandle,
334
+ curve: CurveHandle,
335
+ position: z.enum(["start", "end"]).optional(),
336
+ })
337
+
338
+ export type PluginGeomUpdateProfileAddArgs = z.infer<typeof PluginGeomUpdateProfileAddArgs>
339
+
340
+ /**
341
+ * Arguments for {@linkcode PluginGeomUpdateProfileApi.remove}.
342
+ *
343
+ * | Property | Type | Description |
344
+ * |---|---|---|
345
+ * | `profile` | {@linkcode ProfileHandle} | The profile to remove a curve from |
346
+ * | `position` | `"start"` \| `"end"` | Optional end to remove from (defaults to `"end"`) |
347
+ */
348
+ export const PluginGeomUpdateProfileRemoveArgs = z.object({
349
+ profile: ProfileHandle,
350
+ position: z.enum(["start", "end"]).optional(),
351
+ })
352
+
353
+ export type PluginGeomUpdateProfileRemoveArgs = z.infer<typeof PluginGeomUpdateProfileRemoveArgs>
354
+
355
+ /**
356
+ * Arguments for {@linkcode PluginGeomUpdateProfileApi.reverse}.
357
+ *
358
+ * | Property | Type | Description |
359
+ * |---|---|---|
360
+ * | `profile` | {@linkcode ProfileHandle} | The profile to reverse |
361
+ */
362
+ export const PluginGeomUpdateProfileReverseArgs = z.object({
363
+ profile: ProfileHandle,
364
+ })
365
+
366
+ export type PluginGeomUpdateProfileReverseArgs = z.infer<typeof PluginGeomUpdateProfileReverseArgs>
367
+
368
+ /**
369
+ * Arguments for {@linkcode PluginGeomUpdateProfileApi.simplify}.
370
+ *
371
+ * | Property | Type | Description |
372
+ * |---|---|---|
373
+ * | `profile` | {@linkcode ProfileHandle} | The profile to simplify |
374
+ */
375
+ export const PluginGeomUpdateProfileSimplifyArgs = z.object({
376
+ profile: ProfileHandle,
377
+ })
378
+
379
+ export type PluginGeomUpdateProfileSimplifyArgs = z.infer<typeof PluginGeomUpdateProfileSimplifyArgs>