brepjs-bim 0.16.1 → 0.17.0

package/README.md

@@ -23,7 +23,8 @@ curtain walls, a panel/mullion grid). Element geometry is **unplaced template ge
 coordinates — placement (`origin` / `axisX` / `axisZ`) is applied by the IFC layer via
 `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
+(stairs and ramps return one solid per flight, curtain walls their panels and mullions) — handy
+for display so the on-screen scene matches the IFC
 export.
 
 - Units default to mm; IFC export emits SI metres.
@@ -35,18 +36,18 @@ export.
 
 ## Status
 
-| Area              | State                                                                                                    |
-| ----------------- | -------------------------------------------------------------------------------------------------------- |
-| Elements          | wall, slab, beam, column, roof, curtain wall, space, footing/pile, stair, ramp, railing, covering, proxy |
-| Profiles          | rectangular / circular / I-shape cores + extended L/T/U/Z/C, hollow, ellipse, arbitrary-with-voids       |
-| Openings          | door / window / slab openings cut as boolean voids; `FillsOpening` / `Voids*` relationships              |
-| Spatial structure | project → site → building → storey aggregation; `placeIn` to assign elements to a storey                 |
-| Property sets     | IFC pset templates + measure types; quantity sets for takeoff                                            |
-| Data layers       | materials (layer/profile/simple sets), classification refs, surface styles, zones/systems                |
-| IFC export        | `toIfc` → IFC-SPF (`Uint8Array`); IFC4 / IFC4X3 schema selection; owner history                          |
-| IFC import        | `fromIfc` / `SpfReader` → `ImportedModel` (elements, geometry, psets, materials, spatial tree)           |
-| Validation        | referential integrity, schema check, geometry validity, IFC round-trip report                            |
-| Interop           | COBie 2.4 export (CSV/JSON), IDS 1.0 checking, BCF 3.0 read/write                                        |
+| Area              | State                                                                                                      |
+| ----------------- | ---------------------------------------------------------------------------------------------------------- |
+| Elements          | wall, slab, beam, column, roof, curtain wall, space, footing/pile, stair, ramp, railing, covering, proxy   |
+| Profiles          | rectangular / circular / I-shape cores + extended L/T/U/Z/C, hollow, ellipse, arbitrary-with-voids         |
+| Openings          | door / window / slab openings cut as boolean voids; `FillsOpening` / `Voids*` relationships                |
+| Spatial structure | project → site → building → storey aggregation; `placeIn` to assign elements to a storey                   |
+| Property sets     | IFC pset templates + measure types; quantity sets for takeoff                                              |
+| Data layers       | materials (layer/profile/simple sets), classification refs, surface styles, zones/systems                  |
+| IFC export        | `toIfc` → IFC-SPF (`Uint8Array`); IFC4 / IFC4X3 schema selection; owner history                            |
+| IFC import        | `fromIfc` / `SpfReader` → `ImportedModel` (elements, geometry, psets, materials, spatial tree)             |
+| Validation        | referential integrity, schema check, geometry validity, IFC round-trip report, buildingSMART gherkin rules |
+| Interop           | COBie 2.4 export (CSV/JSON), IDS 1.0 checking, BCF 3.0 read/write                                          |
 
 ### Independent validation
 
@@ -56,9 +57,13 @@ web-ifc parser used internally), not just self-checked. The committed sample
 validator and generates geometry for every product. See [VALIDATION.md](./VALIDATION.md)
 to reproduce, and `examples/sampleBuilding.mjs` for the model it validates.
 
-> **Not yet:** the official buildingSMART Validation Service and desktop-tool
-> interop (Revit / Solibri) are unverified — the fixtures and per-tool
-> checklists are ready in [VALIDATION.md](./VALIDATION.md). This is an
+The buildingSMART Validation Service's complete normative rule catalog also runs
+locally (`scripts/setupGherkinRunner.sh` builds the service's own engine; all three
+committed fixtures pass 950 scenarios with zero failures), so service findings are
+reproducible before upload.
+
+> **Not yet:** desktop-tool interop (Revit / Solibri) is unverified. The fixtures
+> and per-tool checklists are ready in [VALIDATION.md](./VALIDATION.md). This is an
 > experimental pre-1.0 package and the API may change.
 
 ## Usage
@@ -98,7 +103,7 @@ if (wall.ok) model.placeIn(wall.value, storeyId);
 const solid = model.getWalls()[0]?.geometry;
 
 // Serialize to an IFC-SPF byte buffer.
-const ifc = await toIfc(model, { name: 'Example', author: 'brepjs-bim' });
+const ifc = await toIfc(model, { applicationName: 'brepjs-bim', applicationVersion: '1.0' });
 // ifc.ok && ifc.value instanceof Uint8Array
 ```
 

package/dist/brepjs-bim.cjs

@@ -7314,6 +7314,65 @@ function stairFlightToSolid(spec) {
 	}
 }
 //#endregion
+//#region src/elementFns/rampFns.ts
+function buildSilhouette(length, rise, thickness) {
+	return [
+		[
+			0,
+			0,
+			-thickness
+		],
+		[
+			length,
+			0,
+			rise - thickness
+		],
+		[
+			length,
+			0,
+			rise
+		],
+		[
+			0,
+			0,
+			0
+		]
+	];
+}
+function rampFlightToSolid(spec) {
+	try {
+		var _usingCtx$4 = _usingCtx();
+		if (spec.width <= 0) return (0, brepjs.err)(specError("RAMP_FLIGHT_ZERO_WIDTH", "Ramp flight width must be positive"));
+		if (spec.length <= 0) return (0, brepjs.err)(specError("RAMP_FLIGHT_ZERO_LENGTH", "Ramp flight length must be positive"));
+		if (spec.slope <= 0) return (0, brepjs.err)(specError("RAMP_FLIGHT_ZERO_SLOPE", "Ramp flight slope must be positive"));
+		if (spec.thickness <= 0) return (0, brepjs.err)(specError("RAMP_FLIGHT_ZERO_THICKNESS", "Ramp flight thickness must be positive"));
+		const rise = spec.length * spec.slope;
+		const silhouette = buildSilhouette(spec.length, rise, spec.thickness);
+		const profileResult = (0, brepjs.polygon)(silhouette);
+		if (!profileResult.ok) return (0, brepjs.err)(fromBrepError(profileResult.error, "RAMP_FLIGHT_PROFILE_FAILED", "Failed to create ramp flight silhouette profile"));
+		const profile = _usingCtx$4.u(profileResult.value);
+		const solidResult = (0, brepjs.extrude)(profile, [
+			0,
+			spec.width,
+			0
+		]);
+		if (!solidResult.ok) return (0, brepjs.err)(fromBrepError(solidResult.error, "RAMP_FLIGHT_EXTRUDE_FAILED", "Failed to extrude ramp flight silhouette"));
+		const solid = solidResult.value;
+		if (!(0, brepjs.isValidSolid)(solid)) {
+			solid[Symbol.dispose]();
+			return (0, brepjs.err)(geometryError("RAMP_FLIGHT_INVALID_SOLID", "Ramp flight solid failed validity check"));
+		}
+		return (0, brepjs.ok)({
+			solid,
+			geometrySimplified: true
+		});
+	} catch (_) {
+		_usingCtx$4.e = _;
+	} finally {
+		_usingCtx$4.d();
+	}
+}
+//#endregion
 //#region src/elementFns/placedGeometry.ts
 function place(solid, frame) {
 	const result = (0, brepjs.applyMatrix)(solid, placementToMatrix(frame));
@@ -7332,10 +7391,10 @@ function disposeAll(solids) {
 * failure the solids already built for this call are disposed before the error is
 * returned, so no partial array is leaked.
 *
-* Stairs carry no element solid (`.geometry` is null), so flight solids are built
-* from `spec.flights` and placed per flight. Curtain walls return placed panels +
-* mullions. Elements with no solid geometry (doors/windows/ramps/groups/spatial)
-* return an empty array.
+* Stairs and ramps carry no element solid (`.geometry` is null), so flight
+* solids are built from `spec.flights` and placed per flight. Curtain walls
+* return placed panels + mullions. Elements with no solid geometry
+* (doors/windows/groups/spatial) return an empty array.
 */
 function placedSolids(el) {
 	switch (el.category) {
@@ -7347,6 +7406,7 @@ function placedSolids(el) {
 		case "ROOF":
 		case "FOOTING":
 		case "PILE":
+		case "COVERING":
 		case "RAILING": {
 			const placed = place(el.geometry, el.spec);
 			if (!placed.ok) return placed;
@@ -7355,29 +7415,51 @@ function placedSolids(el) {
 		case "STAIR": {
 			const out = [];
 			for (const flight of el.spec.flights) try {
-				var _usingCtx$4 = _usingCtx();
+				var _usingCtx$3 = _usingCtx();
 				const built = stairFlightToSolid(flight);
 				if (!built.ok) {
 					disposeAll(out);
 					return (0, brepjs.err)(built.error);
 				}
-				const placed = place(_usingCtx$4.u(built.value.solid), flight);
+				const placed = place(_usingCtx$3.u(built.value.solid), flight);
+				if (!placed.ok) {
+					disposeAll(out);
+					return placed;
+				}
+				out.push(placed.value);
+			} catch (_) {
+				_usingCtx$3.e = _;
+			} finally {
+				_usingCtx$3.d();
+			}
+			return (0, brepjs.ok)(out);
+		}
+		case "RAMP": {
+			const out = [];
+			for (const flight of el.spec.flights) try {
+				var _usingCtx3 = _usingCtx();
+				const built = rampFlightToSolid(flight);
+				if (!built.ok) {
+					disposeAll(out);
+					return (0, brepjs.err)(built.error);
+				}
+				const placed = place(_usingCtx3.u(built.value.solid), flight);
 				if (!placed.ok) {
 					disposeAll(out);
 					return placed;
 				}
 				out.push(placed.value);
 			} catch (_) {
-				_usingCtx$4.e = _;
+				_usingCtx3.e = _;
 			} finally {
-				_usingCtx$4.d();
+				_usingCtx3.d();
 			}
 			return (0, brepjs.ok)(out);
 		}
 		case "CURTAIN_WALL": {
 			const out = [];
 			for (const c of [...el.geometry.panels, ...el.geometry.mullions]) try {
-				var _usingCtx3 = _usingCtx();
+				var _usingCtx4 = _usingCtx();
 				const componentLocal = place(c.solid, {
 					origin: c.origin,
 					axisX: [
@@ -7395,16 +7477,16 @@ function placedSolids(el) {
 					disposeAll(out);
 					return componentLocal;
 				}
-				const placed = place(_usingCtx3.u(componentLocal.value), el.spec);
+				const placed = place(_usingCtx4.u(componentLocal.value), el.spec);
 				if (!placed.ok) {
 					disposeAll(out);
 					return placed;
 				}
 				out.push(placed.value);
 			} catch (_) {
-				_usingCtx3.e = _;
+				_usingCtx4.e = _;
 			} finally {
-				_usingCtx3.d();
+				_usingCtx4.d();
 			}
 			return (0, brepjs.ok)(out);
 		}
@@ -9491,65 +9573,6 @@ function writeRelContainedInSpatialStructure(w, guid, ownerHistoryId, relatingSt
 	});
 }
 //#endregion
-//#region src/elementFns/rampFns.ts
-function buildSilhouette(length, rise, thickness) {
-	return [
-		[
-			0,
-			0,
-			-thickness
-		],
-		[
-			length,
-			0,
-			rise - thickness
-		],
-		[
-			length,
-			0,
-			rise
-		],
-		[
-			0,
-			0,
-			0
-		]
-	];
-}
-function rampFlightToSolid(spec) {
-	try {
-		var _usingCtx$3 = _usingCtx();
-		if (spec.width <= 0) return (0, brepjs.err)(specError("RAMP_FLIGHT_ZERO_WIDTH", "Ramp flight width must be positive"));
-		if (spec.length <= 0) return (0, brepjs.err)(specError("RAMP_FLIGHT_ZERO_LENGTH", "Ramp flight length must be positive"));
-		if (spec.slope <= 0) return (0, brepjs.err)(specError("RAMP_FLIGHT_ZERO_SLOPE", "Ramp flight slope must be positive"));
-		if (spec.thickness <= 0) return (0, brepjs.err)(specError("RAMP_FLIGHT_ZERO_THICKNESS", "Ramp flight thickness must be positive"));
-		const rise = spec.length * spec.slope;
-		const silhouette = buildSilhouette(spec.length, rise, spec.thickness);
-		const profileResult = (0, brepjs.polygon)(silhouette);
-		if (!profileResult.ok) return (0, brepjs.err)(fromBrepError(profileResult.error, "RAMP_FLIGHT_PROFILE_FAILED", "Failed to create ramp flight silhouette profile"));
-		const profile = _usingCtx$3.u(profileResult.value);
-		const solidResult = (0, brepjs.extrude)(profile, [
-			0,
-			spec.width,
-			0
-		]);
-		if (!solidResult.ok) return (0, brepjs.err)(fromBrepError(solidResult.error, "RAMP_FLIGHT_EXTRUDE_FAILED", "Failed to extrude ramp flight silhouette"));
-		const solid = solidResult.value;
-		if (!(0, brepjs.isValidSolid)(solid)) {
-			solid[Symbol.dispose]();
-			return (0, brepjs.err)(geometryError("RAMP_FLIGHT_INVALID_SOLID", "Ramp flight solid failed validity check"));
-		}
-		return (0, brepjs.ok)({
-			solid,
-			geometrySimplified: true
-		});
-	} catch (_) {
-		_usingCtx$3.e = _;
-	} finally {
-		_usingCtx$3.d();
-	}
-}
-//#endregion
 //#region src/ifc-writer/stairWriter.ts
 function writeLocalPlacement(w, origin, axisZ, axisX, parentPlacementId) {
 	const placement3DId = writeAxis2Placement3D(w, origin.map(toIfcLengthM), axisZ, axisX);

package/dist/brepjs-bim.js

@@ -7291,6 +7291,65 @@ function stairFlightToSolid(spec) {
 	}
 }
 //#endregion
+//#region src/elementFns/rampFns.ts
+function buildSilhouette(length, rise, thickness) {
+	return [
+		[
+			0,
+			0,
+			-thickness
+		],
+		[
+			length,
+			0,
+			rise - thickness
+		],
+		[
+			length,
+			0,
+			rise
+		],
+		[
+			0,
+			0,
+			0
+		]
+	];
+}
+function rampFlightToSolid(spec) {
+	try {
+		var _usingCtx$4 = _usingCtx();
+		if (spec.width <= 0) return err(specError("RAMP_FLIGHT_ZERO_WIDTH", "Ramp flight width must be positive"));
+		if (spec.length <= 0) return err(specError("RAMP_FLIGHT_ZERO_LENGTH", "Ramp flight length must be positive"));
+		if (spec.slope <= 0) return err(specError("RAMP_FLIGHT_ZERO_SLOPE", "Ramp flight slope must be positive"));
+		if (spec.thickness <= 0) return err(specError("RAMP_FLIGHT_ZERO_THICKNESS", "Ramp flight thickness must be positive"));
+		const rise = spec.length * spec.slope;
+		const silhouette = buildSilhouette(spec.length, rise, spec.thickness);
+		const profileResult = polygon(silhouette);
+		if (!profileResult.ok) return err(fromBrepError(profileResult.error, "RAMP_FLIGHT_PROFILE_FAILED", "Failed to create ramp flight silhouette profile"));
+		const profile = _usingCtx$4.u(profileResult.value);
+		const solidResult = extrude(profile, [
+			0,
+			spec.width,
+			0
+		]);
+		if (!solidResult.ok) return err(fromBrepError(solidResult.error, "RAMP_FLIGHT_EXTRUDE_FAILED", "Failed to extrude ramp flight silhouette"));
+		const solid = solidResult.value;
+		if (!isValidSolid(solid)) {
+			solid[Symbol.dispose]();
+			return err(geometryError("RAMP_FLIGHT_INVALID_SOLID", "Ramp flight solid failed validity check"));
+		}
+		return ok({
+			solid,
+			geometrySimplified: true
+		});
+	} catch (_) {
+		_usingCtx$4.e = _;
+	} finally {
+		_usingCtx$4.d();
+	}
+}
+//#endregion
 //#region src/elementFns/placedGeometry.ts
 function place(solid, frame) {
 	const result = applyMatrix(solid, placementToMatrix(frame));
@@ -7309,10 +7368,10 @@ function disposeAll(solids) {
 * failure the solids already built for this call are disposed before the error is
 * returned, so no partial array is leaked.
 *
-* Stairs carry no element solid (`.geometry` is null), so flight solids are built
-* from `spec.flights` and placed per flight. Curtain walls return placed panels +
-* mullions. Elements with no solid geometry (doors/windows/ramps/groups/spatial)
-* return an empty array.
+* Stairs and ramps carry no element solid (`.geometry` is null), so flight
+* solids are built from `spec.flights` and placed per flight. Curtain walls
+* return placed panels + mullions. Elements with no solid geometry
+* (doors/windows/groups/spatial) return an empty array.
 */
 function placedSolids(el) {
 	switch (el.category) {
@@ -7324,6 +7383,7 @@ function placedSolids(el) {
 		case "ROOF":
 		case "FOOTING":
 		case "PILE":
+		case "COVERING":
 		case "RAILING": {
 			const placed = place(el.geometry, el.spec);
 			if (!placed.ok) return placed;
@@ -7332,29 +7392,51 @@ function placedSolids(el) {
 		case "STAIR": {
 			const out = [];
 			for (const flight of el.spec.flights) try {
-				var _usingCtx$4 = _usingCtx();
+				var _usingCtx$3 = _usingCtx();
 				const built = stairFlightToSolid(flight);
 				if (!built.ok) {
 					disposeAll(out);
 					return err(built.error);
 				}
-				const placed = place(_usingCtx$4.u(built.value.solid), flight);
+				const placed = place(_usingCtx$3.u(built.value.solid), flight);
+				if (!placed.ok) {
+					disposeAll(out);
+					return placed;
+				}
+				out.push(placed.value);
+			} catch (_) {
+				_usingCtx$3.e = _;
+			} finally {
+				_usingCtx$3.d();
+			}
+			return ok(out);
+		}
+		case "RAMP": {
+			const out = [];
+			for (const flight of el.spec.flights) try {
+				var _usingCtx3 = _usingCtx();
+				const built = rampFlightToSolid(flight);
+				if (!built.ok) {
+					disposeAll(out);
+					return err(built.error);
+				}
+				const placed = place(_usingCtx3.u(built.value.solid), flight);
 				if (!placed.ok) {
 					disposeAll(out);
 					return placed;
 				}
 				out.push(placed.value);
 			} catch (_) {
-				_usingCtx$4.e = _;
+				_usingCtx3.e = _;
 			} finally {
-				_usingCtx$4.d();
+				_usingCtx3.d();
 			}
 			return ok(out);
 		}
 		case "CURTAIN_WALL": {
 			const out = [];
 			for (const c of [...el.geometry.panels, ...el.geometry.mullions]) try {
-				var _usingCtx3 = _usingCtx();
+				var _usingCtx4 = _usingCtx();
 				const componentLocal = place(c.solid, {
 					origin: c.origin,
 					axisX: [
@@ -7372,16 +7454,16 @@ function placedSolids(el) {
 					disposeAll(out);
 					return componentLocal;
 				}
-				const placed = place(_usingCtx3.u(componentLocal.value), el.spec);
+				const placed = place(_usingCtx4.u(componentLocal.value), el.spec);
 				if (!placed.ok) {
 					disposeAll(out);
 					return placed;
 				}
 				out.push(placed.value);
 			} catch (_) {
-				_usingCtx3.e = _;
+				_usingCtx4.e = _;
 			} finally {
-				_usingCtx3.d();
+				_usingCtx4.d();
 			}
 			return ok(out);
 		}
@@ -9468,65 +9550,6 @@ function writeRelContainedInSpatialStructure(w, guid, ownerHistoryId, relatingSt
 	});
 }
 //#endregion
-//#region src/elementFns/rampFns.ts
-function buildSilhouette(length, rise, thickness) {
-	return [
-		[
-			0,
-			0,
-			-thickness
-		],
-		[
-			length,
-			0,
-			rise - thickness
-		],
-		[
-			length,
-			0,
-			rise
-		],
-		[
-			0,
-			0,
-			0
-		]
-	];
-}
-function rampFlightToSolid(spec) {
-	try {
-		var _usingCtx$3 = _usingCtx();
-		if (spec.width <= 0) return err(specError("RAMP_FLIGHT_ZERO_WIDTH", "Ramp flight width must be positive"));
-		if (spec.length <= 0) return err(specError("RAMP_FLIGHT_ZERO_LENGTH", "Ramp flight length must be positive"));
-		if (spec.slope <= 0) return err(specError("RAMP_FLIGHT_ZERO_SLOPE", "Ramp flight slope must be positive"));
-		if (spec.thickness <= 0) return err(specError("RAMP_FLIGHT_ZERO_THICKNESS", "Ramp flight thickness must be positive"));
-		const rise = spec.length * spec.slope;
-		const silhouette = buildSilhouette(spec.length, rise, spec.thickness);
-		const profileResult = polygon(silhouette);
-		if (!profileResult.ok) return err(fromBrepError(profileResult.error, "RAMP_FLIGHT_PROFILE_FAILED", "Failed to create ramp flight silhouette profile"));
-		const profile = _usingCtx$3.u(profileResult.value);
-		const solidResult = extrude(profile, [
-			0,
-			spec.width,
-			0
-		]);
-		if (!solidResult.ok) return err(fromBrepError(solidResult.error, "RAMP_FLIGHT_EXTRUDE_FAILED", "Failed to extrude ramp flight silhouette"));
-		const solid = solidResult.value;
-		if (!isValidSolid(solid)) {
-			solid[Symbol.dispose]();
-			return err(geometryError("RAMP_FLIGHT_INVALID_SOLID", "Ramp flight solid failed validity check"));
-		}
-		return ok({
-			solid,
-			geometrySimplified: true
-		});
-	} catch (_) {
-		_usingCtx$3.e = _;
-	} finally {
-		_usingCtx$3.d();
-	}
-}
-//#endregion
 //#region src/ifc-writer/stairWriter.ts
 function writeLocalPlacement(w, origin, axisZ, axisX, parentPlacementId) {
 	const placement3DId = writeAxis2Placement3D(w, origin.map(toIfcLengthM), axisZ, axisX);

package/dist/elementFns/placedGeometry.d.ts

@@ -10,9 +10,9 @@ import { BimError } from '../errors/bimError.js';
  * failure the solids already built for this call are disposed before the error is
  * returned, so no partial array is leaked.
  *
- * Stairs carry no element solid (`.geometry` is null), so flight solids are built
- * from `spec.flights` and placed per flight. Curtain walls return placed panels +
- * mullions. Elements with no solid geometry (doors/windows/ramps/groups/spatial)
- * return an empty array.
+ * Stairs and ramps carry no element solid (`.geometry` is null), so flight
+ * solids are built from `spec.flights` and placed per flight. Curtain walls
+ * return placed panels + mullions. Elements with no solid geometry
+ * (doors/windows/groups/spatial) return an empty array.
  */
 export declare function placedSolids(el: AnyBimElement): Result<readonly ValidSolid[], BimError>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "brepjs-bim",
-  "version": "0.16.1",
+  "version": "0.17.0",
   "description": "BIM layer for brepjs — IFC4-aligned parametric building elements",
   "keywords": [
     "bim",