brepjs-bim 0.2.0 → 0.3.1

package/README.md

@@ -21,10 +21,17 @@ useful downstream (psets, classification, materials, quantities), with import, e
 validation. Geometry is produced by brepjs (OCCT); each element carries a `ValidSolid` (or, for
 curtain walls, a panel/mullion grid). Element geometry is **unplaced template geometry** in local
 coordinates — placement (`origin` / `axisX` / `axisZ`) is applied by the IFC layer via
-`IfcLocalPlacement`, not baked into the brepjs solid.
+`IfcLocalPlacement`, not baked into the brepjs solid. Use `placedSolids(element)` to read an
+element's geometry already transformed to its world placement as fresh, caller-owned solids
+(stairs return one solid per flight) — handy for display so the on-screen scene matches the IFC
+export.
 
 - Units default to mm; IFC export emits SI metres.
 - Stable identity: deterministic IFC GUIDs (`deriveIfcGuid`) and local id counters.
+- Shaped geometry: roofs build real shed/gable/hip/dome solids when `pitch` is set (flat slab
+  otherwise); railings build posts + top/bottom rails with `infill: 'POSTED'` (a single swept panel
+  otherwise). Shaped roofs and posted railings serialize to IFC as tessellated bodies; flat roofs
+  and panel railings keep their parametric `IfcExtrudedAreaSolid`.
 
 ## Status
 

package/dist/bcf/bcfXml.d.ts

@@ -24,9 +24,15 @@ export interface XmlNode {
     readonly text: string;
 }
 /**
- * Parse an XML string into a tree. Tolerant of the XML declaration, comments,
- * whitespace, self-closing tags, and CDATA-free text. Throws on malformed
- * structure (unbalanced tags); callers wrap this in a `Result`.
+ * Parse an XML string into a tree. Tolerant of the XML declaration, processing
+ * instructions, comments, whitespace, self-closing tags, and CDATA-free text.
+ * Throws on malformed or unbalanced structure; callers wrap this in a `Result`.
+ *
+ * This is a hand-written cursor scan rather than a single tokenizing regex: the
+ * input is an untrusted `.bcfzip` payload, and a backtracking regex over
+ * uncontrolled data is a polynomial-ReDoS vector. Every construct here is
+ * consumed by an `indexOf` or a single-character advance, so the parse is linear
+ * in the input length. The sibling `ids/idsXml.ts` parser scans the same way.
  */
 export declare function parseXml(xml: string): XmlNode;
 export declare function findChild(node: XmlNode, tag: string): XmlNode | undefined;