brepjs-bim 0.23.2 → 0.24.1

package/dist/elementFns/placedGeometry.d.ts

@@ -2,6 +2,11 @@ import { ValidSolid, Result } from 'brepjs';
 import { AnyBimElement } from '../types/bimTypes.js';
 import { BimError } from '../errors/bimError.js';
 import { FrameInput } from '../import/placement.js';
+export interface PlacedGeometryTestHooks {
+    readonly afterPlaced?: ((solid: ValidSolid) => void) | undefined;
+}
+/** Package-internal deterministic failure seam for placement ownership tests. */
+export declare function setPlacedGeometryTestHooksForTesting(hooks: PlacedGeometryTestHooks | null): void;
 export interface PlacedSolidsOptions {
     /**
      * Cumulative frame of the element's containing spatial structure. Element

package/dist/errors/bimError.d.ts

@@ -8,7 +8,7 @@ export interface BimError {
     readonly metadata?: Readonly<Record<string, unknown>>;
 }
 export declare function specError(code: string, message: string, cause?: unknown): BimError;
-export declare function ifcError(code: string, message: string, cause?: unknown): BimError;
+export declare function ifcError(code: string, message: string, cause?: unknown, metadata?: Readonly<Record<string, unknown>>): BimError;
 export declare function geometryError(code: string, message: string, cause?: unknown): BimError;
 /**
  * IFC-import error factory. Codes used by the reader subsystem:

package/dist/familiesAdapter.d.ts

@@ -9,9 +9,16 @@ export interface FamiliesToBimOptions {
     readonly siteName?: string | undefined;
     readonly buildingName?: string | undefined;
     /**
-     * Materializes exact evaluated Product Bodies for supported typed routes
-     * such as Earthworks Fill. Supplying this option does not opt unsupported
-     * products into the proxy fallback.
+     * Materializes exact evaluated Product Bodies for supported typed routes.
+     * Earthworks Fill always retains that Body. Civil-semantic walls and railings
+     * require this evaluator (or `proxyEvaluator`) before projection: absence
+     * returns FAMILIES_PRODUCT_BODY_EVALUATOR_REQUIRED with the element path and
+     * mapped category, and does not fall back to a parametric envelope.
+     * Conventional archetype walls and railings stay specification-authoritative
+     * and do not require an evaluator. When present, civil walls and railings
+     * compare the evaluated Body with their post-opening parametric Body and
+     * retain the authored Body when they differ. Supplying this option does not
+     * opt unsupported products into the proxy fallback.
      */
     readonly bodyEvaluator?: csg.Evaluator | undefined;
     /**
@@ -44,6 +51,11 @@ export interface FamiliesBimResult {
      */
     readonly proxied: readonly ProxiedElement[];
 }
+export interface FamiliesAdapterTestHooks {
+    readonly afterCivilProductBody?: ((model: BimModel, localId: LocalId, element: ResolvedElement) => void) | undefined;
+}
+/** Package-internal deterministic failure seam for projection ownership tests. */
+export declare function setFamiliesAdapterTestHooksForTesting(hooks: FamiliesAdapterTestHooks | null): void;
 /**
  * Project a resolved families tree into an eager BimModel. The caller owns
  * the returned model (`using`); families stays domain-neutral — this adapter

package/dist/familiesProductBody.d.ts

@@ -0,0 +1,40 @@
+import { Result, Solid, ValidSolid, csg } from 'brepjs';
+import { ResolvedElement } from 'brepjs-families';
+import { BimError } from './errors/bimError.js';
+import { ProductBody } from './types/productBody.js';
+import { Frame } from './placementFrame.js';
+type ExactProductBody = Extract<ProductBody, {
+    readonly kind: 'EXACT';
+}>;
+type ParametricProductBody = Extract<ProductBody, {
+    readonly kind: 'PARAMETRIC';
+}>;
+export type CivilProductBodySelection = {
+    readonly kind: 'PARAMETRIC';
+} | {
+    readonly kind: 'EXACT';
+    readonly body: ExactProductBody;
+};
+export interface CivilProductBodyInput {
+    readonly element: ResolvedElement;
+    readonly category: 'WALL' | 'RAILING';
+    readonly evaluator: csg.Evaluator;
+    readonly productWorldFrame: Frame;
+    /** Borrowed model-owned comparison candidate after registered openings. */
+    readonly parametricBody: ParametricProductBody;
+}
+export interface FamiliesProductBodyTestHooks {
+    readonly afterCopy?: ((itemIndex: number, solid: Solid, source: Solid) => void) | undefined;
+    readonly beforeLocalize?: ((itemIndex: number, solid: ValidSolid) => void) | undefined;
+    readonly afterLocalized?: ((itemIndex: number, solid: ValidSolid) => void) | undefined;
+    readonly beforeCoincidence?: ((exact: ExactProductBody, parametric: ParametricProductBody) => void) | undefined;
+}
+/** Package-internal deterministic failure seams for exact ownership tests. */
+export declare function setFamiliesProductBodyTestHooksForTesting(hooks: FamiliesProductBodyTestHooks | null): void;
+/**
+ * Evaluates a civil Product Body, clones and localizes every borrowed source,
+ * then proves whether the registered-opening parametric Body is coincident.
+ * An EXACT result is caller-owned until takeExactProductBody() succeeds.
+ */
+export declare function selectCivilProductBody(input: CivilProductBodyInput): Result<CivilProductBodySelection, BimError>;
+export {};

package/dist/ifc-writer/ifcWriter.d.ts

@@ -3,6 +3,18 @@ import { BimError } from '../errors/bimError.js';
 import { IfcGuid } from '../identity/ifcGuid.js';
 import { IfcSchema } from './schemaVersion.js';
 import { Result } from 'brepjs';
+export interface IfcWriterApiForTesting {
+    WriteLine(modelId: number, entity: unknown): void;
+    CreateIfcType(modelId: number, type: number, value: unknown): Record<string, unknown>;
+    SaveModel(modelId: number): Uint8Array;
+    CloseModel(modelId: number): void;
+}
+export interface IfcWriterTestHooks {
+    readonly afterWriteLine?: (() => void) | undefined;
+    readonly afterClose?: (() => void) | undefined;
+}
+/** Package-internal deterministic lifecycle observation seam. */
+export declare function setIfcWriterTestHooksForTesting(hooks: IfcWriterTestHooks | null): void;
 /** Default MVD ViewDefinition declared in the STEP FILE_DESCRIPTION header. */
 export declare const DEFAULT_MVD_VIEW_DEFINITION = "ReferenceView_v1.2";
 export interface IfcHeaderMeta {
@@ -13,6 +25,8 @@ export declare class IfcWriter {
     #private;
     private constructor();
     static create(mvdViewDefinition?: string, ifcSchema?: IfcSchema, header?: IfcHeaderMeta): Promise<Result<IfcWriter, BimError>>;
+    /** Package-internal lifecycle seam for deterministic writer cleanup tests. */
+    static fromApiForTesting(api: IfcWriterApiForTesting, modelId?: number): IfcWriter;
     nextId(): number;
     /**
      * Deterministic GlobalId for a writer-minted line, keyed on its express ID.
@@ -27,5 +41,7 @@ export declare class IfcWriter {
     } & Record<string, unknown>): number;
     ref(id: number): InstanceType<typeof Handle>;
     mkType(type: number, value: unknown): Record<string, unknown>;
+    close(): void;
+    [Symbol.dispose](): void;
     save(): Result<Uint8Array, BimError>;
 }

package/dist/ifc-writer/psetWriter.d.ts

@@ -45,6 +45,12 @@ export declare function writeCustomPsets(w: IfcWriter, ownerHistoryId: number, e
  */
 export declare function resolveDensityKgM3(materialName: string | undefined, explicitDensityKgM3: number | undefined): number | undefined;
 export declare function writeWallBaseQuantities(w: IfcWriter, ownerHistoryId: number, wallExpressId: number, spec: WallSpec, openings: readonly WallOpeningSpec[], densityKgM3?: number): void;
+export declare function writeExactWallBaseQuantities(w: IfcWriter, ownerHistoryId: number, wallExpressId: number, values: {
+    readonly lengthM: number;
+    readonly widthM: number;
+    readonly heightM: number;
+    readonly netVolumeM3: number;
+}): void;
 export declare function writeSlabCommonPset(w: IfcWriter, ownerHistoryId: number, slabExpressId: number, spec: SlabSpec): void;
 export declare function writeSlabBaseQuantities(w: IfcWriter, ownerHistoryId: number, slabExpressId: number, spec: SlabSpec, openings: readonly SlabOpeningSpec[], densityKgM3?: number): void;
 export declare function writeBeamCommonPset(w: IfcWriter, ownerHistoryId: number, beamExpressId: number, spec: BeamSpec): void;

package/dist/ifc-writer/tessellationWriter.d.ts

@@ -1,5 +1,7 @@
 import { ValidSolid } from 'brepjs';
 import { IfcWriter } from './ifcWriter.js';
+import { FrameInput } from '../import/placement.js';
+import { NonEmpty } from '../types/productBody.js';
 export interface TessellationResult {
     readonly productDefinitionShapeId: number;
     /** True when the IfcFacetedBrep fallback was used because mesh() failed. */
@@ -11,6 +13,24 @@ export interface TessellationFallbackResult {
     readonly fallbackReason: string;
 }
 export type TessellationOutput = TessellationResult | TessellationFallbackResult;
+export interface PreparedTessellation {
+    readonly coordList: readonly (readonly [number, number, number])[];
+    readonly coordIndex: readonly (readonly [number, number, number])[];
+}
+export type TessellationPreparation = {
+    readonly ok: true;
+    readonly value: PreparedTessellation;
+} | {
+    readonly ok: false;
+    readonly reason: string;
+    readonly cause?: unknown;
+};
+export interface ExactBodyRepresentationIds {
+    readonly localPlacementId: number;
+    readonly productDefinitionShapeId: number;
+    readonly bodyItemIds: readonly number[];
+}
+export declare function prepareTessellation(solid: ValidSolid, toleranceMm?: number): TessellationPreparation;
 /**
  * Writes an IfcTriangulatedFaceSet (preferred IFC4 tessellation) from a brepjs
  * ValidSolid, wrapped in an IfcShapeRepresentation (Body/Tessellation) and an
@@ -29,6 +49,12 @@ export type TessellationOutput = TessellationResult | TessellationFallbackResult
  * shape representation, so it is not referenced here.
  */
 export declare function writeTessellation(w: IfcWriter, solid: ValidSolid, geomSubContextId: number, _localPlacementId: number | null, toleranceMm?: number): TessellationOutput;
+export declare function writePreparedTessellationBody(w: IfcWriter, items: NonEmpty<PreparedTessellation>, geomSubContextId: number): {
+    readonly productDefinitionShapeId: number;
+    readonly bodyItemIds: readonly number[];
+};
+export declare function writeExactBodyGeometry(w: IfcWriter, placement: FrameInput, items: NonEmpty<PreparedTessellation>, geomSubContextId: number, parentPlacementId: number | null): ExactBodyRepresentationIds;
+export declare function writePreparedTessellationItem(w: IfcWriter, prepared: PreparedTessellation): number;
 /**
  * Builds a wall 'Axis' IfcShapeRepresentation: an IfcPolyline from (0,0) to
  * (lengthM, 0) in the wall's local XY plane, wrapped in an IfcShapeRepresentation

package/dist/index.d.ts

@@ -1,6 +1,8 @@
 export { BimModel, type ElementIdentityOptions, type OpeningIdentityOptions, } from './model/bimModel.js';
 export type { BimTreeNode, BimTreeSummary } from './model/treeSummary.js';
 export { placedSolids } from './elementFns/placedGeometry.js';
+export { bodySolids } from './types/productBody.js';
+export type { NonEmpty, ProductBody } from './types/productBody.js';
 export type { PlacedSolidsOptions } from './elementFns/placedGeometry.js';
 export type { FrameInput } from './import/placement.js';
 export { toIfc, toIfcValidated } from './serialize/toIfc.js';

package/dist/model/bimModel.d.ts

@@ -24,6 +24,7 @@ import { ZoneSpec, SystemSpec } from '../specs/groupSpec.js';
 import { SurfaceStyleSpec } from '../ifc-writer/styleWriter.js';
 import { ProjectSpec, SiteSpec, BuildingSpec, StoreySpec } from '../specs/spatialSpec.js';
 import { BridgePartSpec, BridgeSpec, EarthworksFillSpec } from '../specs/infrastructureSpec.js';
+import { ProductBody } from '../types/productBody.js';
 /** Optional identity override for created elements: a stable key (e.g. a
  *  families key path) that replaces the positional GlobalId derivation. */
 export interface ElementIdentityOptions {
@@ -67,6 +68,14 @@ export declare class BimModel {
      */
     addRamp(spec: RampSpec, options?: ElementIdentityOptions): Result<LocalId, BimError>;
     addRailing(spec: RailingSpec, options?: ElementIdentityOptions): Result<LocalId, BimError>;
+    /**
+     * Atomically replaces a parametric wall or railing Body with authoritative,
+     * caller-owned exact solids. Success transfers every supplied handle to this
+     * model. Failure leaves both the model and all supplied handles unchanged.
+     */
+    takeExactProductBody(localId: LocalId, body: Extract<ProductBody, {
+        readonly kind: 'EXACT';
+    }>): Result<void, BimError>;
     /**
      * Adds an IfcCovering. When `hostLocalId` is supplied, an
      * IfcRelCoversBldgElements linking the covering to its host (e.g. a slab it

package/dist/rigidPlacement.d.ts

@@ -0,0 +1,4 @@
+import { AnyShape, Dimension } from 'brepjs';
+import { FrameInput } from './import/placement.js';
+/** Applies a rigid placement as a location so the source BRep is not rebuilt. */
+export declare function locateShapeInFrame<T extends AnyShape<Dimension>>(shape: T, frame: FrameInput): T;

package/dist/serialize/exactBodyPreflight.d.ts

@@ -0,0 +1,15 @@
+import { Result, ValidSolid } from 'brepjs';
+import { BimError } from '../errors/bimError.js';
+import { LocalId } from '../identity/localId.js';
+import { NonEmpty } from '../types/productBody.js';
+import { PreparedTessellation, TessellationPreparation } from '../ifc-writer/tessellationWriter.js';
+export type ExactBodyItemPreparer = (solid: ValidSolid) => TessellationPreparation;
+/** Package-internal deterministic failure seam for serialization cleanup tests. */
+export declare function setExactBodyItemPreparerForTesting(prepareItem: ExactBodyItemPreparer | null): void;
+export interface ExactBodyPreflightInput {
+    readonly localId: LocalId;
+    readonly solids: NonEmpty<ValidSolid>;
+    readonly prepareItem?: ExactBodyItemPreparer | undefined;
+}
+/** Prepares every exact Body item without writing IFC lines. Source solids remain borrowed. */
+export declare function preflightExactBody(input: ExactBodyPreflightInput): Result<NonEmpty<PreparedTessellation>, BimError>;

package/dist/serialize/exactWallQuantities.d.ts

@@ -0,0 +1,20 @@
+import { fuseAll, measureVolume, Result, ValidSolid } from 'brepjs';
+import { BimError } from '../errors/bimError.js';
+import { WallSpec } from '../specs/wallSpec.js';
+import { NonEmpty } from '../types/productBody.js';
+export interface ExactWallQuantityValues {
+    readonly lengthM: number;
+    readonly widthM: number;
+    readonly heightM: number;
+    readonly netVolumeM3: number;
+}
+export interface ExactWallQuantityDependencies {
+    readonly fuse?: typeof fuseAll | undefined;
+    readonly measure?: typeof measureVolume | undefined;
+}
+export interface ExactWallQuantityInput {
+    readonly spec: WallSpec;
+    readonly solids: NonEmpty<ValidSolid>;
+    readonly dependencies?: ExactWallQuantityDependencies | undefined;
+}
+export declare function deriveExactWallQuantities(input: ExactWallQuantityInput): Result<ExactWallQuantityValues, BimError>;

package/dist/types/bimTypes.d.ts

@@ -20,6 +20,7 @@ import { ElementAssemblySpec } from '../specs/assemblySpec.js';
 import { ZoneSpec, SystemSpec } from '../specs/groupSpec.js';
 import { ProjectSpec, SiteSpec, BuildingSpec, StoreySpec } from '../specs/spatialSpec.js';
 import { BridgePartSpec, BridgeSpec, EarthworksFillSpec } from '../specs/infrastructureSpec.js';
+import { ProductBody } from './productBody.js';
 export type BimCategory = 'WALL' | 'SLAB' | 'BEAM' | 'COLUMN' | 'OPENING' | 'DOOR' | 'WINDOW' | 'PROXY' | 'SPACE' | 'ROOF' | 'CURTAIN_WALL' | 'FOOTING' | 'PILE' | 'STAIR' | 'RAMP' | 'RAILING' | 'COVERING' | 'ELEMENT_ASSEMBLY' | 'ZONE' | 'SYSTEM' | 'PROJECT' | 'SITE' | 'BRIDGE' | 'BRIDGE_PART' | 'EARTHWORKS_FILL' | 'BUILDING' | 'STOREY';
 export type WallOpeningSpec = {
     readonly kind: 'WALL_OPENING';
@@ -39,7 +40,7 @@ export type OpeningSpec = WallOpeningSpec | SlabOpeningSpec;
 export declare function isWallOpening(spec: OpeningSpec): spec is WallOpeningSpec;
 export declare function isSlabOpening(spec: OpeningSpec): spec is SlabOpeningSpec;
 export type BimSpecFor<C extends BimCategory> = C extends 'WALL' ? WallSpec : C extends 'SLAB' ? SlabSpec : C extends 'BEAM' ? BeamSpec : C extends 'COLUMN' ? ColumnSpec : C extends 'OPENING' ? OpeningSpec : C extends 'DOOR' ? DoorSpec : C extends 'WINDOW' ? WindowSpec : C extends 'PROXY' ? ProxySpec : C extends 'SPACE' ? SpaceSpec : C extends 'ROOF' ? RoofSpec : C extends 'CURTAIN_WALL' ? CurtainWallSpec : C extends 'FOOTING' ? FootingSpec : C extends 'PILE' ? PileSpec : C extends 'STAIR' ? StairSpec : C extends 'RAMP' ? RampSpec : C extends 'RAILING' ? RailingSpec : C extends 'COVERING' ? CoveringSpec : C extends 'ELEMENT_ASSEMBLY' ? ElementAssemblySpec : C extends 'ZONE' ? ZoneSpec : C extends 'SYSTEM' ? SystemSpec : C extends 'PROJECT' ? ProjectSpec : C extends 'SITE' ? SiteSpec : C extends 'BRIDGE' ? BridgeSpec : C extends 'BRIDGE_PART' ? BridgePartSpec : C extends 'EARTHWORKS_FILL' ? EarthworksFillSpec : C extends 'BUILDING' ? BuildingSpec : C extends 'STOREY' ? StoreySpec : never;
-export type BimGeometryFor<C extends BimCategory> = C extends 'CURTAIN_WALL' ? CurtainWallGrid : C extends 'WALL' | 'SLAB' | 'BEAM' | 'COLUMN' | 'PROXY' | 'EARTHWORKS_FILL' | 'SPACE' | 'ROOF' | 'FOOTING' | 'PILE' | 'RAILING' | 'COVERING' ? ValidSolid : null;
+export type BimGeometryFor<C extends BimCategory> = C extends 'CURTAIN_WALL' ? CurtainWallGrid : C extends 'WALL' | 'RAILING' ? ProductBody : C extends 'SLAB' | 'BEAM' | 'COLUMN' | 'PROXY' | 'EARTHWORKS_FILL' | 'SPACE' | 'ROOF' | 'FOOTING' | 'PILE' | 'COVERING' ? ValidSolid : null;
 export interface BimElement<C extends BimCategory> {
     readonly guid: IfcGuid;
     readonly localId: LocalId;

package/dist/types/productBody.d.ts

@@ -0,0 +1,13 @@
+import { ValidSolid } from 'brepjs';
+export type NonEmpty<T> = readonly [T, ...T[]];
+export type ProductBody = {
+    readonly kind: 'PARAMETRIC';
+    readonly solid: ValidSolid;
+} | {
+    readonly kind: 'EXACT';
+    readonly solids: NonEmpty<ValidSolid>;
+};
+/** Returns borrowed Product-local solids. The model retains ownership. */
+export declare function bodySolids(body: ProductBody): NonEmpty<ValidSolid>;
+/** Model-owner cleanup. Borrowers must use {@link bodySolids} without disposing its items. */
+export declare function disposeProductBody(body: ProductBody): void;

package/package.json

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