brepjs-bim 0.17.1 → 0.18.0

package/README.md

@@ -14,6 +14,13 @@ and serializes the result to a valid **IFC-SPF** file — with a matching import
 Pipeline: **author spec → `BimModel` (typed element + brepjs geometry) → spatial structure +
 property sets + classification → export IFC / COBie, validate, round-trip.**
 
+The declarative entry point is
+[`brepjs-families`](https://www.npmjs.com/package/brepjs-families): author the building as a tree of
+prop-driven components, then `familiesToBim(tree, { project })` projects it onto a `BimModel` with
+stable GlobalIds derived from component key paths. Hand-authoring specs against `BimModel` remains
+the low-level path (and covers elements the declarative route doesn't yet). See the
+[Declarative Models guide](https://brepjs.dev/families/overview).
+
 ## Scope
 
 Parametric authoring of the common IFC4 building elements plus the data layers that make a model

package/dist/brepjs-bim.cjs

@@ -27624,7 +27624,8 @@ function assignNum(target, key, value) {
 * fill-role void (Door/Window family) maps onto addDoor/addWindow, which cut
 * the wall and wire IfcRelVoidsElement + IfcRelFillsElement; the opening and
 * filler GlobalIds derive from the synthesized key paths. Anonymous (non-fill)
-* voids stay IR-only and never reach the spec path.
+* voids are rejected: they cut only the IR/viewport geometry, and exporting
+* the uncut spec body would silently diverge from what the user sees.
 */
 var SPEC_DEFAULTS = {
 	origin: [
@@ -27734,6 +27735,16 @@ function peelTranslates(node) {
 		moved
 	};
 }
+/** True when the element's transform PROP carries a rotation. The spec path
+*  folds only translations into IfcLocalPlacement (walls orient via `axisX`),
+*  so a tRotate placement would export un-rotated while the viewport shows it
+*  rotated — reject instead of diverging. Rotations a family render bakes
+*  into its own body geometry (e.g. a circular beam oriented along axisX) are
+*  fine: the spec rebuilds that body parametrically from props. */
+function hasRotateOp(el) {
+	const ops = el.props["transform"];
+	return Array.isArray(ops) && ops.some((op) => typeof op === "object" && op !== null && op.op === "rotate");
+}
 /** Fold the resolved geometry's outer translate chain into the spec placement
 *  origin, so IfcLocalPlacement matches the IR world frame no matter where the
 *  transform came from (family-internal or prop-level). */
@@ -27765,18 +27776,43 @@ function specInput(el) {
 		...collectSpecProps(el)
 	};
 }
+/** `Pset_<Type>Common` fields the specs model first-class: mapped onto their
+*  spec names so the writer emits them in the element's own common pset. */
+var COMMON_PSET_FIELDS = {
+	IsExternal: "isExternal",
+	FireRating: "fireRating",
+	AcousticRating: "acousticRating",
+	ThermalTransmittance: "thermalTransmittance",
+	LoadBearing: "loadBearing",
+	Status: "status"
+};
 function collectSpecProps(el) {
-	const psets = el.attributes["psets"];
 	const out = {};
+	const material = el.attributes["material"];
+	if (typeof material === "string" && el.props["materialName"] === void 0) out["materialName"] = material;
+	const psets = el.attributes["psets"];
 	if (psets && typeof psets === "object") {
-		const common = psets["Pset_WallCommon"];
-		if (common && typeof common === "object") {
-			const c = common;
-			if (typeof c["IsExternal"] === "boolean") out["isExternal"] = c["IsExternal"];
-			if (typeof c["FireRating"] === "string") out["fireRating"] = c["FireRating"];
+		const custom = {};
+		const ownCommonPset = `Pset_${el.type}Common`;
+		for (const [psetName, fields] of Object.entries(psets)) {
+			if (!fields || typeof fields !== "object") continue;
+			const record = fields;
+			if (psetName === ownCommonPset) {
+				for (const [field, specKey] of Object.entries(COMMON_PSET_FIELDS)) if (record[field] !== void 0) out[specKey] = record[field];
+			} else {
+				const values = {};
+				for (const [field, value] of Object.entries(record)) if (typeof value === "string" || typeof value === "number" || typeof value === "boolean") values[field] = value;
+				if (Object.keys(values).length > 0) custom[psetName] = values;
+			}
+		}
+		if (Object.keys(custom).length > 0) {
+			const declared = el.props["customProperties"];
+			out["customProperties"] = declared && typeof declared === "object" ? {
+				...custom,
+				...declared
+			} : custom;
 		}
 	}
-	delete out["psets"];
 	return out;
 }
 function addFill(model, fill, input, identity) {
@@ -27817,6 +27853,7 @@ function addOpenings(model, host, wallId, containerId, idByKeyPath) {
 		const added = addFill(model, fill, {
 			materialName: SPEC_DEFAULTS.materialName,
 			...stripGeometryProps(fill.props),
+			...collectSpecProps(fill),
 			wallLocalId: wallId,
 			offsetAlongWall: delta[0] * axisX[0] + delta[1] * axisX[1] + delta[2] * axisX[2],
 			offsetFromFloor: delta[2]
@@ -27863,7 +27900,8 @@ function familiesToBim(root, options) {
 	if (project !== null) model.aggregate(project.localId, siteResult.value);
 	model.aggregate(siteResult.value, buildingId);
 	const idByKeyPath = /* @__PURE__ */ new Map();
-	const walk = (el, storeyId) => {
+	const walk = (el, storeyId, rotated) => {
+		const rotatedHere = rotated || hasRotateOp(el);
 		let containerId = storeyId;
 		const route = specRoute(el.type);
 		if (el.type === "Storey") {
@@ -27880,6 +27918,12 @@ function familiesToBim(root, options) {
 		} else if (route !== void 0) {
 			const keyed = requireKeyed(el);
 			if (!keyed.ok) return keyed;
+			if (rotatedHere) return (0, brepjs.err)(specError("FAMILIES_UNSUPPORTED_TRANSFORM", `familiesToBim: '${el.keyPath}' carries a rotated placement — the spec path folds only translations into IfcLocalPlacement; orient walls via axisX instead of tRotate`));
+			const voids = el.props["voids"];
+			if (Array.isArray(voids)) {
+				const openings = el.children.filter((c) => c.type === "Opening").length;
+				if (voids.length > openings) return (0, brepjs.err)(specError("FAMILIES_ANONYMOUS_VOID", `familiesToBim: '${el.keyPath}' has ${voids.length - openings} anonymous void(s) the IFC body cannot carry — use a fill-role family (Door/Window) for each void`));
+			}
 			const parsed = route.parse(("input" in route ? route.input : specInput)(el));
 			if (!parsed.ok) return parsed;
 			const added = route.add(model, parsed.value, el.keyPath);
@@ -27895,12 +27939,12 @@ function familiesToBim(root, options) {
 		else if (el.type !== "Group" && el.geometry.kind !== "Empty") return (0, brepjs.err)(specError("FAMILIES_UNSUPPORTED_TYPE", `familiesToBim: no spec mapping for element type '${el.type}' at '${el.keyPath}'`));
 		for (const child of el.children) {
 			if (el.type === "Wall" && child.type === "Opening") continue;
-			const r = walk(child, containerId);
+			const r = walk(child, containerId, rotatedHere);
 			if (!r.ok) return r;
 		}
 		return (0, brepjs.ok)(void 0);
 	};
-	const walked = walk(root, null);
+	const walked = walk(root, null, false);
 	if (!walked.ok) {
 		model[Symbol.dispose]();
 		return walked;

package/dist/brepjs-bim.js

@@ -27601,7 +27601,8 @@ function assignNum(target, key, value) {
 * fill-role void (Door/Window family) maps onto addDoor/addWindow, which cut
 * the wall and wire IfcRelVoidsElement + IfcRelFillsElement; the opening and
 * filler GlobalIds derive from the synthesized key paths. Anonymous (non-fill)
-* voids stay IR-only and never reach the spec path.
+* voids are rejected: they cut only the IR/viewport geometry, and exporting
+* the uncut spec body would silently diverge from what the user sees.
 */
 var SPEC_DEFAULTS = {
 	origin: [
@@ -27711,6 +27712,16 @@ function peelTranslates(node) {
 		moved
 	};
 }
+/** True when the element's transform PROP carries a rotation. The spec path
+*  folds only translations into IfcLocalPlacement (walls orient via `axisX`),
+*  so a tRotate placement would export un-rotated while the viewport shows it
+*  rotated — reject instead of diverging. Rotations a family render bakes
+*  into its own body geometry (e.g. a circular beam oriented along axisX) are
+*  fine: the spec rebuilds that body parametrically from props. */
+function hasRotateOp(el) {
+	const ops = el.props["transform"];
+	return Array.isArray(ops) && ops.some((op) => typeof op === "object" && op !== null && op.op === "rotate");
+}
 /** Fold the resolved geometry's outer translate chain into the spec placement
 *  origin, so IfcLocalPlacement matches the IR world frame no matter where the
 *  transform came from (family-internal or prop-level). */
@@ -27742,18 +27753,43 @@ function specInput(el) {
 		...collectSpecProps(el)
 	};
 }
+/** `Pset_<Type>Common` fields the specs model first-class: mapped onto their
+*  spec names so the writer emits them in the element's own common pset. */
+var COMMON_PSET_FIELDS = {
+	IsExternal: "isExternal",
+	FireRating: "fireRating",
+	AcousticRating: "acousticRating",
+	ThermalTransmittance: "thermalTransmittance",
+	LoadBearing: "loadBearing",
+	Status: "status"
+};
 function collectSpecProps(el) {
-	const psets = el.attributes["psets"];
 	const out = {};
+	const material = el.attributes["material"];
+	if (typeof material === "string" && el.props["materialName"] === void 0) out["materialName"] = material;
+	const psets = el.attributes["psets"];
 	if (psets && typeof psets === "object") {
-		const common = psets["Pset_WallCommon"];
-		if (common && typeof common === "object") {
-			const c = common;
-			if (typeof c["IsExternal"] === "boolean") out["isExternal"] = c["IsExternal"];
-			if (typeof c["FireRating"] === "string") out["fireRating"] = c["FireRating"];
+		const custom = {};
+		const ownCommonPset = `Pset_${el.type}Common`;
+		for (const [psetName, fields] of Object.entries(psets)) {
+			if (!fields || typeof fields !== "object") continue;
+			const record = fields;
+			if (psetName === ownCommonPset) {
+				for (const [field, specKey] of Object.entries(COMMON_PSET_FIELDS)) if (record[field] !== void 0) out[specKey] = record[field];
+			} else {
+				const values = {};
+				for (const [field, value] of Object.entries(record)) if (typeof value === "string" || typeof value === "number" || typeof value === "boolean") values[field] = value;
+				if (Object.keys(values).length > 0) custom[psetName] = values;
+			}
+		}
+		if (Object.keys(custom).length > 0) {
+			const declared = el.props["customProperties"];
+			out["customProperties"] = declared && typeof declared === "object" ? {
+				...custom,
+				...declared
+			} : custom;
 		}
 	}
-	delete out["psets"];
 	return out;
 }
 function addFill(model, fill, input, identity) {
@@ -27794,6 +27830,7 @@ function addOpenings(model, host, wallId, containerId, idByKeyPath) {
 		const added = addFill(model, fill, {
 			materialName: SPEC_DEFAULTS.materialName,
 			...stripGeometryProps(fill.props),
+			...collectSpecProps(fill),
 			wallLocalId: wallId,
 			offsetAlongWall: delta[0] * axisX[0] + delta[1] * axisX[1] + delta[2] * axisX[2],
 			offsetFromFloor: delta[2]
@@ -27840,7 +27877,8 @@ function familiesToBim(root, options) {
 	if (project !== null) model.aggregate(project.localId, siteResult.value);
 	model.aggregate(siteResult.value, buildingId);
 	const idByKeyPath = /* @__PURE__ */ new Map();
-	const walk = (el, storeyId) => {
+	const walk = (el, storeyId, rotated) => {
+		const rotatedHere = rotated || hasRotateOp(el);
 		let containerId = storeyId;
 		const route = specRoute(el.type);
 		if (el.type === "Storey") {
@@ -27857,6 +27895,12 @@ function familiesToBim(root, options) {
 		} else if (route !== void 0) {
 			const keyed = requireKeyed(el);
 			if (!keyed.ok) return keyed;
+			if (rotatedHere) return err(specError("FAMILIES_UNSUPPORTED_TRANSFORM", `familiesToBim: '${el.keyPath}' carries a rotated placement — the spec path folds only translations into IfcLocalPlacement; orient walls via axisX instead of tRotate`));
+			const voids = el.props["voids"];
+			if (Array.isArray(voids)) {
+				const openings = el.children.filter((c) => c.type === "Opening").length;
+				if (voids.length > openings) return err(specError("FAMILIES_ANONYMOUS_VOID", `familiesToBim: '${el.keyPath}' has ${voids.length - openings} anonymous void(s) the IFC body cannot carry — use a fill-role family (Door/Window) for each void`));
+			}
 			const parsed = route.parse(("input" in route ? route.input : specInput)(el));
 			if (!parsed.ok) return parsed;
 			const added = route.add(model, parsed.value, el.keyPath);
@@ -27872,12 +27916,12 @@ function familiesToBim(root, options) {
 		else if (el.type !== "Group" && el.geometry.kind !== "Empty") return err(specError("FAMILIES_UNSUPPORTED_TYPE", `familiesToBim: no spec mapping for element type '${el.type}' at '${el.keyPath}'`));
 		for (const child of el.children) {
 			if (el.type === "Wall" && child.type === "Opening") continue;
-			const r = walk(child, containerId);
+			const r = walk(child, containerId, rotatedHere);
 			if (!r.ok) return r;
 		}
 		return ok(void 0);
 	};
-	const walked = walk(root, null);
+	const walked = walk(root, null, false);
 	if (!walked.ok) {
 		model[Symbol.dispose]();
 		return walked;

package/package.json

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