brepjs-bim 0.14.0 → 0.15.0

package/README.md

@@ -67,15 +67,16 @@ Author a small model and export IFC:
 
 ```ts
 import { BimModel, toIfc } from 'brepjs-bim';
+import { unwrap } from 'brepjs';
 
 const model = new BimModel();
 model.init({ name: 'Example' });
 
 // Spatial structure: project → site → building → storey.
 const project = model.getProject();
-const siteId = model.addSite({ name: 'Site' });
-const buildingId = model.addBuilding({ name: 'Building' });
-const storeyId = model.addStorey({ name: 'Level 1', elevation: 0 });
+const siteId = unwrap(model.addSite({ name: 'Site' }));
+const buildingId = unwrap(model.addBuilding({ name: 'Building' }));
+const storeyId = unwrap(model.addStorey({ name: 'Level 1', elevation: 0 }));
 if (project) model.aggregate(project.localId, siteId);
 model.aggregate(siteId, buildingId);
 model.aggregate(buildingId, storeyId);

package/dist/brepjs-bim.cjs

@@ -6334,14 +6334,20 @@ var BimModel = class {
 			for (const mullion of el.geometry.mullions) mullion.solid[Symbol.dispose]();
 		}
 	}
-	addSite(spec) {
-		return this.#makeElement("SITE", spec, null);
+	addSite(spec, options) {
+		const keyCheck = this.#checkStableKey(options);
+		if (!keyCheck.ok) return keyCheck;
+		return (0, brepjs.ok)(this.#makeElement("SITE", spec, null, options?.stableKey));
 	}
 	addBuilding(spec, options) {
-		return this.#makeElement("BUILDING", spec, null, options?.stableKey);
+		const keyCheck = this.#checkStableKey(options);
+		if (!keyCheck.ok) return keyCheck;
+		return (0, brepjs.ok)(this.#makeElement("BUILDING", spec, null, options?.stableKey));
 	}
 	addStorey(spec, options) {
-		return this.#makeElement("STOREY", spec, null, options?.stableKey);
+		const keyCheck = this.#checkStableKey(options);
+		if (!keyCheck.ok) return keyCheck;
+		return (0, brepjs.ok)(this.#makeElement("STOREY", spec, null, options?.stableKey));
 	}
 	/** Reject a duplicate stableKey BEFORE any geometry is built, so the
 	*  Result-returning adders never allocate a solid they cannot store. */
@@ -6508,24 +6514,30 @@ var BimModel = class {
 	* attach parts with {@link aggregate} (IfcRelAggregates) or {@link nest}
 	* (IfcRelNests, order-preserving). Returns the assembly's localId.
 	*/
-	addElementAssembly(spec) {
-		return this.#makeElement("ELEMENT_ASSEMBLY", spec, null);
+	addElementAssembly(spec, options) {
+		const keyCheck = this.#checkStableKey(options);
+		if (!keyCheck.ok) return keyCheck;
+		return (0, brepjs.ok)(this.#makeElement("ELEMENT_ASSEMBLY", spec, null, options?.stableKey));
 	}
 	/**
 	* Adds an IfcZone grouping object (a thermal/fire/occupancy zone). The zone
 	* carries no geometry; attach members (spaces or other elements) with
-	* {@link assignToGroup}. Returns the zone's localId.
+	* {@link assignToGroup}. Returns the zone's localId as a Result.
 	*/
-	addZone(spec) {
-		return this.#makeElement("ZONE", spec, null);
+	addZone(spec, options) {
+		const keyCheck = this.#checkStableKey(options);
+		if (!keyCheck.ok) return keyCheck;
+		return (0, brepjs.ok)(this.#makeElement("ZONE", spec, null, options?.stableKey));
 	}
 	/**
 	* Adds an IfcSystem grouping object (an HVAC/electrical/plumbing system). The
 	* system carries no geometry; attach members with {@link assignToGroup}.
-	* Returns the system's localId.
+	* Returns the system's localId as a Result.
 	*/
-	addSystem(spec) {
-		return this.#makeElement("SYSTEM", spec, null);
+	addSystem(spec, options) {
+		const keyCheck = this.#checkStableKey(options);
+		if (!keyCheck.ok) return keyCheck;
+		return (0, brepjs.ok)(this.#makeElement("SYSTEM", spec, null, options?.stableKey));
 	}
 	/**
 	* Assigns members to a zone or system via IfcRelAssignsToGroup. Repeated calls
@@ -16747,9 +16759,18 @@ function familiesToBim(root, options) {
 	const model = new BimModel();
 	const initResult = model.init(options.project);
 	if (!initResult.ok) return initResult;
-	const siteId = model.addSite({ name: options.siteName ?? "Site" });
-	const buildingId = model.addBuilding({ name: options.buildingName ?? "Building" });
-	model.aggregate(siteId, buildingId);
+	const siteResult = model.addSite({ name: options.siteName ?? "Site" });
+	if (!siteResult.ok) {
+		model[Symbol.dispose]();
+		return siteResult;
+	}
+	const buildingResult = model.addBuilding({ name: options.buildingName ?? "Building" });
+	if (!buildingResult.ok) {
+		model[Symbol.dispose]();
+		return buildingResult;
+	}
+	const buildingId = buildingResult.value;
+	model.aggregate(siteResult.value, buildingId);
 	const idByKeyPath = /* @__PURE__ */ new Map();
 	const walk = (el, storeyId) => {
 		let containerId = storeyId;
@@ -16757,13 +16778,14 @@ function familiesToBim(root, options) {
 		if (el.type === "Storey") {
 			const keyed = requireKeyed(el);
 			if (!keyed.ok) return keyed;
-			const id = model.addStorey({
+			const storeyResult = model.addStorey({
 				name: el.attributes["name"] ?? el.keyPath,
 				elevation: el.props["elevation"] ?? 0
 			}, { stableKey: el.keyPath });
-			model.aggregate(buildingId, id);
-			idByKeyPath.set(el.keyPath, id);
-			containerId = id;
+			if (!storeyResult.ok) return storeyResult;
+			model.aggregate(buildingId, storeyResult.value);
+			idByKeyPath.set(el.keyPath, storeyResult.value);
+			containerId = storeyResult.value;
 		} else if (route !== void 0) {
 			const keyed = requireKeyed(el);
 			if (!keyed.ok) return keyed;

package/dist/brepjs-bim.js

@@ -6311,14 +6311,20 @@ var BimModel = class {
 			for (const mullion of el.geometry.mullions) mullion.solid[Symbol.dispose]();
 		}
 	}
-	addSite(spec) {
-		return this.#makeElement("SITE", spec, null);
+	addSite(spec, options) {
+		const keyCheck = this.#checkStableKey(options);
+		if (!keyCheck.ok) return keyCheck;
+		return ok(this.#makeElement("SITE", spec, null, options?.stableKey));
 	}
 	addBuilding(spec, options) {
-		return this.#makeElement("BUILDING", spec, null, options?.stableKey);
+		const keyCheck = this.#checkStableKey(options);
+		if (!keyCheck.ok) return keyCheck;
+		return ok(this.#makeElement("BUILDING", spec, null, options?.stableKey));
 	}
 	addStorey(spec, options) {
-		return this.#makeElement("STOREY", spec, null, options?.stableKey);
+		const keyCheck = this.#checkStableKey(options);
+		if (!keyCheck.ok) return keyCheck;
+		return ok(this.#makeElement("STOREY", spec, null, options?.stableKey));
 	}
 	/** Reject a duplicate stableKey BEFORE any geometry is built, so the
 	*  Result-returning adders never allocate a solid they cannot store. */
@@ -6485,24 +6491,30 @@ var BimModel = class {
 	* attach parts with {@link aggregate} (IfcRelAggregates) or {@link nest}
 	* (IfcRelNests, order-preserving). Returns the assembly's localId.
 	*/
-	addElementAssembly(spec) {
-		return this.#makeElement("ELEMENT_ASSEMBLY", spec, null);
+	addElementAssembly(spec, options) {
+		const keyCheck = this.#checkStableKey(options);
+		if (!keyCheck.ok) return keyCheck;
+		return ok(this.#makeElement("ELEMENT_ASSEMBLY", spec, null, options?.stableKey));
 	}
 	/**
 	* Adds an IfcZone grouping object (a thermal/fire/occupancy zone). The zone
 	* carries no geometry; attach members (spaces or other elements) with
-	* {@link assignToGroup}. Returns the zone's localId.
+	* {@link assignToGroup}. Returns the zone's localId as a Result.
 	*/
-	addZone(spec) {
-		return this.#makeElement("ZONE", spec, null);
+	addZone(spec, options) {
+		const keyCheck = this.#checkStableKey(options);
+		if (!keyCheck.ok) return keyCheck;
+		return ok(this.#makeElement("ZONE", spec, null, options?.stableKey));
 	}
 	/**
 	* Adds an IfcSystem grouping object (an HVAC/electrical/plumbing system). The
 	* system carries no geometry; attach members with {@link assignToGroup}.
-	* Returns the system's localId.
+	* Returns the system's localId as a Result.
 	*/
-	addSystem(spec) {
-		return this.#makeElement("SYSTEM", spec, null);
+	addSystem(spec, options) {
+		const keyCheck = this.#checkStableKey(options);
+		if (!keyCheck.ok) return keyCheck;
+		return ok(this.#makeElement("SYSTEM", spec, null, options?.stableKey));
 	}
 	/**
 	* Assigns members to a zone or system via IfcRelAssignsToGroup. Repeated calls
@@ -16724,9 +16736,18 @@ function familiesToBim(root, options) {
 	const model = new BimModel();
 	const initResult = model.init(options.project);
 	if (!initResult.ok) return initResult;
-	const siteId = model.addSite({ name: options.siteName ?? "Site" });
-	const buildingId = model.addBuilding({ name: options.buildingName ?? "Building" });
-	model.aggregate(siteId, buildingId);
+	const siteResult = model.addSite({ name: options.siteName ?? "Site" });
+	if (!siteResult.ok) {
+		model[Symbol.dispose]();
+		return siteResult;
+	}
+	const buildingResult = model.addBuilding({ name: options.buildingName ?? "Building" });
+	if (!buildingResult.ok) {
+		model[Symbol.dispose]();
+		return buildingResult;
+	}
+	const buildingId = buildingResult.value;
+	model.aggregate(siteResult.value, buildingId);
 	const idByKeyPath = /* @__PURE__ */ new Map();
 	const walk = (el, storeyId) => {
 		let containerId = storeyId;
@@ -16734,13 +16755,14 @@ function familiesToBim(root, options) {
 		if (el.type === "Storey") {
 			const keyed = requireKeyed(el);
 			if (!keyed.ok) return keyed;
-			const id = model.addStorey({
+			const storeyResult = model.addStorey({
 				name: el.attributes["name"] ?? el.keyPath,
 				elevation: el.props["elevation"] ?? 0
 			}, { stableKey: el.keyPath });
-			model.aggregate(buildingId, id);
-			idByKeyPath.set(el.keyPath, id);
-			containerId = id;
+			if (!storeyResult.ok) return storeyResult;
+			model.aggregate(buildingId, storeyResult.value);
+			idByKeyPath.set(el.keyPath, storeyResult.value);
+			containerId = storeyResult.value;
 		} else if (route !== void 0) {
 			const keyed = requireKeyed(el);
 			if (!keyed.ok) return keyed;

package/dist/model/bimModel.d.ts

@@ -37,9 +37,9 @@ export declare class BimModel {
     #private;
     init(spec: ProjectSpec): Result<LocalId, BimError>;
     [Symbol.dispose](): void;
-    addSite(spec: SiteSpec): LocalId;
-    addBuilding(spec: BuildingSpec, options?: ElementIdentityOptions): LocalId;
-    addStorey(spec: StoreySpec, options?: ElementIdentityOptions): LocalId;
+    addSite(spec: SiteSpec, options?: ElementIdentityOptions): Result<LocalId, BimError>;
+    addBuilding(spec: BuildingSpec, options?: ElementIdentityOptions): Result<LocalId, BimError>;
+    addStorey(spec: StoreySpec, options?: ElementIdentityOptions): Result<LocalId, BimError>;
     addWall(spec: WallSpec, options?: ElementIdentityOptions): Result<LocalId, BimError>;
     addSlab(spec: SlabSpec, options?: ElementIdentityOptions): Result<LocalId, BimError>;
     addBeam(spec: BeamSpec, options?: ElementIdentityOptions): Result<LocalId, BimError>;
@@ -72,19 +72,19 @@ export declare class BimModel {
      * attach parts with {@link aggregate} (IfcRelAggregates) or {@link nest}
      * (IfcRelNests, order-preserving). Returns the assembly's localId.
      */
-    addElementAssembly(spec: ElementAssemblySpec): LocalId;
+    addElementAssembly(spec: ElementAssemblySpec, options?: ElementIdentityOptions): Result<LocalId, BimError>;
     /**
      * Adds an IfcZone grouping object (a thermal/fire/occupancy zone). The zone
      * carries no geometry; attach members (spaces or other elements) with
-     * {@link assignToGroup}. Returns the zone's localId.
+     * {@link assignToGroup}. Returns the zone's localId as a Result.
      */
-    addZone(spec: ZoneSpec): LocalId;
+    addZone(spec: ZoneSpec, options?: ElementIdentityOptions): Result<LocalId, BimError>;
     /**
      * Adds an IfcSystem grouping object (an HVAC/electrical/plumbing system). The
      * system carries no geometry; attach members with {@link assignToGroup}.
-     * Returns the system's localId.
+     * Returns the system's localId as a Result.
      */
-    addSystem(spec: SystemSpec): LocalId;
+    addSystem(spec: SystemSpec, options?: ElementIdentityOptions): Result<LocalId, BimError>;
     /**
      * Assigns members to a zone or system via IfcRelAssignsToGroup. Repeated calls
      * for the same group extend the single relationship in call order. Returns the

package/package.json

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