@snaptrude/plugin-core 0.0.0-dev-20260708130115 → 0.0.0-dev-20260827135706
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.
- package/CHANGELOG.md +152 -1
- package/api-manifest.json +3620 -276
- package/dist/api/analysis/daylight.d.ts +603 -0
- package/dist/api/analysis/daylight.d.ts.map +1 -0
- package/dist/api/analysis/heatmaps.d.ts +658 -0
- package/dist/api/analysis/heatmaps.d.ts.map +1 -0
- package/dist/api/analysis/illuminance.d.ts +145 -0
- package/dist/api/analysis/illuminance.d.ts.map +1 -0
- package/dist/api/analysis/index.d.ts +59 -0
- package/dist/api/analysis/index.d.ts.map +1 -0
- package/dist/api/analysis/shadows.d.ts +165 -0
- package/dist/api/analysis/shadows.d.ts.map +1 -0
- package/dist/api/analysis/solar.d.ts +249 -0
- package/dist/api/analysis/solar.d.ts.map +1 -0
- package/dist/api/analysis/sunlightHours.d.ts +208 -0
- package/dist/api/analysis/sunlightHours.d.ts.map +1 -0
- package/dist/api/analysis/sunpath.d.ts +80 -0
- package/dist/api/analysis/sunpath.d.ts.map +1 -0
- package/dist/api/analysis/weather.d.ts +193 -0
- package/dist/api/analysis/weather.d.ts.map +1 -0
- package/dist/api/core/camera/index.d.ts +261 -0
- package/dist/api/core/camera/index.d.ts.map +1 -0
- package/dist/api/core/comment/index.d.ts +105 -2
- package/dist/api/core/comment/index.d.ts.map +1 -1
- package/dist/api/core/geom/create/index.d.ts +840 -14
- package/dist/api/core/geom/create/index.d.ts.map +1 -1
- package/dist/api/core/geom/delete/index.d.ts +8 -2
- package/dist/api/core/geom/delete/index.d.ts.map +1 -1
- package/dist/api/core/geom/query/arc.d.ts +5 -5
- package/dist/api/core/geom/query/brep.d.ts +130 -18
- package/dist/api/core/geom/query/brep.d.ts.map +1 -1
- package/dist/api/core/geom/query/circle.d.ts +18 -18
- package/dist/api/core/geom/query/contour.d.ts +20 -20
- package/dist/api/core/geom/query/curve.d.ts +49 -49
- package/dist/api/core/geom/query/edge.d.ts +5 -5
- package/dist/api/core/geom/query/face.d.ts +16 -16
- package/dist/api/core/geom/query/halfedge.d.ts +8 -8
- package/dist/api/core/geom/query/profile.d.ts +19 -19
- package/dist/api/core/geom/query/vertex.d.ts +8 -8
- package/dist/api/core/geom/update/contour.d.ts +14 -14
- package/dist/api/core/geom/update/curve.d.ts +7 -7
- package/dist/api/core/geom/update/profile.d.ts +16 -16
- package/dist/api/core/handles/index.d.ts +210 -0
- package/dist/api/core/handles/index.d.ts.map +1 -0
- package/dist/api/core/index.d.ts +34 -0
- package/dist/api/core/index.d.ts.map +1 -1
- package/dist/api/core/io/export/index.d.ts +134 -0
- package/dist/api/core/io/export/index.d.ts.map +1 -0
- package/dist/api/core/io/import/index.d.ts +453 -0
- package/dist/api/core/io/import/index.d.ts.map +1 -0
- package/dist/api/core/io/index.d.ts +40 -0
- package/dist/api/core/io/index.d.ts.map +1 -0
- package/dist/api/core/io/job/index.d.ts +139 -0
- package/dist/api/core/io/job/index.d.ts.map +1 -0
- package/dist/api/core/io/query/index.d.ts +74 -0
- package/dist/api/core/io/query/index.d.ts.map +1 -0
- package/dist/api/core/io/terrain/index.d.ts +341 -0
- package/dist/api/core/io/terrain/index.d.ts.map +1 -0
- package/dist/api/core/io/underlay/index.d.ts +805 -0
- package/dist/api/core/io/underlay/index.d.ts.map +1 -0
- package/dist/api/core/layers.d.ts +7 -7
- package/dist/api/core/mode/index.d.ts +99 -0
- package/dist/api/core/mode/index.d.ts.map +1 -0
- package/dist/api/core/project/index.d.ts +68 -1
- package/dist/api/core/project/index.d.ts.map +1 -1
- package/dist/api/core/proposals/index.d.ts +531 -0
- package/dist/api/core/proposals/index.d.ts.map +1 -0
- package/dist/api/core/storeys/index.d.ts +265 -0
- package/dist/api/core/storeys/index.d.ts.map +1 -0
- package/dist/api/core/tags.d.ts +24 -0
- package/dist/api/core/tags.d.ts.map +1 -1
- package/dist/api/core/user.d.ts +44 -0
- package/dist/api/core/user.d.ts.map +1 -0
- package/dist/api/core/zoom/index.d.ts +4 -0
- package/dist/api/core/zoom/index.d.ts.map +1 -1
- package/dist/api/design/boolean/index.d.ts +4 -4
- package/dist/api/design/create/index.d.ts +568 -45
- package/dist/api/design/create/index.d.ts.map +1 -1
- package/dist/api/design/delete/index.d.ts +3 -0
- package/dist/api/design/delete/index.d.ts.map +1 -1
- package/dist/api/design/doors/index.d.ts +195 -0
- package/dist/api/design/doors/index.d.ts.map +1 -1
- package/dist/api/design/edit/index.d.ts +1 -1
- package/dist/api/design/erase/index.d.ts +2 -2
- package/dist/api/design/family.d.ts +349 -0
- package/dist/api/design/family.d.ts.map +1 -0
- package/dist/api/design/furniture/index.d.ts +181 -8
- package/dist/api/design/furniture/index.d.ts.map +1 -1
- package/dist/api/design/index.d.ts +98 -0
- package/dist/api/design/index.d.ts.map +1 -1
- package/dist/api/design/lock.d.ts +26 -0
- package/dist/api/design/lock.d.ts.map +1 -1
- package/dist/api/design/materials/index.d.ts +270 -16
- package/dist/api/design/materials/index.d.ts.map +1 -1
- package/dist/api/design/query/geometry/index.d.ts +112 -0
- package/dist/api/design/query/geometry/index.d.ts.map +1 -1
- package/dist/api/design/query/index.d.ts +282 -11
- package/dist/api/design/query/index.d.ts.map +1 -1
- package/dist/api/design/query/referenceLines.d.ts +45 -0
- package/dist/api/design/query/referenceLines.d.ts.map +1 -0
- package/dist/api/design/query/spaces.d.ts +181 -8
- package/dist/api/design/query/spaces.d.ts.map +1 -1
- package/dist/api/design/selection/index.d.ts +144 -0
- package/dist/api/design/selection/index.d.ts.map +1 -1
- package/dist/api/design/transform/index.d.ts +172 -10
- package/dist/api/design/transform/index.d.ts.map +1 -1
- package/dist/api/design/types/index.d.ts +181 -0
- package/dist/api/design/types/index.d.ts.map +1 -0
- package/dist/api/design/update/index.d.ts +553 -2
- package/dist/api/design/update/index.d.ts.map +1 -1
- package/dist/api/design/visibility.d.ts +126 -0
- package/dist/api/design/visibility.d.ts.map +1 -0
- package/dist/api/design/windows/index.d.ts +113 -2
- package/dist/api/design/windows/index.d.ts.map +1 -1
- package/dist/api/entity/buildableEnvelope.d.ts +4 -0
- package/dist/api/entity/buildableEnvelope.d.ts.map +1 -1
- package/dist/api/entity/referenceLine.d.ts +10 -2
- package/dist/api/entity/referenceLine.d.ts.map +1 -1
- package/dist/api/entity/space.d.ts +21 -21
- package/dist/api/entity/story.d.ts +242 -15
- package/dist/api/entity/story.d.ts.map +1 -1
- package/dist/api/index.d.ts +10 -0
- package/dist/api/index.d.ts.map +1 -1
- package/dist/api/presentation/aiInspiration.d.ts +25 -25
- package/dist/api/presentation/annotate.d.ts +467 -0
- package/dist/api/presentation/annotate.d.ts.map +1 -0
- package/dist/api/presentation/diagrams.d.ts +111 -8
- package/dist/api/presentation/diagrams.d.ts.map +1 -1
- package/dist/api/presentation/export.d.ts +108 -0
- package/dist/api/presentation/export.d.ts.map +1 -0
- package/dist/api/presentation/import.d.ts +55 -4
- package/dist/api/presentation/import.d.ts.map +1 -1
- package/dist/api/presentation/index.d.ts +58 -1
- package/dist/api/presentation/index.d.ts.map +1 -1
- package/dist/api/presentation/placedViews.d.ts +1139 -0
- package/dist/api/presentation/placedViews.d.ts.map +1 -0
- package/dist/api/presentation/shapes.d.ts +481 -0
- package/dist/api/presentation/shapes.d.ts.map +1 -0
- package/dist/api/presentation/sheets.d.ts +452 -13
- package/dist/api/presentation/sheets.d.ts.map +1 -1
- package/dist/api/presentation/slideshow.d.ts +125 -0
- package/dist/api/presentation/slideshow.d.ts.map +1 -0
- package/dist/api/presentation/tables.d.ts +81 -0
- package/dist/api/presentation/tables.d.ts.map +1 -0
- package/dist/api/presentation/views.d.ts +367 -7
- package/dist/api/presentation/views.d.ts.map +1 -1
- package/dist/api/program/areas.d.ts +102 -12
- package/dist/api/program/areas.d.ts.map +1 -1
- package/dist/api/program/cores.d.ts +3 -99
- package/dist/api/program/cores.d.ts.map +1 -1
- package/dist/api/program/index.d.ts +7 -15
- package/dist/api/program/index.d.ts.map +1 -1
- package/dist/api/program/layout.d.ts +346 -11
- package/dist/api/program/layout.d.ts.map +1 -1
- package/dist/api/program/site.d.ts +469 -13
- package/dist/api/program/site.d.ts.map +1 -1
- package/dist/api/program/spreadsheet.d.ts +365 -41
- package/dist/api/program/spreadsheet.d.ts.map +1 -1
- package/dist/api/workspace/index.d.ts +505 -0
- package/dist/api/workspace/index.d.ts.map +1 -0
- package/dist/errors/codes.d.ts +34 -0
- package/dist/errors/codes.d.ts.map +1 -0
- package/dist/errors/envelope.d.ts +56 -0
- package/dist/errors/envelope.d.ts.map +1 -0
- package/dist/errors/index.d.ts +6 -0
- package/dist/errors/index.d.ts.map +1 -0
- package/dist/errors/plugin-error.d.ts +69 -0
- package/dist/errors/plugin-error.d.ts.map +1 -0
- package/dist/handles.d.ts +97 -25
- package/dist/handles.d.ts.map +1 -1
- package/dist/host-utils.d.ts +4 -0
- package/dist/host-utils.d.ts.map +1 -1
- package/dist/index.cjs +4582 -1422
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +4171 -1411
- package/dist/index.js.map +1 -1
- package/package.json +4 -2
- package/scripts/generate-manifest.mjs +45 -0
- package/scripts/generate-manifest.test.mjs +103 -4
- package/src/api/analysis/daylight.ts +470 -0
- package/src/api/analysis/heatmaps.ts +683 -0
- package/src/api/analysis/illuminance.ts +155 -0
- package/src/api/analysis/index.ts +61 -0
- package/src/api/analysis/shadows.ts +183 -0
- package/src/api/analysis/solar.ts +237 -0
- package/src/api/analysis/sunlightHours.ts +211 -0
- package/src/api/analysis/sunpath.ts +83 -0
- package/src/api/analysis/weather.ts +179 -0
- package/src/api/core/camera/index.ts +268 -0
- package/src/api/core/comment/index.ts +120 -2
- package/src/api/core/geom/create/index.ts +912 -1
- package/src/api/core/geom/delete/index.ts +6 -0
- package/src/api/core/geom/query/brep.ts +119 -0
- package/src/api/core/handles/index.ts +233 -0
- package/src/api/core/index.ts +34 -0
- package/src/api/core/io/export/index.ts +126 -0
- package/src/api/core/io/import/index.ts +496 -0
- package/src/api/core/io/index.ts +42 -0
- package/src/api/core/io/job/index.ts +140 -0
- package/src/api/core/io/query/index.ts +71 -0
- package/src/api/core/io/terrain/index.ts +360 -0
- package/src/api/core/io/underlay/index.ts +705 -0
- package/src/api/core/mode/index.ts +96 -0
- package/src/api/core/project/index.ts +62 -1
- package/src/api/core/proposals/index.ts +569 -0
- package/src/api/core/storeys/index.ts +294 -0
- package/src/api/core/tags.ts +27 -0
- package/src/api/core/user.ts +46 -0
- package/src/api/core/zoom/index.ts +4 -0
- package/src/api/design/create/index.ts +670 -30
- package/src/api/design/delete/index.ts +3 -0
- package/src/api/design/doors/index.ts +208 -0
- package/src/api/design/erase/index.ts +1 -1
- package/src/api/design/family.ts +388 -0
- package/src/api/design/furniture/index.ts +197 -8
- package/src/api/design/index.ts +102 -0
- package/src/api/design/lock.ts +27 -0
- package/src/api/design/materials/index.ts +334 -27
- package/src/api/design/query/geometry/index.ts +125 -3
- package/src/api/design/query/index.ts +217 -7
- package/src/api/design/query/referenceLines.ts +52 -0
- package/src/api/design/query/spaces.ts +143 -0
- package/src/api/design/selection/index.ts +129 -0
- package/src/api/design/transform/index.ts +170 -9
- package/src/api/design/types/index.ts +156 -0
- package/src/api/design/update/index.ts +631 -3
- package/src/api/design/visibility.ts +143 -0
- package/src/api/design/windows/index.ts +128 -2
- package/src/api/entity/buildableEnvelope.ts +4 -0
- package/src/api/entity/referenceLine.ts +8 -0
- package/src/api/entity/story.ts +259 -15
- package/src/api/index.ts +10 -0
- package/src/api/presentation/annotate.ts +385 -0
- package/src/api/presentation/diagrams.ts +118 -8
- package/src/api/presentation/export.ts +108 -0
- package/src/api/presentation/import.ts +51 -4
- package/src/api/presentation/index.ts +66 -1
- package/src/api/presentation/placedViews.ts +1120 -0
- package/src/api/presentation/shapes.ts +274 -0
- package/src/api/presentation/sheets.ts +400 -13
- package/src/api/presentation/slideshow.ts +134 -0
- package/src/api/presentation/tables.ts +84 -0
- package/src/api/presentation/views.ts +376 -8
- package/src/api/program/areas.ts +88 -15
- package/src/api/program/cores.ts +3 -91
- package/src/api/program/index.ts +7 -15
- package/src/api/program/layout.ts +365 -11
- package/src/api/program/site.ts +435 -13
- package/src/api/program/spreadsheet.ts +376 -35
- package/src/api/workspace/index.ts +563 -0
- package/src/errors/codes.ts +136 -0
- package/src/errors/envelope.ts +75 -0
- package/src/errors/index.ts +21 -0
- package/src/errors/plugin-error.ts +134 -0
- package/src/handles.ts +123 -13
- package/src/host-utils.ts +4 -0
- package/src/index.ts +1 -0
- package/test/errors.test.mjs +184 -0
- package/tsconfig.json +7 -2
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"views.d.ts","sourceRoot":"","sources":["../../../src/api/presentation/views.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C
|
|
1
|
+
{"version":3,"file":"views.d.ts","sourceRoot":"","sources":["../../../src/api/presentation/views.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C;;;;;;;;;;;;;;;GAeG;AACH,8BAAsB,0BAA0B;;IAG9C;;;;;;;;;;;;;;;;;;OAkBG;aACa,IAAI,IAAI,eAAe,CAAC,iCAAiC,CAAC;IAE1E;;;;;;;;;;;;;;;OAeG;aACa,GAAG,CACjB,MAAM,EAAE,MAAM,GACb,eAAe,CAAC,gCAAgC,CAAC;IAEpD;;;;;;;;;;;;;;OAcG;aACa,SAAS,IAAI,eAAe,CAAC,gCAAgC,CAAC;IAE9E;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,OAAO,CAAC,OAAO,CAAC,EAAE;QAChC,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,CAAA;QACvB,UAAU,CAAC,EAAE,MAAM,CAAA;KACpB,GAAG,eAAe,CAAC,oCAAoC,CAAC;IAEzD;;;;;;;;;;;;;;;;;;;OAmBG;aACa,SAAS,CACvB,MAAM,EAAE,MAAM,GACb,eAAe,CAAC,sCAAsC,CAAC;IAE1D;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;aACa,MAAM,CACpB,IAAI,CAAC,EAAE,MAAM,EACb,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GACxD,eAAe,CAAC,mCAAmC,CAAC;IAEvD;;;;;;;;;;;;;;;;;;OAkBG;aACa,WAAW,CACzB,MAAM,EAAE,MAAM,GACb,eAAe,CAAC,wCAAwC,CAAC;IAE5D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiEG;aACa,cAAc,CAC5B,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,OAAO,CAAC,8BAA8B,CAAC,GAChD,eAAe,CAAC,2CAA2C,CAAC;IAE/D;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,MAAM,CACpB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,GACX,eAAe,CAAC,mCAAmC,CAAC;IAEvD;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,MAAM,CACpB,MAAM,EAAE,MAAM,GACb,eAAe,CAAC,mCAAmC,CAAC;CACxD;AAED;;GAEG;AACH,eAAO,MAAM,0BAA0B;;;EAAuB,CAAA;AAC9D,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;iBAMjC,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;GAMG;AACH,eAAO,MAAM,iCAAiC;;;;;;;;;;;iBAE5C,CAAA;AACF,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,8BAA8B;;iBAEzC,CAAA;AACF,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,gCAAgC;;;;;;;;;kBACV,CAAA;AACnC,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA;AAED,uEAAuE;AACvE,eAAO,MAAM,6BAA6B;;;EAA0B,CAAA;AACpE,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,kCAAkC;;;;;;;iBAI7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,oCAAoC;;iBAE/C,CAAA;AACF,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CACxD,OAAO,oCAAoC,CAC5C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,oCAAoC;;iBAE/C,CAAA;AACF,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CACxD,OAAO,oCAAoC,CAC5C,CAAA;AAED,yFAAyF;AACzF,eAAO,MAAM,sCAAsC;;iBAEjD,CAAA;AACF,MAAM,MAAM,sCAAsC,GAAG,CAAC,CAAC,KAAK,CAC1D,OAAO,sCAAsC,CAC9C,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,iCAAiC;;;;;;;iBAI5C,CAAA;AACF,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED,gFAAgF;AAChF,eAAO,MAAM,mCAAmC;;;;;;;;;iBAAyB,CAAA;AACzE,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,+BAA+B;;;;2CAG1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,2BAA2B;;;;EAItC,CAAA;AACF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAC/C,OAAO,2BAA2B,CACnC,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,0BAA0B;;;EAAuC,CAAA;AAC9E,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;iBAQzC,CAAA;AACF,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,sCAAsC;;iBAEjD,CAAA;AACF,MAAM,MAAM,sCAAsC,GAAG,CAAC,CAAC,KAAK,CAC1D,OAAO,sCAAsC,CAC9C,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,wCAAwC;;;;;;;;;;;;;;;;;;;kBACV,CAAA;AAC3C,MAAM,MAAM,wCAAwC,GAAG,CAAC,CAAC,KAAK,CAC5D,OAAO,wCAAwC,CAChD,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,yCAAyC;;;;;;;;;;;;;;;;;;;;;;iBA0BnD,CAAA;AACH,MAAM,MAAM,yCAAyC,GAAG,CAAC,CAAC,KAAK,CAC7D,OAAO,yCAAyC,CACjD,CAAA;AAED,+FAA+F;AAC/F,eAAO,MAAM,2CAA2C;;iBAEtD,CAAA;AACF,MAAM,MAAM,2CAA2C,GAAG,CAAC,CAAC,KAAK,CAC/D,OAAO,2CAA2C,CACnD,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,iCAAiC;;;iBAG5C,CAAA;AACF,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED,kFAAkF;AAClF,eAAO,MAAM,mCAAmC;;;;;;;;;iBAAyB,CAAA;AACzE,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,iCAAiC;;iBAE5C,CAAA;AACF,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,mCAAmC;;iBAE9C,CAAA;AACF,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA"}
|
|
@@ -10,15 +10,30 @@ import { ComponentHandle } from "../../handles";
|
|
|
10
10
|
* department-allocation lens (targets vs allocated area per department); this
|
|
11
11
|
* namespace is the whole-program area/FAR summary and its groupings.
|
|
12
12
|
*
|
|
13
|
+
* **Net vs gross:** the `carpet` / `builtUp` / `excluded` figures are the three
|
|
14
|
+
* area *classes* — every space's whole footprint lands in exactly one, chosen
|
|
15
|
+
* by its `areaClass` (see {@linkcode PluginProgramAreaMember.areaClass}). In UI
|
|
16
|
+
* terms `carpet` is the **Net Internal Area** (Σ of `NET`-classed spaces), and
|
|
17
|
+
* `builtUp` is the **Gross External Area** (Σ of `GROSS`-classed spaces) — so
|
|
18
|
+
* "net" and "gross" are the plain-English synonyms for `carpet` and `builtUp`.
|
|
19
|
+
* These are not wall-thickness carpet-vs-super-built-up; there is no common-area
|
|
20
|
+
* math. Note the summary also folds in non-mass elements (floors count as NET,
|
|
21
|
+
* slabs as GROSS), so **summing `listMembers` spaces does not reconcile to the
|
|
22
|
+
* summary totals**.
|
|
23
|
+
*
|
|
13
24
|
* `achievedFar` is **derived and read-only** — computed from built-up area and
|
|
14
25
|
* site area. `targetFar` is the goal you set (via {@linkcode
|
|
15
26
|
* PluginProgramAreasApi.update}); the two are the same ratio, one measured and
|
|
16
27
|
* one intended. The surface speaks **FAR only** — there is no FSI alias.
|
|
17
28
|
*
|
|
18
|
-
* Reads return plain records and never throw.
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
*
|
|
29
|
+
* Reads return plain records and never throw. Because the engine only recomputes
|
|
30
|
+
* the breakdown live while the Area sidebar is open, a headless plugin should call
|
|
31
|
+
* {@linkcode PluginProgramAreasApi.refresh} first to guarantee the reads are fresh.
|
|
32
|
+
* The only write — {@linkcode PluginProgramAreasApi.update} — is a non-undoable
|
|
33
|
+
* settings write for the FAR inputs. With an active design option (proposal),
|
|
34
|
+
* those inputs are per-option: `update` writes and the reads report the active
|
|
35
|
+
* option's own target FAR / site area / deviation, matching the product's Area
|
|
36
|
+
* settings dialog.
|
|
22
37
|
*
|
|
23
38
|
* Accessed via `snaptrude.program.areas`.
|
|
24
39
|
*/
|
|
@@ -35,6 +50,8 @@ export declare abstract class PluginProgramAreasApi {
|
|
|
35
50
|
*
|
|
36
51
|
* @examplePrompt What's my FAR right now?
|
|
37
52
|
* @examplePrompt Give me the program area summary
|
|
53
|
+
* @examplePrompt What is my net internal area vs gross external area?
|
|
54
|
+
* @examplePrompt How much net and gross area do I have?
|
|
38
55
|
* @examplePrompt How much built-up area have I used against the site area?
|
|
39
56
|
* @examplePrompt Am I within my FAR target?
|
|
40
57
|
*
|
|
@@ -58,6 +75,7 @@ export declare abstract class PluginProgramAreasApi {
|
|
|
58
75
|
* (empty when the program has no spaces).
|
|
59
76
|
*
|
|
60
77
|
* @examplePrompt Break down the area by storey
|
|
78
|
+
* @examplePrompt Break down net vs gross area by storey
|
|
61
79
|
* @examplePrompt Show the area rollup per department
|
|
62
80
|
* @examplePrompt Group the built-up area by building
|
|
63
81
|
*
|
|
@@ -84,6 +102,7 @@ export declare abstract class PluginProgramAreasApi {
|
|
|
84
102
|
* array (empty when the group is missing or empty).
|
|
85
103
|
*
|
|
86
104
|
* @examplePrompt List the spaces on this storey with their areas
|
|
105
|
+
* @examplePrompt Which spaces are net and which are gross on this storey?
|
|
87
106
|
* @examplePrompt What rooms are in the Bedrooms department bucket?
|
|
88
107
|
* @examplePrompt Break the storey area down into individual spaces
|
|
89
108
|
*
|
|
@@ -101,6 +120,13 @@ export declare abstract class PluginProgramAreasApi {
|
|
|
101
120
|
* area, and the allowed deviation. This is a **non-undoable settings write**
|
|
102
121
|
* (persisted with the project). `achievedFar` recomputes from these.
|
|
103
122
|
*
|
|
123
|
+
* **Design options:** when a design option (proposal) is active, the FAR
|
|
124
|
+
* inputs are **scoped to that design option** — exactly like the product's
|
|
125
|
+
* Area settings dialog. `update` writes the active option's settings (each
|
|
126
|
+
* option keeps its own target FAR / site area / deviation) and the reads
|
|
127
|
+
* ({@linkcode PluginProgramAreasApi.get} etc.) report that same scope.
|
|
128
|
+
* Without design options there is a single project-wide set of FAR inputs.
|
|
129
|
+
*
|
|
104
130
|
* @param options - Any of `targetFar`, `siteArea`, `deviation`; omitted fields
|
|
105
131
|
* are left unchanged.
|
|
106
132
|
* @returns The recomputed {@linkcode PluginProgramAreaSummary}.
|
|
@@ -121,6 +147,33 @@ export declare abstract class PluginProgramAreasApi {
|
|
|
121
147
|
siteArea?: number;
|
|
122
148
|
deviation?: number;
|
|
123
149
|
}): PluginApiReturn<PluginProgramAreasUpdateResult>;
|
|
150
|
+
/**
|
|
151
|
+
* Force the area breakdown to recompute, then return the fresh summary.
|
|
152
|
+
*
|
|
153
|
+
* The engine recomputes the carpet / built-up / FAR totals live **only while the
|
|
154
|
+
* Area sidebar is open**. A plugin running with the sidebar closed can therefore
|
|
155
|
+
* read a stale — or never-computed — snapshot from {@linkcode
|
|
156
|
+
* PluginProgramAreasApi.get} / {@linkcode PluginProgramAreasApi.list}. Call
|
|
157
|
+
* `refresh` first to guarantee those reads reflect the current model. It is a
|
|
158
|
+
* read (no write gate) — it recomputes derived totals, it does not change the model.
|
|
159
|
+
*
|
|
160
|
+
* **Cost:** a full pass over every space, floor and mass in the active structure.
|
|
161
|
+
* Not free on large models — call it once before a batch of reads, not per read.
|
|
162
|
+
*
|
|
163
|
+
* @returns The freshly-recomputed {@linkcode PluginProgramAreaSummary}.
|
|
164
|
+
*
|
|
165
|
+
* @examplePrompt Recompute the area totals before I read them
|
|
166
|
+
* @examplePrompt Refresh the FAR numbers
|
|
167
|
+
* @examplePrompt Make sure the area breakdown is up to date
|
|
168
|
+
*
|
|
169
|
+
* # Example
|
|
170
|
+
* ```ts
|
|
171
|
+
* const s = await snaptrude.program.areas.refresh()
|
|
172
|
+
* const { groups } = await snaptrude.program.areas.list("storeys") // now fresh
|
|
173
|
+
* console.log(s.builtUp, groups.length)
|
|
174
|
+
* ```
|
|
175
|
+
*/
|
|
176
|
+
abstract refresh(): PluginApiReturn<PluginProgramAreasRefreshResult>;
|
|
124
177
|
}
|
|
125
178
|
/**
|
|
126
179
|
* The whole-program area / FAR summary. All area figures are in `areaUnit`;
|
|
@@ -130,9 +183,9 @@ export declare abstract class PluginProgramAreasApi {
|
|
|
130
183
|
* |---|---|---|
|
|
131
184
|
* | `count` | `number` | Number of spaces in the program (a count, not an area) |
|
|
132
185
|
* | `hiddenCount` | `number` | Number of those spaces that are currently hidden |
|
|
133
|
-
* | `carpet` | `number` | Total
|
|
134
|
-
* | `builtUp` | `number` | Total
|
|
135
|
-
* | `excluded` | `number` | Total
|
|
186
|
+
* | `carpet` | `number` | Total **Net Internal Area** ("net") — Σ `NET`-classed spaces + floors — in `areaUnit` |
|
|
187
|
+
* | `builtUp` | `number` | Total **Gross External Area** ("gross") — Σ `GROSS`-classed spaces + slabs — in `areaUnit` |
|
|
188
|
+
* | `excluded` | `number` | Total **Excluded Area** — Σ `EXCLUDED`-classed spaces — in `areaUnit` |
|
|
136
189
|
* | `farBuiltUp` | `number` | Built-up area that counts toward FAR, in `areaUnit` |
|
|
137
190
|
* | `siteArea` | `number` | Site/plot area in `areaUnit` |
|
|
138
191
|
* | `achievedFar` | `number \| null` | Derived FAR (`farBuiltUp / siteArea`); `null` when site area or target FAR is unset |
|
|
@@ -167,8 +220,8 @@ export type PluginProgramAreaSummary = z.infer<typeof PluginProgramAreaSummary>;
|
|
|
167
220
|
* | `groupId` | `string` | Stable id of the group (e.g. storey id, department id) |
|
|
168
221
|
* | `name` | `string` | Display name of the group |
|
|
169
222
|
* | `color` | `string` | CSS hex color string for the group |
|
|
170
|
-
* | `carpet` | `number` |
|
|
171
|
-
* | `builtUp` | `number` |
|
|
223
|
+
* | `carpet` | `number` | Net Internal Area ("net") for this group |
|
|
224
|
+
* | `builtUp` | `number` | Gross External Area ("gross") for this group |
|
|
172
225
|
* | `excluded` | `number` | Excluded area for this group |
|
|
173
226
|
* | `count` | `number` | Number of spaces in this group |
|
|
174
227
|
* | `targetArea` | `number` | Target area for this group, in `targetUnit` |
|
|
@@ -193,18 +246,29 @@ export type PluginProgramAreaGroup = z.infer<typeof PluginProgramAreaGroup>;
|
|
|
193
246
|
* A single space within an area group. Area figures are in the program's area
|
|
194
247
|
* unit (see {@linkcode PluginProgramAreaSummary.areaUnit}).
|
|
195
248
|
*
|
|
249
|
+
* `areaClass` is the space's effective classification — it decides which of the
|
|
250
|
+
* three buckets the space's whole footprint lands in: `NET` → `carpet` ("net"),
|
|
251
|
+
* `GROSS` → `builtUp` ("gross"), `EXCLUDED` → `excluded`. So for any one member
|
|
252
|
+
* exactly one of `carpet` / `builtUp` / `excluded` is non-zero.
|
|
253
|
+
*
|
|
196
254
|
* | Property | Type | Description |
|
|
197
255
|
* |---|---|---|
|
|
198
256
|
* | `id` | `ComponentHandle` | `Component.id` of the space (never a mesh handle) |
|
|
199
257
|
* | `label` | `string` | Display label of the space |
|
|
200
|
-
* | `
|
|
201
|
-
* | `
|
|
202
|
-
* | `
|
|
258
|
+
* | `areaClass` | {@linkcode PluginAreaClass} | Effective area class — `"NET"` (→ `carpet`), `"GROSS"` (→ `builtUp`), or `"EXCLUDED"` |
|
|
259
|
+
* | `carpet` | `number` | Net area of the space (non-zero when `areaClass` is `"NET"`) |
|
|
260
|
+
* | `builtUp` | `number` | Gross area of the space (non-zero when `areaClass` is `"GROSS"`) |
|
|
261
|
+
* | `excluded` | `number` | Excluded area of the space (non-zero when `areaClass` is `"EXCLUDED"`) |
|
|
203
262
|
* | `isVisible` | `boolean` | Whether the space is currently visible |
|
|
204
263
|
*/
|
|
205
264
|
export declare const PluginProgramAreaMember: z.ZodObject<{
|
|
206
265
|
id: z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>;
|
|
207
266
|
label: z.ZodString;
|
|
267
|
+
areaClass: z.ZodEnum<{
|
|
268
|
+
NET: "NET";
|
|
269
|
+
GROSS: "GROSS";
|
|
270
|
+
EXCLUDED: "EXCLUDED";
|
|
271
|
+
}>;
|
|
208
272
|
carpet: z.ZodNumber;
|
|
209
273
|
builtUp: z.ZodNumber;
|
|
210
274
|
excluded: z.ZodNumber;
|
|
@@ -313,6 +377,11 @@ export declare const PluginProgramAreasListMembersResult: z.ZodObject<{
|
|
|
313
377
|
members: z.ZodArray<z.ZodObject<{
|
|
314
378
|
id: z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>;
|
|
315
379
|
label: z.ZodString;
|
|
380
|
+
areaClass: z.ZodEnum<{
|
|
381
|
+
NET: "NET";
|
|
382
|
+
GROSS: "GROSS";
|
|
383
|
+
EXCLUDED: "EXCLUDED";
|
|
384
|
+
}>;
|
|
316
385
|
carpet: z.ZodNumber;
|
|
317
386
|
builtUp: z.ZodNumber;
|
|
318
387
|
excluded: z.ZodNumber;
|
|
@@ -357,4 +426,25 @@ export declare const PluginProgramAreasUpdateResult: z.ZodObject<{
|
|
|
357
426
|
}>;
|
|
358
427
|
}, z.core.$strip>;
|
|
359
428
|
export type PluginProgramAreasUpdateResult = z.infer<typeof PluginProgramAreasUpdateResult>;
|
|
429
|
+
/**
|
|
430
|
+
* Result of {@linkcode PluginProgramAreasApi.refresh} — the freshly-recomputed
|
|
431
|
+
* program area summary.
|
|
432
|
+
*/
|
|
433
|
+
export declare const PluginProgramAreasRefreshResult: z.ZodObject<{
|
|
434
|
+
count: z.ZodNumber;
|
|
435
|
+
hiddenCount: z.ZodNumber;
|
|
436
|
+
carpet: z.ZodNumber;
|
|
437
|
+
builtUp: z.ZodNumber;
|
|
438
|
+
excluded: z.ZodNumber;
|
|
439
|
+
farBuiltUp: z.ZodNumber;
|
|
440
|
+
siteArea: z.ZodNumber;
|
|
441
|
+
achievedFar: z.ZodNullable<z.ZodNumber>;
|
|
442
|
+
targetFar: z.ZodNumber;
|
|
443
|
+
deviation: z.ZodNumber;
|
|
444
|
+
areaUnit: z.ZodEnum<{
|
|
445
|
+
ft2: "ft2";
|
|
446
|
+
m2: "m2";
|
|
447
|
+
}>;
|
|
448
|
+
}, z.core.$strip>;
|
|
449
|
+
export type PluginProgramAreasRefreshResult = z.infer<typeof PluginProgramAreasRefreshResult>;
|
|
360
450
|
//# sourceMappingURL=areas.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"areas.d.ts","sourceRoot":"","sources":["../../../src/api/program/areas.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;
|
|
1
|
+
{"version":3,"file":"areas.d.ts","sourceRoot":"","sources":["../../../src/api/program/areas.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAG7C,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,8BAAsB,qBAAqB;;IAGzC;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,GAAG,IAAI,eAAe,CAAC,2BAA2B,CAAC;IAEnE;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,IAAI,CAClB,OAAO,EAAE,wBAAwB,EACjC,UAAU,CAAC,EAAE,MAAM,GAClB,eAAe,CAAC,4BAA4B,CAAC;IAEhD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;aACa,WAAW,CACzB,OAAO,EAAE,wBAAwB,EACjC,OAAO,EAAE,MAAM,EACf,UAAU,CAAC,EAAE,MAAM,GAClB,eAAe,CAAC,mCAAmC,CAAC;IAEvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;aACa,MAAM,CAAC,OAAO,CAAC,EAAE;QAC/B,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,SAAS,CAAC,EAAE,MAAM,CAAA;KACnB,GAAG,eAAe,CAAC,8BAA8B,CAAC;IAEnD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;aACa,OAAO,IAAI,eAAe,CAAC,+BAA+B,CAAC;CAC5E;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;iBAYnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;iBAUjC,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;iBAQlC,CAAA;AACF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E,6CAA6C;AAC7C,eAAO,MAAM,wBAAwB;;;;;;EAMnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E,kFAAkF;AAClF,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;iBAA2B,CAAA;AACnE,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAC/C,OAAO,2BAA2B,CACnC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;iBAOnC,CAAA;AACJ,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;iBAEvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,iCAAiC;;;;;;;;;;iBAQ1C,CAAA;AACJ,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,mCAAmC;;;;;;;;;;;;;;iBAE9C,CAAA;AACF,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,4BAA4B;;;;iBAIvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;iBAA2B,CAAA;AACtE,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;iBAA2B,CAAA;AACvE,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA"}
|
|
@@ -4,13 +4,9 @@ import { PluginApiReturn } from "../../types";
|
|
|
4
4
|
* Program cores — the building's vertical-circulation cores (lift / stair / shaft
|
|
5
5
|
* shells).
|
|
6
6
|
*
|
|
7
|
-
* Read the cores in the scene
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
* core geometry itself is owned by the geometry layer, not here (the exact
|
|
11
|
-
* layout ↔ engine payload is coordinated with the geometry owner).
|
|
12
|
-
*
|
|
13
|
-
* `list`/`isCore` are reads; `create` triggers generation.
|
|
7
|
+
* Read the cores in the scene and test whether a space is a core. Both are reads;
|
|
8
|
+
* there is no core-generation trigger on this surface (core geometry is owned by
|
|
9
|
+
* the geometry layer, not here).
|
|
14
10
|
*
|
|
15
11
|
* Accessed via `snaptrude.program.cores`.
|
|
16
12
|
*/
|
|
@@ -49,33 +45,6 @@ export declare abstract class PluginProgramCoresApi {
|
|
|
49
45
|
* ```
|
|
50
46
|
*/
|
|
51
47
|
abstract isCore(id: string): PluginApiReturn<boolean>;
|
|
52
|
-
/**
|
|
53
|
-
* Generate core geometry from a layout (thin trigger).
|
|
54
|
-
*
|
|
55
|
-
* Hands the core layout to the core-generation engine and returns how many core
|
|
56
|
-
* elements were created. The geometry is authored by the engine, not here.
|
|
57
|
-
* _(Authored ahead — optional until the host's geometry adapter lands; the
|
|
58
|
-
* reads {@linkcode PluginProgramCoresApi.list}/{@linkcode PluginProgramCoresApi.isCore}
|
|
59
|
-
* are live.)_
|
|
60
|
-
*
|
|
61
|
-
* @param cores - The {@linkcode PluginProgramCoreSpec} layout of cores to
|
|
62
|
-
* generate.
|
|
63
|
-
* @param lengthUnit - Unit of the spec dimensions (default project unit).
|
|
64
|
-
* @returns A {@linkcode PluginProgramCoresCreateResult} with the created count.
|
|
65
|
-
* @throws If the layout could not be realized.
|
|
66
|
-
*
|
|
67
|
-
* @examplePrompt Generate the building cores from this layout
|
|
68
|
-
* @examplePrompt Place the elevator and stair cores
|
|
69
|
-
* @examplePrompt Create the service core shells
|
|
70
|
-
*
|
|
71
|
-
* # Example
|
|
72
|
-
* ```ts
|
|
73
|
-
* await snaptrude.program.cores.create([
|
|
74
|
-
* { type: "lift", position: { x: 0, y: 0, z: 0 }, width: 3, depth: 4 },
|
|
75
|
-
* ])
|
|
76
|
-
* ```
|
|
77
|
-
*/
|
|
78
|
-
create?: (cores: PluginProgramCoreSpec[], lengthUnit?: "mm" | "m" | "ft") => PluginApiReturn<PluginProgramCoresCreateResult>;
|
|
79
48
|
}
|
|
80
49
|
/**
|
|
81
50
|
* A circulation core element in the building.
|
|
@@ -106,69 +75,4 @@ export declare const PluginProgramCoresIsCoreArgs: z.ZodObject<{
|
|
|
106
75
|
id: z.ZodString;
|
|
107
76
|
}, z.core.$strip>;
|
|
108
77
|
export type PluginProgramCoresIsCoreArgs = z.infer<typeof PluginProgramCoresIsCoreArgs>;
|
|
109
|
-
/**
|
|
110
|
-
* One core to generate. The geometry layer interprets this layout (the exact
|
|
111
|
-
* fields are coordinated with the geometry owner).
|
|
112
|
-
*
|
|
113
|
-
* | Property | Type | Description |
|
|
114
|
-
* |---|---|---|
|
|
115
|
-
* | `type` | `string \| undefined` | Core kind (e.g. `"lift"`, `"stair"`, `"shaft"`) |
|
|
116
|
-
* | `position` | `{ x; y; z }` | Base position of the core |
|
|
117
|
-
* | `width` | `number` | Core width, in `lengthUnit` |
|
|
118
|
-
* | `depth` | `number` | Core depth, in `lengthUnit` |
|
|
119
|
-
* | `fromStorey` | `number \| undefined` | First storey the core spans |
|
|
120
|
-
* | `toStorey` | `number \| undefined` | Last storey the core spans |
|
|
121
|
-
*/
|
|
122
|
-
export declare const PluginProgramCoreSpec: z.ZodObject<{
|
|
123
|
-
type: z.ZodOptional<z.ZodString>;
|
|
124
|
-
position: z.ZodObject<{
|
|
125
|
-
x: z.ZodNumber;
|
|
126
|
-
y: z.ZodNumber;
|
|
127
|
-
z: z.ZodNumber;
|
|
128
|
-
}, z.core.$strip>;
|
|
129
|
-
width: z.ZodNumber;
|
|
130
|
-
depth: z.ZodNumber;
|
|
131
|
-
fromStorey: z.ZodOptional<z.ZodNumber>;
|
|
132
|
-
toStorey: z.ZodOptional<z.ZodNumber>;
|
|
133
|
-
}, z.core.$strip>;
|
|
134
|
-
export type PluginProgramCoreSpec = z.infer<typeof PluginProgramCoreSpec>;
|
|
135
|
-
/**
|
|
136
|
-
* Arguments for {@linkcode PluginProgramCoresApi.create}.
|
|
137
|
-
*
|
|
138
|
-
* | Property | Type | Description |
|
|
139
|
-
* |---|---|---|
|
|
140
|
-
* | `cores` | {@linkcode PluginProgramCoreSpec}`[]` | The cores to generate |
|
|
141
|
-
* | `lengthUnit` | `"mm" \| "m" \| "ft" \| undefined` | Unit of the spec dimensions (default project unit) |
|
|
142
|
-
*/
|
|
143
|
-
export declare const PluginProgramCoresCreateArgs: z.ZodObject<{
|
|
144
|
-
cores: z.ZodArray<z.ZodObject<{
|
|
145
|
-
type: z.ZodOptional<z.ZodString>;
|
|
146
|
-
position: z.ZodObject<{
|
|
147
|
-
x: z.ZodNumber;
|
|
148
|
-
y: z.ZodNumber;
|
|
149
|
-
z: z.ZodNumber;
|
|
150
|
-
}, z.core.$strip>;
|
|
151
|
-
width: z.ZodNumber;
|
|
152
|
-
depth: z.ZodNumber;
|
|
153
|
-
fromStorey: z.ZodOptional<z.ZodNumber>;
|
|
154
|
-
toStorey: z.ZodOptional<z.ZodNumber>;
|
|
155
|
-
}, z.core.$strip>>;
|
|
156
|
-
lengthUnit: z.ZodOptional<z.ZodEnum<{
|
|
157
|
-
ft: "ft";
|
|
158
|
-
m: "m";
|
|
159
|
-
mm: "mm";
|
|
160
|
-
}>>;
|
|
161
|
-
}, z.core.$strip>;
|
|
162
|
-
export type PluginProgramCoresCreateArgs = z.infer<typeof PluginProgramCoresCreateArgs>;
|
|
163
|
-
/**
|
|
164
|
-
* Result of {@linkcode PluginProgramCoresApi.create}.
|
|
165
|
-
*
|
|
166
|
-
* | Property | Type | Description |
|
|
167
|
-
* |---|---|---|
|
|
168
|
-
* | `createdCount` | `number` | Number of core elements created |
|
|
169
|
-
*/
|
|
170
|
-
export declare const PluginProgramCoresCreateResult: z.ZodObject<{
|
|
171
|
-
createdCount: z.ZodNumber;
|
|
172
|
-
}, z.core.$strip>;
|
|
173
|
-
export type PluginProgramCoresCreateResult = z.infer<typeof PluginProgramCoresCreateResult>;
|
|
174
78
|
//# sourceMappingURL=cores.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cores.d.ts","sourceRoot":"","sources":["../../../src/api/program/cores.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C
|
|
1
|
+
{"version":3,"file":"cores.d.ts","sourceRoot":"","sources":["../../../src/api/program/cores.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C;;;;;;;;;GASG;AACH,8BAAsB,qBAAqB;;IAGzC;;;;;;;;;;;;;;;OAeG;aACa,IAAI,IAAI,eAAe,CAAC,4BAA4B,CAAC;IAErE;;;;;;;;;;;;;;OAcG;aACa,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC;CAC7D;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,iBAAiB;;;;iBAI5B,CAAA;AACF,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA;AAEjE,wDAAwD;AACxD,eAAO,MAAM,4BAA4B;;;;;;iBAEvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA;AAED,8DAA8D;AAC9D,eAAO,MAAM,4BAA4B;;iBAEvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA"}
|
|
@@ -18,19 +18,14 @@ import { PluginProgramAreasApi } from "./areas";
|
|
|
18
18
|
*
|
|
19
19
|
* - {@linkcode PluginProgramApi.departments} — Read & edit program departments (groupings + targets)
|
|
20
20
|
* - {@linkcode PluginProgramApi.adjacency} — Read & compute the department/space adjacency matrix
|
|
21
|
-
* - {@linkcode PluginProgramApi.layout} — Arrange/pack spaces in the envelope
|
|
21
|
+
* - {@linkcode PluginProgramApi.layout} — Arrange/pack spaces in the envelope
|
|
22
22
|
* - {@linkcode PluginProgramApi.metrics} — Read the area-program summary
|
|
23
23
|
* - {@linkcode PluginProgramApi.areas} — FAR / built-up-area rollup and groupings
|
|
24
24
|
* - {@linkcode PluginProgramApi.spreadsheet} — Render program data to sheets and read it back
|
|
25
|
-
* - {@linkcode PluginProgramApi.site} — Read
|
|
26
|
-
* - {@linkcode PluginProgramApi.cores} — Read &
|
|
25
|
+
* - {@linkcode PluginProgramApi.site} — Read site/plot context and read/update Site Analysis
|
|
26
|
+
* - {@linkcode PluginProgramApi.cores} — Read & predicate vertical-circulation cores (reads only)
|
|
27
27
|
* - {@linkcode PluginProgramApi.classification} — Classification catalog + display tags
|
|
28
28
|
*
|
|
29
|
-
* Sub-namespaces typed as optional (`?`) are **authored ahead of the host** —
|
|
30
|
-
* declared so plugins and codegen can see the shape, but not required of host
|
|
31
|
-
* implementations and kept out of the discovery manifest until the host lands
|
|
32
|
-
* them (at which point they are promoted to required `abstract` members).
|
|
33
|
-
*
|
|
34
29
|
* Accessed via `snaptrude.program`.
|
|
35
30
|
*/
|
|
36
31
|
export declare abstract class PluginProgramApi {
|
|
@@ -38,20 +33,17 @@ export declare abstract class PluginProgramApi {
|
|
|
38
33
|
abstract departments: PluginProgramDepartmentsApi;
|
|
39
34
|
/** Adjacency matrix — read & compute proximity relationships. See {@linkcode PluginProgramAdjacencyApi}. */
|
|
40
35
|
abstract adjacency: PluginProgramAdjacencyApi;
|
|
41
|
-
/**
|
|
42
|
-
|
|
43
|
-
* _(authored ahead — optional until the host lands it next increment.)_
|
|
44
|
-
*/
|
|
45
|
-
layout?: PluginProgramLayoutApi;
|
|
36
|
+
/** Arrange/pack spaces in the envelope (async job family). See {@linkcode PluginProgramLayoutApi}. */
|
|
37
|
+
abstract layout: PluginProgramLayoutApi;
|
|
46
38
|
/** Area-program summary — targets vs allocated area. See {@linkcode PluginProgramMetricsApi}. */
|
|
47
39
|
abstract metrics: PluginProgramMetricsApi;
|
|
48
40
|
/** FAR / built-up-area rollup and groupings. See {@linkcode PluginProgramAreasApi}. */
|
|
49
41
|
abstract areas: PluginProgramAreasApi;
|
|
50
42
|
/** Spreadsheet reports — render tables to sheets, export, list, read back. See {@linkcode PluginProgramSpreadsheetApi}. */
|
|
51
43
|
abstract spreadsheet: PluginProgramSpreadsheetApi;
|
|
52
|
-
/** Site/plot
|
|
44
|
+
/** Site/plot context and persisted Site Analysis. See {@linkcode PluginProgramSiteApi}. */
|
|
53
45
|
abstract site: PluginProgramSiteApi;
|
|
54
|
-
/** Vertical-circulation cores — read & predicate (
|
|
46
|
+
/** Vertical-circulation cores — read & predicate (reads only). See {@linkcode PluginProgramCoresApi}. */
|
|
55
47
|
abstract cores: PluginProgramCoresApi;
|
|
56
48
|
/** Classification catalog (space/area/mass types) + display tags. See {@linkcode PluginProgramClassificationApi}. */
|
|
57
49
|
abstract classification: PluginProgramClassificationApi;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/program/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,eAAe,CAAA;AAC3D,OAAO,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAA;AACvD,OAAO,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAA;AACjD,OAAO,EAAE,uBAAuB,EAAE,MAAM,WAAW,CAAA;AACnD,OAAO,EAAE,2BAA2B,EAAE,MAAM,eAAe,CAAA;AAC3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,QAAQ,CAAA;AAC7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAA;AAC/C,OAAO,EAAE,8BAA8B,EAAE,MAAM,kBAAkB,CAAA;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAA;AAE/C
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/program/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,eAAe,CAAA;AAC3D,OAAO,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAA;AACvD,OAAO,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAA;AACjD,OAAO,EAAE,uBAAuB,EAAE,MAAM,WAAW,CAAA;AACnD,OAAO,EAAE,2BAA2B,EAAE,MAAM,eAAe,CAAA;AAC3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,QAAQ,CAAA;AAC7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAA;AAC/C,OAAO,EAAE,8BAA8B,EAAE,MAAM,kBAAkB,CAAA;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAA;AAE/C;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,8BAAsB,gBAAgB;IACpC,wHAAwH;IACxH,SAAgB,WAAW,EAAE,2BAA2B,CAAA;IACxD,4GAA4G;IAC5G,SAAgB,SAAS,EAAE,yBAAyB,CAAA;IACpD,sGAAsG;IACtG,SAAgB,MAAM,EAAE,sBAAsB,CAAA;IAC9C,iGAAiG;IACjG,SAAgB,OAAO,EAAE,uBAAuB,CAAA;IAChD,uFAAuF;IACvF,SAAgB,KAAK,EAAE,qBAAqB,CAAA;IAC5C,2HAA2H;IAC3H,SAAgB,WAAW,EAAE,2BAA2B,CAAA;IACxD,2FAA2F;IAC3F,SAAgB,IAAI,EAAE,oBAAoB,CAAA;IAC1C,yGAAyG;IACzG,SAAgB,KAAK,EAAE,qBAAqB,CAAA;IAC5C,qHAAqH;IACrH,SAAgB,cAAc,EAAE,8BAA8B,CAAA;;CAG/D;AAED,cAAc,eAAe,CAAA;AAC7B,cAAc,aAAa,CAAA;AAC3B,cAAc,UAAU,CAAA;AACxB,cAAc,WAAW,CAAA;AACzB,cAAc,eAAe,CAAA;AAC7B,cAAc,QAAQ,CAAA;AACtB,cAAc,SAAS,CAAA;AACvB,cAAc,kBAAkB,CAAA;AAChC,cAAc,SAAS,CAAA"}
|