brepjs-bim 0.13.0 → 0.14.0

package/README.md

@@ -43,7 +43,7 @@ export.
 | 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`); IFC2X3 / IFC4 schema selection; owner history                          |
+| 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                                        |
@@ -57,8 +57,9 @@ validator and generates geometry for every product. See [VALIDATION.md](./VALIDA
 to reproduce, and `examples/sampleBuilding.mjs` for the model it validates.
 
 > **Not yet:** the official buildingSMART Validation Service and desktop-tool
-> interop (Revit / ArchiCAD / Solibri) are unverified. This is an early-stage
-> (`0.1.x`) experimental package and the API will change.
+> interop (Revit / Solibri) are 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
 

package/dist/brepjs-bim.cjs

@@ -6398,10 +6398,12 @@ var BimModel = class {
 		this.#associateClassification(id, spec);
 		return (0, brepjs.ok)(id);
 	}
-	addSpace(spec) {
+	addSpace(spec, options) {
+		const keyCheck = this.#checkStableKey(options);
+		if (!keyCheck.ok) return keyCheck;
 		const geomResult = spaceToSolid(spec);
 		if (!geomResult.ok) return (0, brepjs.err)(geomResult.error);
-		const id = this.#makeElement("SPACE", spec, geomResult.value);
+		const id = this.#makeElement("SPACE", spec, geomResult.value, options?.stableKey);
 		this.#associateMaterial(id, spec);
 		this.#associateClassification(id, spec);
 		return (0, brepjs.ok)(id);
@@ -6416,26 +6418,32 @@ var BimModel = class {
 		this.#associateClassification(id, spec);
 		return (0, brepjs.ok)(id);
 	}
-	addCurtainWall(spec) {
+	addCurtainWall(spec, options) {
+		const keyCheck = this.#checkStableKey(options);
+		if (!keyCheck.ok) return keyCheck;
 		const gridResult = curtainWallToGrid(spec);
 		if (!gridResult.ok) return (0, brepjs.err)(gridResult.error);
-		const id = this.#makeElement("CURTAIN_WALL", spec, gridResult.value);
+		const id = this.#makeElement("CURTAIN_WALL", spec, gridResult.value, options?.stableKey);
 		this.#associateMaterial(id, spec);
 		this.#associateClassification(id, spec);
 		return (0, brepjs.ok)(id);
 	}
-	addFooting(spec) {
+	addFooting(spec, options) {
+		const keyCheck = this.#checkStableKey(options);
+		if (!keyCheck.ok) return keyCheck;
 		const geomResult = footingToSolid(spec);
 		if (!geomResult.ok) return (0, brepjs.err)(geomResult.error);
-		const id = this.#makeElement("FOOTING", spec, geomResult.value);
+		const id = this.#makeElement("FOOTING", spec, geomResult.value, options?.stableKey);
 		this.#associateMaterial(id, spec);
 		this.#associateClassification(id, spec);
 		return (0, brepjs.ok)(id);
 	}
-	addPile(spec) {
+	addPile(spec, options) {
+		const keyCheck = this.#checkStableKey(options);
+		if (!keyCheck.ok) return keyCheck;
 		const geomResult = pileToSolid(spec);
 		if (!geomResult.ok) return (0, brepjs.err)(geomResult.error);
-		const id = this.#makeElement("PILE", spec, geomResult.value);
+		const id = this.#makeElement("PILE", spec, geomResult.value, options?.stableKey);
 		this.#associateMaterial(id, spec);
 		this.#associateClassification(id, spec);
 		return (0, brepjs.ok)(id);
@@ -6465,10 +6473,12 @@ var BimModel = class {
 		this.#associateClassification(id, spec);
 		return (0, brepjs.ok)(id);
 	}
-	addRailing(spec) {
+	addRailing(spec, options) {
+		const keyCheck = this.#checkStableKey(options);
+		if (!keyCheck.ok) return keyCheck;
 		const geomResult = railingToSolid(spec);
 		if (!geomResult.ok) return (0, brepjs.err)(geomResult.error);
-		const id = this.#makeElement("RAILING", spec, geomResult.value);
+		const id = this.#makeElement("RAILING", spec, geomResult.value, options?.stableKey);
 		this.#associateMaterial(id, spec);
 		this.#associateClassification(id, spec);
 		return (0, brepjs.ok)(id);
@@ -6478,10 +6488,12 @@ var BimModel = class {
 	* IfcRelCoversBldgElements linking the covering to its host (e.g. a slab it
 	* finishes) is recorded for export.
 	*/
-	addCovering(spec, hostLocalId) {
+	addCovering(spec, hostLocalId, options) {
+		const keyCheck = this.#checkStableKey(options);
+		if (!keyCheck.ok) return keyCheck;
 		const geomResult = coveringToSolid(spec);
 		if (!geomResult.ok) return (0, brepjs.err)(geomResult.error);
-		const id = this.#makeElement("COVERING", spec, geomResult.value);
+		const id = this.#makeElement("COVERING", spec, geomResult.value, options?.stableKey);
 		this.#associateMaterial(id, spec);
 		this.#associateClassification(id, spec);
 		if (hostLocalId !== void 0) this.#makeRel({
@@ -6649,9 +6661,11 @@ var BimModel = class {
 	* and disposes it on model disposal; the caller must not dispose it (see
 	* {@link ProxySpec.solid}).
 	*/
-	addProxy(spec) {
+	addProxy(spec, options) {
+		const keyCheck = this.#checkStableKey(options);
+		if (!keyCheck.ok) return keyCheck;
 		if (spec.solid === null || spec.solid === void 0) return (0, brepjs.err)(specError("PROXY_NO_GEOMETRY", "ProxySpec.solid is required"));
-		const id = this.#makeElement("PROXY", spec, spec.solid);
+		const id = this.#makeElement("PROXY", spec, spec.solid, options?.stableKey);
 		if (spec.materialName !== void 0) this.#makeRel({
 			kind: "ASSOCIATES_MATERIAL",
 			materialName: spec.materialName,

package/dist/brepjs-bim.js

@@ -6375,10 +6375,12 @@ var BimModel = class {
 		this.#associateClassification(id, spec);
 		return ok(id);
 	}
-	addSpace(spec) {
+	addSpace(spec, options) {
+		const keyCheck = this.#checkStableKey(options);
+		if (!keyCheck.ok) return keyCheck;
 		const geomResult = spaceToSolid(spec);
 		if (!geomResult.ok) return err(geomResult.error);
-		const id = this.#makeElement("SPACE", spec, geomResult.value);
+		const id = this.#makeElement("SPACE", spec, geomResult.value, options?.stableKey);
 		this.#associateMaterial(id, spec);
 		this.#associateClassification(id, spec);
 		return ok(id);
@@ -6393,26 +6395,32 @@ var BimModel = class {
 		this.#associateClassification(id, spec);
 		return ok(id);
 	}
-	addCurtainWall(spec) {
+	addCurtainWall(spec, options) {
+		const keyCheck = this.#checkStableKey(options);
+		if (!keyCheck.ok) return keyCheck;
 		const gridResult = curtainWallToGrid(spec);
 		if (!gridResult.ok) return err(gridResult.error);
-		const id = this.#makeElement("CURTAIN_WALL", spec, gridResult.value);
+		const id = this.#makeElement("CURTAIN_WALL", spec, gridResult.value, options?.stableKey);
 		this.#associateMaterial(id, spec);
 		this.#associateClassification(id, spec);
 		return ok(id);
 	}
-	addFooting(spec) {
+	addFooting(spec, options) {
+		const keyCheck = this.#checkStableKey(options);
+		if (!keyCheck.ok) return keyCheck;
 		const geomResult = footingToSolid(spec);
 		if (!geomResult.ok) return err(geomResult.error);
-		const id = this.#makeElement("FOOTING", spec, geomResult.value);
+		const id = this.#makeElement("FOOTING", spec, geomResult.value, options?.stableKey);
 		this.#associateMaterial(id, spec);
 		this.#associateClassification(id, spec);
 		return ok(id);
 	}
-	addPile(spec) {
+	addPile(spec, options) {
+		const keyCheck = this.#checkStableKey(options);
+		if (!keyCheck.ok) return keyCheck;
 		const geomResult = pileToSolid(spec);
 		if (!geomResult.ok) return err(geomResult.error);
-		const id = this.#makeElement("PILE", spec, geomResult.value);
+		const id = this.#makeElement("PILE", spec, geomResult.value, options?.stableKey);
 		this.#associateMaterial(id, spec);
 		this.#associateClassification(id, spec);
 		return ok(id);
@@ -6442,10 +6450,12 @@ var BimModel = class {
 		this.#associateClassification(id, spec);
 		return ok(id);
 	}
-	addRailing(spec) {
+	addRailing(spec, options) {
+		const keyCheck = this.#checkStableKey(options);
+		if (!keyCheck.ok) return keyCheck;
 		const geomResult = railingToSolid(spec);
 		if (!geomResult.ok) return err(geomResult.error);
-		const id = this.#makeElement("RAILING", spec, geomResult.value);
+		const id = this.#makeElement("RAILING", spec, geomResult.value, options?.stableKey);
 		this.#associateMaterial(id, spec);
 		this.#associateClassification(id, spec);
 		return ok(id);
@@ -6455,10 +6465,12 @@ var BimModel = class {
 	* IfcRelCoversBldgElements linking the covering to its host (e.g. a slab it
 	* finishes) is recorded for export.
 	*/
-	addCovering(spec, hostLocalId) {
+	addCovering(spec, hostLocalId, options) {
+		const keyCheck = this.#checkStableKey(options);
+		if (!keyCheck.ok) return keyCheck;
 		const geomResult = coveringToSolid(spec);
 		if (!geomResult.ok) return err(geomResult.error);
-		const id = this.#makeElement("COVERING", spec, geomResult.value);
+		const id = this.#makeElement("COVERING", spec, geomResult.value, options?.stableKey);
 		this.#associateMaterial(id, spec);
 		this.#associateClassification(id, spec);
 		if (hostLocalId !== void 0) this.#makeRel({
@@ -6626,9 +6638,11 @@ var BimModel = class {
 	* and disposes it on model disposal; the caller must not dispose it (see
 	* {@link ProxySpec.solid}).
 	*/
-	addProxy(spec) {
+	addProxy(spec, options) {
+		const keyCheck = this.#checkStableKey(options);
+		if (!keyCheck.ok) return keyCheck;
 		if (spec.solid === null || spec.solid === void 0) return err(specError("PROXY_NO_GEOMETRY", "ProxySpec.solid is required"));
-		const id = this.#makeElement("PROXY", spec, spec.solid);
+		const id = this.#makeElement("PROXY", spec, spec.solid, options?.stableKey);
 		if (spec.materialName !== void 0) this.#makeRel({
 			kind: "ASSOCIATES_MATERIAL",
 			materialName: spec.materialName,

package/dist/model/bimModel.d.ts

@@ -44,11 +44,11 @@ export declare class BimModel {
     addSlab(spec: SlabSpec, options?: ElementIdentityOptions): Result<LocalId, BimError>;
     addBeam(spec: BeamSpec, options?: ElementIdentityOptions): Result<LocalId, BimError>;
     addColumn(spec: ColumnSpec, options?: ElementIdentityOptions): Result<LocalId, BimError>;
-    addSpace(spec: SpaceSpec): Result<LocalId, BimError>;
+    addSpace(spec: SpaceSpec, options?: ElementIdentityOptions): Result<LocalId, BimError>;
     addRoof(spec: RoofSpec, options?: ElementIdentityOptions): Result<LocalId, BimError>;
-    addCurtainWall(spec: CurtainWallSpec): Result<LocalId, BimError>;
-    addFooting(spec: FootingSpec): Result<LocalId, BimError>;
-    addPile(spec: PileSpec): Result<LocalId, BimError>;
+    addCurtainWall(spec: CurtainWallSpec, options?: ElementIdentityOptions): Result<LocalId, BimError>;
+    addFooting(spec: FootingSpec, options?: ElementIdentityOptions): Result<LocalId, BimError>;
+    addPile(spec: PileSpec, options?: ElementIdentityOptions): Result<LocalId, BimError>;
     /**
      * Adds an IfcStair assembly. Geometry for each flight is built and written by
      * the IFC layer from `spec.flights`; the STAIR element itself carries no solid
@@ -60,13 +60,13 @@ export declare class BimModel {
      * IFC layer from `spec.flights`; the RAMP element carries no solid of its own.
      */
     addRamp(spec: RampSpec, options?: ElementIdentityOptions): Result<LocalId, BimError>;
-    addRailing(spec: RailingSpec): Result<LocalId, BimError>;
+    addRailing(spec: RailingSpec, options?: ElementIdentityOptions): Result<LocalId, BimError>;
     /**
      * Adds an IfcCovering. When `hostLocalId` is supplied, an
      * IfcRelCoversBldgElements linking the covering to its host (e.g. a slab it
      * finishes) is recorded for export.
      */
-    addCovering(spec: CoveringSpec, hostLocalId?: LocalId): Result<LocalId, BimError>;
+    addCovering(spec: CoveringSpec, hostLocalId?: LocalId, options?: ElementIdentityOptions): Result<LocalId, BimError>;
     /**
      * Adds an IfcElementAssembly grouping container. The assembly has no geometry;
      * attach parts with {@link aggregate} (IfcRelAggregates) or {@link nest}
@@ -130,7 +130,7 @@ export declare class BimModel {
      * and disposes it on model disposal; the caller must not dispose it (see
      * {@link ProxySpec.solid}).
      */
-    addProxy(spec: ProxySpec): Result<LocalId, BimError>;
+    addProxy(spec: ProxySpec, options?: ElementIdentityOptions): Result<LocalId, BimError>;
     addDoor(spec: DoorSpec, options?: OpeningIdentityOptions): Result<LocalId, BimError>;
     addWindow(spec: WindowSpec, options?: OpeningIdentityOptions): Result<LocalId, BimError>;
     addSlabOpening(input: SlabOpeningInput, options?: ElementIdentityOptions): Result<LocalId, BimError>;

package/package.json

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