bimdown-cli 0.4.0 → 0.5.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 (149) hide show
  1. package/README.md +24 -3
  2. package/dist/chunk-4SKM4RHY.js +142 -0
  3. package/dist/chunk-4SKM4RHY.js.map +1 -0
  4. package/dist/chunk-4YHVOWS4.js +255 -0
  5. package/dist/chunk-4YHVOWS4.js.map +1 -0
  6. package/dist/chunk-AYAXRYGP.js +2129 -0
  7. package/dist/chunk-AYAXRYGP.js.map +1 -0
  8. package/dist/chunk-EC5MR5ZH.js +648 -0
  9. package/dist/chunk-EC5MR5ZH.js.map +1 -0
  10. package/dist/chunk-HS3PO2LB.js +487 -0
  11. package/dist/chunk-HS3PO2LB.js.map +1 -0
  12. package/dist/chunk-IQJA3EFO.js +179 -0
  13. package/dist/chunk-IQJA3EFO.js.map +1 -0
  14. package/dist/chunk-JY6KWRDB.js +80 -0
  15. package/dist/chunk-JY6KWRDB.js.map +1 -0
  16. package/dist/chunk-KWSGJUMZ.js +2501 -0
  17. package/dist/chunk-KWSGJUMZ.js.map +1 -0
  18. package/dist/chunk-LWYIPR64.js +35 -0
  19. package/dist/chunk-LWYIPR64.js.map +1 -0
  20. package/dist/chunk-OBY3UYCO.js +44 -0
  21. package/dist/chunk-OBY3UYCO.js.map +1 -0
  22. package/dist/chunk-XC6WHJRL.js +29 -0
  23. package/dist/chunk-XC6WHJRL.js.map +1 -0
  24. package/dist/chunk-XQU52JKB.js +187 -0
  25. package/dist/chunk-XQU52JKB.js.map +1 -0
  26. package/dist/clash-load-D3LNQR6G.js +941 -0
  27. package/dist/clash-load-D3LNQR6G.js.map +1 -0
  28. package/dist/cli.js +306 -3377
  29. package/dist/cli.js.map +1 -1
  30. package/dist/dehydrate-ZHAGOI7Q.js +90 -0
  31. package/dist/dehydrate-ZHAGOI7Q.js.map +1 -0
  32. package/dist/diff-T2KOK2WR.js +89 -0
  33. package/dist/diff-T2KOK2WR.js.map +1 -0
  34. package/dist/engine-2TPWJVEQ.js +12 -0
  35. package/dist/engine-2TPWJVEQ.js.map +1 -0
  36. package/dist/hydrate-V24H7IF3.js +673 -0
  37. package/dist/hydrate-V24H7IF3.js.map +1 -0
  38. package/dist/import-ifc-RCZSXDA6.js +5324 -0
  39. package/dist/import-ifc-RCZSXDA6.js.map +1 -0
  40. package/dist/info-QC7YXWNX.js +92 -0
  41. package/dist/info-QC7YXWNX.js.map +1 -0
  42. package/dist/init-VWDML3UC.js +112 -0
  43. package/dist/init-VWDML3UC.js.map +1 -0
  44. package/dist/lib.d.ts +427 -44
  45. package/dist/lib.js +6482 -225
  46. package/dist/lib.js.map +1 -1
  47. package/dist/mep-W4HJI363.js +25 -0
  48. package/dist/mep-W4HJI363.js.map +1 -0
  49. package/dist/merge-ESOPDSA5.js +413 -0
  50. package/dist/merge-ESOPDSA5.js.map +1 -0
  51. package/dist/publish-3TAXQCUV.js +80 -0
  52. package/dist/publish-3TAXQCUV.js.map +1 -0
  53. package/dist/render-UEWYHPN6.js +1807 -0
  54. package/dist/render-UEWYHPN6.js.map +1 -0
  55. package/dist/resolve-topology-AQ2RO3W3.js +338 -0
  56. package/dist/resolve-topology-AQ2RO3W3.js.map +1 -0
  57. package/dist/spec/csv-schema/annotation/dimension.yaml +77 -0
  58. package/dist/spec/csv-schema/annotation/tag.yaml +44 -0
  59. package/dist/spec/csv-schema/annotation/text_note.yaml +52 -0
  60. package/dist/spec/csv-schema/architecture/ceiling.yaml +8 -1
  61. package/dist/spec/csv-schema/architecture/column.yaml +5 -1
  62. package/dist/spec/csv-schema/architecture/curtain_wall.yaml +45 -5
  63. package/dist/spec/csv-schema/architecture/door.yaml +5 -0
  64. package/dist/spec/csv-schema/architecture/furniture.yaml +28 -0
  65. package/dist/spec/csv-schema/architecture/opening.yaml +27 -6
  66. package/dist/spec/csv-schema/architecture/railing.yaml +35 -0
  67. package/dist/spec/csv-schema/architecture/roof.yaml +34 -1
  68. package/dist/spec/csv-schema/architecture/slab.yaml +19 -0
  69. package/dist/spec/csv-schema/architecture/space.yaml +11 -1
  70. package/dist/spec/csv-schema/architecture/stair.yaml +49 -0
  71. package/dist/spec/csv-schema/architecture/stair_landing.yaml +36 -0
  72. package/dist/spec/csv-schema/architecture/stair_run.yaml +31 -0
  73. package/dist/spec/csv-schema/architecture/wall.yaml +14 -1
  74. package/dist/spec/csv-schema/architecture/window.yaml +19 -0
  75. package/dist/spec/csv-schema/base/element.yaml +20 -11
  76. package/dist/spec/csv-schema/base/furniture_params.yaml +60 -0
  77. package/dist/spec/csv-schema/base/hosted_element.yaml +10 -2
  78. package/dist/spec/csv-schema/base/mep_connectable.yaml +23 -0
  79. package/dist/spec/csv-schema/base/mep_design.yaml +24 -0
  80. package/dist/spec/csv-schema/base/mep_insulated.yaml +9 -0
  81. package/dist/spec/csv-schema/base/mep_system_tag.yaml +12 -0
  82. package/dist/spec/csv-schema/base/point_element.yaml +1 -0
  83. package/dist/spec/csv-schema/base/section_profile.yaml +5 -0
  84. package/dist/spec/csv-schema/base/spatial_line_element.yaml +4 -2
  85. package/dist/spec/csv-schema/base/structural_section_profile.yaml +50 -0
  86. package/dist/spec/csv-schema/base/vertical_span.yaml +5 -4
  87. package/dist/spec/csv-schema/base/wall_bounded.yaml +21 -0
  88. package/dist/spec/csv-schema/grid.yaml +5 -0
  89. package/dist/spec/csv-schema/mep/cable_tray.yaml +10 -3
  90. package/dist/spec/csv-schema/mep/circuit.yaml +70 -0
  91. package/dist/spec/csv-schema/mep/conduit.yaml +2 -2
  92. package/dist/spec/csv-schema/mep/connector.yaml +112 -0
  93. package/dist/spec/csv-schema/mep/duct.yaml +10 -3
  94. package/dist/spec/csv-schema/mep/equipment.yaml +18 -1
  95. package/dist/spec/csv-schema/mep/mep_node.yaml +91 -2
  96. package/dist/spec/csv-schema/mep/mep_system.yaml +21 -0
  97. package/dist/spec/csv-schema/mep/pipe.yaml +27 -3
  98. package/dist/spec/csv-schema/mep/terminal.yaml +22 -1
  99. package/dist/spec/csv-schema/model_group.yaml +40 -0
  100. package/dist/spec/csv-schema/sheet/sheet.yaml +50 -0
  101. package/dist/spec/csv-schema/sheet/sheet_viewport.yaml +86 -0
  102. package/dist/spec/csv-schema/structure/beam.yaml +29 -1
  103. package/dist/spec/csv-schema/structure/beam_system.yaml +29 -0
  104. package/dist/spec/csv-schema/structure/brace.yaml +24 -1
  105. package/dist/spec/csv-schema/structure/foundation.yaml +40 -7
  106. package/dist/spec/csv-schema/structure/structure_column.yaml +19 -1
  107. package/dist/spec/csv-schema/structure/structure_slab.yaml +32 -0
  108. package/dist/spec/csv-schema/structure/structure_wall.yaml +22 -0
  109. package/dist/spec/csv-schema/types/beam_type.yaml +11 -0
  110. package/dist/spec/csv-schema/types/ceiling_type.yaml +6 -0
  111. package/dist/spec/csv-schema/types/column_type.yaml +12 -0
  112. package/dist/spec/csv-schema/types/curtain_wall_type.yaml +32 -0
  113. package/dist/spec/csv-schema/types/door_type.yaml +27 -0
  114. package/dist/spec/csv-schema/types/element_type.yaml +21 -0
  115. package/dist/spec/csv-schema/types/fenestration.yaml +16 -0
  116. package/dist/spec/csv-schema/types/foundation_type.yaml +36 -0
  117. package/dist/spec/csv-schema/types/furniture_type.yaml +11 -0
  118. package/dist/spec/csv-schema/types/layered_type.yaml +13 -0
  119. package/dist/spec/csv-schema/types/railing_type.yaml +40 -0
  120. package/dist/spec/csv-schema/types/roof_type.yaml +7 -0
  121. package/dist/spec/csv-schema/types/slab_type.yaml +9 -0
  122. package/dist/spec/csv-schema/types/type_layer.yaml +47 -0
  123. package/dist/spec/csv-schema/types/wall_type.yaml +6 -0
  124. package/dist/spec/csv-schema/types/window_type.yaml +31 -0
  125. package/dist/spec/csv-schema/underlay.yaml +73 -0
  126. package/dist/spec/csv-schema/view.yaml +36 -0
  127. package/dist/spec/duckdb-strategy.md +4 -3
  128. package/dist/spec/geojson-schema/readme.md +380 -0
  129. package/dist/spec/mep-port-conventions.md +190 -0
  130. package/dist/spec/migration-guide.md +1 -1
  131. package/dist/spec/project_metadata.schema.yaml +52 -4
  132. package/dist/spec/readme.md +356 -97
  133. package/dist/spec/starter-types/global/beam_type.csv +5 -0
  134. package/dist/spec/starter-types/global/ceiling_type.csv +3 -0
  135. package/dist/spec/starter-types/global/column_type.csv +5 -0
  136. package/dist/spec/starter-types/global/curtain_wall_type.csv +2 -0
  137. package/dist/spec/starter-types/global/door_type.csv +6 -0
  138. package/dist/spec/starter-types/global/foundation_type.csv +7 -0
  139. package/dist/spec/starter-types/global/furniture_type.csv +11 -0
  140. package/dist/spec/starter-types/global/railing_type.csv +5 -0
  141. package/dist/spec/starter-types/global/roof_type.csv +3 -0
  142. package/dist/spec/starter-types/global/slab_type.csv +4 -0
  143. package/dist/spec/starter-types/global/type_layer.csv +40 -0
  144. package/dist/spec/starter-types/global/wall_type.csv +8 -0
  145. package/dist/spec/starter-types/global/window_type.csv +6 -0
  146. package/dist/spec/svg-schema/readme.md +47 -1
  147. package/package.json +6 -3
  148. package/dist/spec/csv-schema/base/mep_connected_segment.yaml +0 -17
  149. package/dist/spec/csv-schema/base/mep_system.yaml +0 -7
@@ -33,3 +33,8 @@ fields:
33
33
  values:
34
34
  - left
35
35
  - right
36
+
37
+ - name: type_id
38
+ type: reference
39
+ reference: door_type
40
+ description: Optional door_type id. Empty type parameters (width, height, operation, material) inherit the type's value; a set value overrides it for this element.
@@ -0,0 +1,28 @@
1
+ name: furniture
2
+ description: >
3
+ Built-in parametric component (furniture, casework, appliances without MEP
4
+ ports, toilet partitions, cars and parking spaces, trees and plants, scale
5
+ figures, generic placeholders). GeoJSON Point at the footprint centre;
6
+ properties.rotation turns it CCW (degrees); base_offset raises it (wall
7
+ cabinets). Local frame: size_x = width, size_y = depth, +Y is the BACK (put
8
+ it against the wall), so rotation 0 faces -Y (south). Empty size fields take
9
+ the family / variant default. Plan symbols and 3D massing come from the
10
+ built-in library (`bimdown schema furniture` lists families and variants).
11
+ Exporters: IFC4 IfcFurniture (desk/chair/table/bed/sofa/shelf/file cabinet
12
+ predefined types), IfcElectricAppliance (appliances), IfcFurnishingElement
13
+ (toilet partitions, plants), IfcGeographicElement (trees),
14
+ IfcBuildingElementProxy (cars, parking, people, generic).
15
+ bases:
16
+ - point_element
17
+ - furniture_params
18
+
19
+ fields:
20
+ - name: mirror
21
+ type: enum
22
+ values: ["true", "false"]
23
+ description: Mirror left-right (e.g. an L-shape desk with the return on the left).
24
+
25
+ - name: type_id
26
+ type: reference
27
+ reference: furniture_type
28
+ description: Optional furniture_type id. Empty type parameters (family, variant, size_x, size_y, height) inherit the type's value; a set value overrides it for this element.
@@ -2,18 +2,20 @@ name: opening
2
2
  bases:
3
3
  - element
4
4
  description: >
5
- Opening (void) in a host element. host_id is always required.
6
- Geometry form depends on the host type:
5
+ Opening (void) in a host element. Geometry form depends on the host type:
7
6
  - Wall opening: host_id references a wall. Uses position (distance in meters from wall start),
8
- width, and height. No SVG geometry.
9
- - Slab opening: host_id references a slab. Uses SVG geometry
10
- (<rect> or <polygon>) to define the void shape.
7
+ width, and height. No GeoJSON geometry.
8
+ - Slab / roof opening: host_id references a slab, structure_slab or roof. Uses a GeoJSON
9
+ Polygon (2D plan) to define the void shape, cut vertically (skylights, dormer openings).
10
+ - Shaft: a Polygon opening with top_level_id. It cuts every slab, structure_slab, ceiling and roof
11
+ whose body lies between its bottom (this level + base_offset) and its top
12
+ (top_level_id + top_offset), on every level. host_id may be empty.
11
13
 
12
14
  fields:
13
15
  - name: host_id
14
16
  type: reference
15
17
  reference: element
16
- required: true
18
+ description: Host wall / slab / roof. Required except for shafts (top_level_id set).
17
19
 
18
20
  - name: position
19
21
  type: float
@@ -34,3 +36,22 @@ fields:
34
36
  - round
35
37
  - arch
36
38
  description: Opening shape. Only for wall openings.
39
+
40
+ # Wall openings have no GeoJSON feature, so their sill height lives in the
41
+ # CSV (same as door/window). Slab openings leave it empty.
42
+ - name: base_offset
43
+ type: float
44
+ default: 0
45
+ storage: csv
46
+ description: Sill height of a wall opening above the host's base level, meters; for a shaft, its bottom above this level.
47
+
48
+ - name: top_level_id
49
+ type: reference
50
+ reference: level
51
+ description: Shaft only - the level the shaft rises to. Empty = an opening in its host only.
52
+
53
+ - name: top_offset
54
+ type: float
55
+ default: 0
56
+ storage: csv
57
+ description: Shaft only - offset of the shaft top from top_level_id, meters.
@@ -1,7 +1,42 @@
1
1
  name: railing
2
2
  bases:
3
3
  - spatial_line_element
4
+ - materialized
5
+ description: >
6
+ Railing (guard / handrail). Three forms:
7
+ - Sketched: a 3D LineString path; the railing stands on the path.
8
+ - On a slab edge: the same, with host_id = a slab or structure_slab; the
9
+ railing stands on the slab top (z follows the slab, the path's Z is ignored).
10
+ - On a stair: host_id = a stair and `side` = left | right (looking up the
11
+ stair). No GeoJSON feature: the path is derived from the stair's runs and
12
+ landings (along each run edge, around the outer side of landings, across
13
+ the well side of U stairs) and follows every stair edit and multi-storey
14
+ repetition.
15
+ `type_id` points at a railing_type (height, top rail, infill, balusters,
16
+ material); instance `height`, `baluster_spacing` and `material` override it.
4
17
 
5
18
  fields:
6
19
  - name: height
7
20
  type: float
21
+ description: Top of rail above the walking surface (stair nosing line / floor), m. Default 1.0.
22
+
23
+ - name: type_id
24
+ type: reference
25
+ reference: railing_type
26
+ description: Optional railing_type id. Empty type parameters (height, baluster_spacing, material) inherit the type's value.
27
+
28
+ - name: host_id
29
+ type: reference
30
+ reference: element
31
+ description: Optional host. A stair (path derived, no geometry; needs `side`) or a slab / structure_slab (sketched path on its top).
32
+
33
+ - name: side
34
+ type: enum
35
+ values:
36
+ - left
37
+ - right
38
+ description: Stair-hosted railings only — side of the stair looking up its walking line.
39
+
40
+ - name: baluster_spacing
41
+ type: float
42
+ description: Baluster centre spacing (m). Type parameter.
@@ -2,6 +2,7 @@ name: roof
2
2
  bases:
3
3
  - polygon_element
4
4
  - materialized
5
+ - wall_bounded
5
6
 
6
7
  fields:
7
8
  - name: roof_type
@@ -13,10 +14,42 @@ fields:
13
14
  - hip
14
15
  - shed
15
16
  - mansard
17
+ - extrusion
18
+ description: >
19
+ Shape. flat / gable / hip / shed / mansard with one `slope` are footprint
20
+ roofs whose slope-defining edges are implied (hip: every edge; gable:
21
+ all but the wing ends; shed: one eave); `edge_slopes` overrides that.
22
+ extrusion: the `profile` swept along the first footprint edge.
16
23
 
17
24
  - name: slope
18
25
  type: float
19
- description: Slope angle in degrees (0 = flat roof)
26
+ description: Slope angle in degrees (0 = flat roof). With edge_slopes set, the largest edge slope.
27
+
28
+ - name: edge_slopes
29
+ type: string
30
+ description: >
31
+ Footprint roof (Revit "defines slope" per sketch line): one slope in
32
+ degrees per footprint edge, semicolon-separated, edge i running from
33
+ vertex i to vertex i+1 of the polygon ring. 0 = the edge does not define
34
+ a slope (gable / rake end). E.g. "30;0;30;0" is a gable over a rectangle,
35
+ "1.2;0;0;0" a flat roof draining to the first edge. Empty = implied by
36
+ roof_type + slope. Each sloped edge is a plane rising inward from that
37
+ edge; the roof underside is the lowest plane reaching each point (exact
38
+ ridges, hips and valleys for L / T / U footprints).
39
+
40
+ - name: profile
41
+ type: string
42
+ description: >
43
+ Extrusion roof only: the underside rise above base_offset across the
44
+ footprint, as "u,z;u,z;..." where u is the distance (m) from the first
45
+ footprint edge, measured into the footprint, and z the rise (m). The
46
+ profile is swept along the first edge; points in between are linear.
20
47
 
21
48
  - name: thickness
22
49
  type: float
50
+ description: Roof slab thickness (perpendicular to a sloped roof). base_offset is the underside at the eaves.
51
+
52
+ - name: type_id
53
+ type: reference
54
+ reference: roof_type
55
+ description: Optional roof_type id. Empty type parameters (thickness, material) inherit the type's value; a set value overrides it for this element.
@@ -2,6 +2,7 @@ name: slab
2
2
  bases:
3
3
  - polygon_element
4
4
  - materialized
5
+ - wall_bounded
5
6
 
6
7
  fields:
7
8
  - name: function
@@ -13,3 +14,21 @@ fields:
13
14
 
14
15
  - name: thickness
15
16
  type: float
17
+
18
+ - name: type_id
19
+ type: reference
20
+ reference: slab_type
21
+ description: Optional slab_type id. Empty type parameters (thickness, material) inherit the type's value; a set value overrides it for this element.
22
+
23
+ - name: slope_arrow
24
+ type: string
25
+ description: >
26
+ Sloped floor (Revit slope arrow): "tx,ty,tz;hx,hy,hz" = plan tail and head
27
+ points (m) and the top's height (m) above level + base_offset at each.
28
+ The top is the plane through them, level across the arrow (the head need
29
+ not lie inside the outline); thickness stays vertical. Empty = flat.
30
+
31
+ - name: net_area
32
+ type: float
33
+ computed: true
34
+ description: Plan area net of inner rings and of the Polygon openings hosted on this slab, hydrated at query time.
@@ -24,4 +24,14 @@ fields:
24
24
  - name: area
25
25
  type: float
26
26
  computed: true
27
- description: Space area in square meters (computed from boundary polygon)
27
+ description: Gross space area at the wall centre lines (the boundary polygon), in project units squared
28
+
29
+ - name: net_area
30
+ type: float
31
+ computed: true
32
+ description: Net space area at the wall finish faces — each boundary edge moved inward by half the thickness of its wall (room separators 0); the area drawings, tags and schedules show. Written by build into space.geojson
33
+
34
+ - name: redundant
35
+ type: boolean
36
+ computed: true
37
+ description: True for a redundant room (Revit) — a seed in an enclosed area an earlier space.csv row already occupies. Its area and net_area are 0, so the area counts once. Written by build into space.geojson
@@ -2,10 +2,59 @@ name: stair
2
2
  bases:
3
3
  - spatial_line_element
4
4
  - vertical_span
5
+ - materialized
6
+ description: >
7
+ A stair, built from components (Revit "stair by component"). The stair's own
8
+ 3D LineString is its first run (flight), bottom to top along the walking
9
+ line; further flights are `stair_run` rows and the platforms between them
10
+ `stair_landing` rows, all hosted on the stair via host_id. A stair row
11
+ without geometry is a pure container: its runs are all `stair_run` rows;
12
+ so is a stair whose line has the same bottom and top Z as its stair_run rows
13
+ together (an overall axis, as some exporters write it).
14
+
15
+ Curved / spiral stairs: runs (the stair's own line included) with a GeoJSON
16
+ `arc` property are curved along that walking-line arc. Winder stairs: a
17
+ stair_landing with `step_count` turns as winder treads instead of a flat
18
+ landing. "Stair by sketch" tools write the same runs and landings.
19
+
20
+ Riser rule: every riser of the stair has the same height (total rise / total
21
+ risers, winder risers included). A run of `step_count` risers has as many treads, going = run length
22
+ / step_count; the last tread is flush with the landing or floor above. Tools
23
+ keep run Z values and landing heights consistent with that rule (a landing's
24
+ top = the top of the run that arrives on it).
25
+
26
+ Multi-storey stairs (Revit "Multistory Top Level"): with
27
+ `multistory_top_level_id` set, the stair and all its runs, landings and
28
+ hosted railings repeat on every storey from its base level up to that level.
29
+ Each repetition keeps the step count and plan; its riser height adapts to the
30
+ storey height (rise scales by storey height / base storey height).
31
+
32
+ Subset of IFC IfcStairTypeEnum used here for the shape hint.
5
33
 
6
34
  fields:
7
35
  - name: width
8
36
  type: float
37
+ description: Clear width of the stair's own run (m).
9
38
 
10
39
  - name: step_count
11
40
  type: int
41
+ description: Risers in the stair's own (first) run; each stair_run has its own step_count.
42
+
43
+ - name: stair_type
44
+ type: enum
45
+ description: Overall shape of the stair. Subset of IfcStairTypeEnum.
46
+ values:
47
+ - straight
48
+ - quarter_turn # L-shape, one 90° landing
49
+ - half_turn # U-shape, two 90° landings or one 180° landing
50
+ - winder # turning steps (no landing)
51
+ - spiral
52
+ - curved
53
+ - double_return
54
+
55
+ - name: multistory_top_level_id
56
+ type: reference
57
+ reference: level
58
+ description: >
59
+ Optional. Repeat the whole stair on every storey up to this level (its
60
+ top). Empty = a single stair. Must be above the stair's base level.
@@ -0,0 +1,36 @@
1
+ name: stair_landing
2
+ bases:
3
+ - polygon_element
4
+ - materialized
5
+ description: >
6
+ Landing platform between two stair runs. Hosted on a `stair` row via host_id.
7
+ Stored as a polygon (the landing's plan footprint, any outline) plus a single
8
+ elevation (`base_offset` above level). Multiple landings can host on the same
9
+ stair for U / W / switchback configurations. The landing's top equals the top
10
+ of the run that arrives on it (tools keep them in step); the run leaving it
11
+ starts at that height.
12
+
13
+ Winders: with `step_count` > 0 the landing is not flat but turns as that
14
+ many winder treads (riser lines radiating from the inner corner of an L, or
15
+ from the middle of the well side of a U, equal going on the walking line).
16
+ Tread i is base_offset + i risers; the run leaving it starts on the last one
17
+ (base_offset + step_count risers). Its risers count in the stair's riser rule.
18
+
19
+ fields:
20
+ - name: host_id
21
+ type: reference
22
+ reference: element
23
+ required: true
24
+ description: ID of the parent stair row.
25
+
26
+ - name: base_offset
27
+ type: float
28
+ description: Top elevation of the landing relative to the stair's level (m).
29
+
30
+ - name: thickness
31
+ type: float
32
+ description: Slab thickness of the landing (m), hanging below its top. Defaults to 0.15 if blank.
33
+
34
+ - name: step_count
35
+ type: int
36
+ description: Winder risers in the turn (0 / empty = flat landing).
@@ -0,0 +1,31 @@
1
+ name: stair_run
2
+ bases:
3
+ - spatial_line_element
4
+ - materialized
5
+ description: >
6
+ One straight run (a flight of steps) within a stair. Hosted on the parent
7
+ `stair` row via host_id; multi-run stairs (L / U / switchback) are the
8
+ stair's own first run plus one or more stair_run rows, joined by
9
+ stair_landing rows. The 3D LineString runs along the walking line from the
10
+ bottom riser to the top; Z rises by step_count risers of the stair's common
11
+ riser height. A GeoJSON `arc` property makes the run curved: the walking
12
+ line is that arc (treads radiate from its centre, going measured on it),
13
+ the run's width centred on it; curved and spiral stairs are such runs
14
+ (consecutive runs continue round the same centre, each under 360°).
15
+
16
+ For straight single-run stairs the parent `stair` row's own spatial_line is
17
+ the run — stair_run is only needed when the stair has more than one flight.
18
+
19
+ fields:
20
+ - name: host_id
21
+ type: reference
22
+ reference: element
23
+ required: true
24
+ description: ID of the parent stair row.
25
+
26
+ - name: width
27
+ type: float
28
+
29
+ - name: step_count
30
+ type: int
31
+ description: Risers in this run.
@@ -8,4 +8,17 @@ fields:
8
8
  - name: thickness
9
9
  type: float
10
10
  required: true
11
- description: Wall thickness in meters. SVG stroke-width should match but CSV is source of truth.
11
+ description: Wall thickness in meters. CSV is the source of truth. May be empty when type_id is set (the type's thickness = sum of its layers).
12
+
13
+ - name: type_id
14
+ type: reference
15
+ reference: wall_type
16
+ description: Optional wall_type id. Empty type parameters (thickness, material) inherit the type's value; a set value overrides it for this element.
17
+
18
+ - name: top_attach_id
19
+ type: reference
20
+ reference: element
21
+ description: >
22
+ Attach Top (Revit): id of a roof or slab (any level) whose underside the
23
+ wall top follows wherever the wall is under it; elsewhere the wall keeps
24
+ its top_level_id / top_offset top. Empty = not attached.
@@ -11,3 +11,22 @@ fields:
11
11
 
12
12
  - name: height
13
13
  type: float
14
+
15
+ - name: operation
16
+ type: enum
17
+ description: How the window opens. Mirrors IFC IfcWindowTypePartitioningEnum.
18
+ values:
19
+ - fixed
20
+ - casement
21
+ - sliding
22
+ - awning
23
+ - hopper
24
+ - pivot
25
+ - double_hung
26
+ - single_hung
27
+ - tilt_and_turn
28
+
29
+ - name: type_id
30
+ type: reference
31
+ reference: window_type
32
+ description: Optional window_type id. Empty type parameters (width, height, operation, material) inherit the type's value; a set value overrides it for this element.
@@ -14,26 +14,35 @@ fields:
14
14
  reference: level
15
15
  computed: true
16
16
 
17
- - name: created_at
18
- type: datetime
19
- computed: true
20
-
21
- - name: updated_at
22
- type: datetime
23
- computed: true
24
-
25
17
  - name: base_offset
26
18
  type: float
27
19
  default: 0
20
+ storage: geojson_property
21
+ description: Vertical offset from base_level_id, meters. Stored in GeoJSON Feature properties.
28
22
 
29
23
  - name: mesh_file
30
24
  type: string
31
25
  description: Optional GLB mesh path for precise 3D visualization
32
26
 
33
- - name: volume
34
- type: float
35
- computed: true
27
+ - name: group_id
28
+ type: reference
29
+ reference: model_group
30
+ description: >
31
+ Model group instance (model_group row on the same level) this element
32
+ belongs to. Empty = not grouped.
33
+
34
+ - name: pinned
35
+ type: enum
36
+ values: ["true", "false"]
37
+ description: >
38
+ "true" = pinned: editors must not move, rotate or reshape the element
39
+ (it can still be edited in its properties). Empty = not pinned.
36
40
 
41
+ # bbox extents in meters. Not stored in CSV — exposed instead as the optional
42
+ # `size: [x, y, z]` GeoJSON Feature property on Point features (equipment,
43
+ # terminal, mep_node, column, …). For FamilyInstance elements the bbox is
44
+ # taken from the family symbol (local frame, rotation-invariant); for system
45
+ # families it is the world-axis-aligned bounding box.
37
46
  - name: bbox_min_x
38
47
  type: float
39
48
  computed: true
@@ -0,0 +1,60 @@
1
+ name: furniture_params
2
+ abstract: true
3
+ description: Library component parameters shared by furniture rows and furniture types.
4
+
5
+ fields:
6
+ - name: family
7
+ type: enum
8
+ required: true
9
+ description: Library family. Schedules count instances with GROUP BY family, variant.
10
+ values:
11
+ - desk
12
+ - office_chair
13
+ - chair
14
+ - meeting_table
15
+ - dining_table
16
+ - coffee_table
17
+ - sofa
18
+ - armchair
19
+ - bed
20
+ - nightstand
21
+ - wardrobe
22
+ - bookshelf
23
+ - filing_cabinet
24
+ - sideboard
25
+ - reception_counter
26
+ - locker
27
+ - base_cabinet
28
+ - wall_cabinet
29
+ - tall_cabinet
30
+ - refrigerator
31
+ - stove
32
+ - dishwasher
33
+ - washing_machine
34
+ - toilet_partition
35
+ - car
36
+ - parking_space
37
+ - tree
38
+ - plant
39
+ - person
40
+ - generic_box
41
+ - generic_cylinder
42
+
43
+ - name: variant
44
+ type: string
45
+ description: >
46
+ Family variant (e.g. bed single/double/king, sofa 2_seat/3_seat/l_shape,
47
+ desk standard/pedestal/l_shape, base_cabinet doors/drawers/sink). Empty =
48
+ the family's first variant. Must be a variant of the family.
49
+
50
+ - name: size_x
51
+ type: float
52
+ description: Width along the local X axis (left-right when facing the front), project units.
53
+
54
+ - name: size_y
55
+ type: float
56
+ description: Depth along the local Y axis (front to back), project units.
57
+
58
+ - name: height
59
+ type: float
60
+ description: Overall height above the base, project units.
@@ -4,14 +4,22 @@ bases:
4
4
  abstract: true
5
5
 
6
6
  fields:
7
+ # Override element.base_offset (geojson_property) → CSV: hosted elements are
8
+ # CSV-only (no GeoJSON file), so their sill/base height lives in the CSV.
9
+ - name: base_offset
10
+ type: float
11
+ default: 0
12
+ storage: csv
13
+ description: Sill/base height — vertical offset of the opening bottom from the host's base level, meters. Windows default to a 0.9m sill in viewers when unset.
14
+
7
15
  - name: host_id
8
16
  type: reference
9
17
  reference: element
10
- description: ID of the host wall. Required unless host_x/host_y are provided (auto-resolved by build).
18
+ description: ID of the host wall/floor. Required unless host_x/host_y are provided (auto-resolved by build).
11
19
 
12
20
  - name: position
13
21
  type: float
14
- description: Distance in meters from the host element's start point to the center of this opening. Required unless host_x/host_y are provided (auto-resolved by build).
22
+ description: Distance in length units from the host element's start point to the center of this opening. Required unless host_x/host_y are provided (auto-resolved by build).
15
23
 
16
24
  - name: host_x
17
25
  type: float
@@ -0,0 +1,23 @@
1
+ name: mep_connectable
2
+ abstract: true
3
+ description: >
4
+ Connectivity fields linking MEP curves (pipe/duct/conduit/cable_tray) to
5
+ their endpoint ports. `from`/`to` use the port-reference syntax
6
+ "host_id:port_name" (e.g. "eq-AHU-01:supply"), or bare "host_id" when the
7
+ host is a passive mep_node (auto-elbow/tee/coupling/cross/cap/transition)
8
+ whose ports are derived from connected-pipe geometry rather than declared
9
+ in connector.csv. Empty value = open end.
10
+
11
+ fields:
12
+ - name: from
13
+ type: string
14
+ description: >
15
+ Upstream port reference. Format "host_id:port_name" matching a row in
16
+ connector.csv with host_id and name; or bare "host_id" for passive
17
+ mep_node hosts. Empty = open upstream end.
18
+
19
+ - name: to
20
+ type: string
21
+ description: >
22
+ Downstream port reference. Same format as `from`. Empty = open
23
+ downstream end.
@@ -0,0 +1,24 @@
1
+ name: mep_design
2
+ abstract: true
3
+
4
+ # Design data on MEP devices (equipment / terminal). All optional; tools
5
+ # that size ducts, sum branch flows or add up circuit loads read them.
6
+ # flow / load are not lengths: they are never scaled by the project unit.
7
+
8
+ fields:
9
+ - name: flow
10
+ type: float
11
+ unit: none
12
+ description: >
13
+ Design flow rate, L/s. Air terminals: airflow; plumbing fixtures and
14
+ sprinklers: water flow; equipment: rated flow of its main system.
15
+
16
+ - name: load
17
+ type: float
18
+ unit: none
19
+ description: Electrical load, W (light fixtures, receptacles, motors). Summed per circuit.
20
+
21
+ - name: circuit_id
22
+ type: reference
23
+ reference: circuit
24
+ description: Electrical circuit (circuit table) this device is fed from. Empty = not on a circuit.
@@ -0,0 +1,9 @@
1
+ name: mep_insulated
2
+ abstract: true
3
+
4
+ fields:
5
+ - name: insulation_thickness
6
+ type: float
7
+ description: >
8
+ Thickness of the insulation wrapped around the duct / pipe, meters
9
+ (0 or empty = bare). The insulated outer size is size + 2 × thickness.
@@ -0,0 +1,12 @@
1
+ name: mep_system_tag
2
+ abstract: true
3
+
4
+ # Tags an element with its MEP system classification. The concrete project-level
5
+ # `mep_system` table (see mep/mep_system.yaml) holds human-readable system
6
+ # definitions; this base just stamps each individual MEP element (pipe, duct,
7
+ # equipment, ...) with the matching `system_type` short tag.
8
+
9
+ fields:
10
+ - name: system_type
11
+ type: string
12
+ description: System classification (e.g. "CHWS", "CHR", "SA", "RA", "DW")
@@ -15,3 +15,4 @@ fields:
15
15
  - name: rotation
16
16
  type: float
17
17
  computed: true
18
+ description: Degrees CCW about +Z. Hydrated from GeoJSON properties.rotation (default 0).
@@ -8,6 +8,11 @@ fields:
8
8
  values:
9
9
  - rect
10
10
  - round
11
+ - oval
12
+ description: >
13
+ oval = flat oval duct: two parallel flat sides and semicircular ends,
14
+ size_x the major axis, size_y the minor one (ducts only; other tables
15
+ treat it as rect).
11
16
 
12
17
  - name: size_x
13
18
  type: float
@@ -6,8 +6,10 @@ abstract: true
6
6
  fields:
7
7
  - name: start_z
8
8
  type: float
9
- required: true
9
+ computed: true
10
+ description: Z coordinate of the start endpoint. Hydrated from the 3rd component of the LineString's first coordinate.
10
11
 
11
12
  - name: end_z
12
13
  type: float
13
- required: true
14
+ computed: true
15
+ description: Z coordinate of the end endpoint. Hydrated from the 3rd component of the LineString's last coordinate.