brepjs-bim 0.1.0

package/dist/specs/profilesExtended.d.ts

@@ -0,0 +1,86 @@
+import { OrientedFace, PlanarFace, Result } from 'brepjs';
+import { BimError } from '../errors/bimError.js';
+export type Pt2 = readonly [number, number];
+export interface LShapeProfile {
+    readonly kind: 'L_SHAPE';
+    readonly depth: number;
+    readonly width: number;
+    readonly legThickness: number;
+    readonly filletRadius?: number | undefined;
+}
+export interface TShapeProfile {
+    readonly kind: 'T_SHAPE';
+    readonly depth: number;
+    readonly flangeWidth: number;
+    readonly webThickness: number;
+    readonly flangeThickness: number;
+    readonly filletRadius?: number | undefined;
+}
+export interface UShapeProfile {
+    readonly kind: 'U_SHAPE';
+    readonly depth: number;
+    readonly flangeWidth: number;
+    readonly webThickness: number;
+    readonly flangeThickness: number;
+}
+export interface ZShapeProfile {
+    readonly kind: 'Z_SHAPE';
+    readonly depth: number;
+    readonly flangeWidth: number;
+    readonly webThickness: number;
+    readonly flangeThickness: number;
+}
+export interface CShapeProfile {
+    readonly kind: 'C_SHAPE';
+    readonly depth: number;
+    readonly width: number;
+    readonly wallThickness: number;
+    readonly girth: number;
+    readonly internalFilletRadius?: number | undefined;
+}
+export interface AsymmetricIShapeProfile {
+    readonly kind: 'ASYMMETRIC_I';
+    readonly overallDepth: number;
+    readonly webThickness: number;
+    readonly topFlangeWidth: number;
+    readonly topFlangeThickness: number;
+    readonly bottomFlangeWidth: number;
+    readonly bottomFlangeThickness: number;
+}
+export interface EllipseProfile {
+    readonly kind: 'ELLIPSE';
+    readonly semiAxis1: number;
+    readonly semiAxis2: number;
+}
+export interface TrapeziumProfile {
+    readonly kind: 'TRAPEZIUM';
+    readonly bottomXDim: number;
+    readonly topXDim: number;
+    readonly yDim: number;
+    readonly topXOffset: number;
+}
+export interface RectangleHollowProfile {
+    readonly kind: 'RECTANGLE_HOLLOW';
+    readonly xDim: number;
+    readonly yDim: number;
+    readonly wallThickness: number;
+    readonly innerFilletRadius?: number | undefined;
+    readonly outerFilletRadius?: number | undefined;
+}
+export interface CircleHollowProfile {
+    readonly kind: 'CIRCLE_HOLLOW';
+    readonly radius: number;
+    readonly wallThickness: number;
+}
+export interface ArbitraryClosedProfile {
+    readonly kind: 'ARBITRARY_CLOSED';
+    readonly points: ReadonlyArray<Pt2>;
+}
+export interface ArbitraryProfileWithVoids {
+    readonly kind: 'ARBITRARY_WITH_VOIDS';
+    readonly outerPoints: ReadonlyArray<Pt2>;
+    readonly voids: ReadonlyArray<ReadonlyArray<Pt2>>;
+}
+export type ExtendedProfile = LShapeProfile | TShapeProfile | UShapeProfile | ZShapeProfile | CShapeProfile | AsymmetricIShapeProfile | EllipseProfile | TrapeziumProfile | RectangleHollowProfile | CircleHollowProfile | ArbitraryClosedProfile | ArbitraryProfileWithVoids;
+export declare function extendedProfileArea(profile: ExtendedProfile): number;
+export declare function extendedProfileToFace(profile: ExtendedProfile): Result<OrientedFace & PlanarFace, BimError>;

package/dist/specs/proxySpec.d.ts

@@ -0,0 +1,20 @@
+import { ValidSolid } from 'brepjs';
+/**
+ * Specification for an IfcBuildingElementProxy — arbitrary geometry that does
+ * not map to a typed element (wall/slab/beam/column). The solid is exported via
+ * the tessellation path (IfcTriangulatedFaceSet). All custom-property values are
+ * grouped by pset name. The solid is a brepjs ValidSolid handle, so this spec is
+ * not a plain serializable object and is validated structurally, not via Zod.
+ */
+export interface ProxySpec {
+    readonly name: string;
+    /**
+     * The proxy body. OWNERSHIP TRANSFERS to the BimModel on addProxy(): the model
+     * disposes this handle when it is disposed, so the caller MUST NOT dispose it
+     * itself (no `using`) — doing so double-frees the underlying WASM shape.
+     */
+    readonly solid: ValidSolid;
+    readonly materialName?: string | undefined;
+    readonly predefinedType?: 'COMPLEX' | 'ELEMENT' | 'NOTDEFINED' | 'PARTIAL' | undefined;
+    readonly customProperties?: Readonly<Record<string, Readonly<Record<string, string | number | boolean>>>> | undefined;
+}

package/dist/specs/railingSpec.d.ts

@@ -0,0 +1,32 @@
+import { BimError } from '../errors/bimError.js';
+import { Result } from 'brepjs';
+import { MaterialLayer } from '../types/materialTypes.js';
+import { ClassificationRef } from '../types/classificationTypes.js';
+export type RailingPredefinedType = 'BALUSTRADE' | 'GUARDRAIL' | 'HANDRAIL' | 'NOTDEFINED';
+/**
+ * A straight railing run: a rail of rectangular cross-section (thickness × height)
+ * swept along the run length. All dimensions in mm. The cross-section profile lies
+ * in the local YZ plane and is swept along local +X by `length`.
+ * origin/axisX/axisZ position the railing in world space via IfcLocalPlacement.
+ */
+export interface RailingSpec {
+    readonly length: number;
+    readonly height: number;
+    readonly thickness: number;
+    readonly origin: [number, number, number];
+    readonly axisX: [number, number, number];
+    readonly axisZ: [number, number, number];
+    readonly predefinedType?: RailingPredefinedType | undefined;
+    readonly materialName: string;
+    readonly isExternal?: boolean | undefined;
+    readonly fireRating?: string | undefined;
+    readonly status?: string | undefined;
+    readonly materialLayers?: readonly MaterialLayer[] | undefined;
+    readonly layerSetName?: string | undefined;
+    readonly classification?: ClassificationRef | undefined;
+    readonly manufacturerName?: string | undefined;
+    readonly manufacturerModel?: string | undefined;
+    readonly manufacturerProductionYear?: number | undefined;
+    readonly customProperties?: Readonly<Record<string, Readonly<Record<string, string | number | boolean>>>> | undefined;
+}
+export declare function parseRailingSpec(input: unknown): Result<RailingSpec, BimError>;

package/dist/specs/rampSpec.d.ts

@@ -0,0 +1,26 @@
+import { BimError } from '../errors/bimError.js';
+import { Result } from 'brepjs';
+import { ClassificationRef } from '../types/classificationTypes.js';
+export type RampPredefinedType = 'STRAIGHT_RUN_RAMP' | 'TWO_STRAIGHT_RUN_RAMP' | 'QUARTER_TURN_RAMP' | 'TWO_QUARTER_TURN_RAMP' | 'HALF_TURN_RAMP' | 'SPIRAL_RAMP' | 'NOTDEFINED';
+export type RampFlightPredefinedType = 'STRAIGHT' | 'SPIRAL' | 'NOTDEFINED';
+export interface RampFlightSpec {
+    readonly width: number;
+    readonly length: number;
+    readonly slope: number;
+    readonly thickness: number;
+    readonly origin: [number, number, number];
+    readonly axisX: [number, number, number];
+    readonly axisZ: [number, number, number];
+    readonly materialName: string;
+    readonly predefinedType?: RampFlightPredefinedType | undefined;
+}
+export interface RampSpec {
+    readonly name?: string | undefined;
+    readonly predefinedType?: RampPredefinedType | undefined;
+    readonly flights: readonly RampFlightSpec[];
+    readonly materialName: string;
+    readonly status?: string | undefined;
+    readonly classification?: ClassificationRef | undefined;
+}
+export declare function parseRampFlightSpec(input: unknown): Result<RampFlightSpec, BimError>;
+export declare function parseRampSpec(input: unknown): Result<RampSpec, BimError>;

package/dist/specs/roofSpec.d.ts

@@ -0,0 +1,32 @@
+import { BimError } from '../errors/bimError.js';
+import { Result } from 'brepjs';
+import { MaterialLayer } from '../types/materialTypes.js';
+import { ClassificationRef } from '../types/classificationTypes.js';
+export type RoofPredefinedType = 'FLAT_ROOF' | 'SHED_ROOF' | 'GABLE_ROOF' | 'HIP_ROOF' | 'HIPPED_GABLE_ROOF' | 'GAMBREL_ROOF' | 'MANSARD_ROOF' | 'BARREL_ROOF' | 'RAINBOW_ROOF' | 'BUTTERFLY_ROOF' | 'PAVILION_ROOF' | 'DOME_ROOF' | 'FREEFORM' | 'NOTDEFINED';
+export interface RoofSpec {
+    readonly length: number;
+    readonly width: number;
+    readonly thickness: number;
+    readonly origin: [number, number, number];
+    readonly axisX: [number, number, number];
+    readonly axisZ: [number, number, number];
+    readonly predefinedType: RoofPredefinedType;
+    readonly materialName: string;
+    readonly isExternal?: boolean | undefined;
+    readonly fireRating?: string | undefined;
+    readonly thermalTransmittance?: number | undefined;
+    readonly status?: string | undefined;
+    /**
+     * When present, the roof is associated via a layered IfcMaterialLayerSet built
+     * from these layers instead of the bare `materialName` IfcMaterial.
+     */
+    readonly materialLayers?: readonly MaterialLayer[] | undefined;
+    readonly layerSetName?: string | undefined;
+    /** When present, associates the roof with an external classification code. */
+    readonly classification?: ClassificationRef | undefined;
+    readonly manufacturerName?: string | undefined;
+    readonly manufacturerModel?: string | undefined;
+    readonly manufacturerProductionYear?: number | undefined;
+    readonly customProperties?: Readonly<Record<string, Readonly<Record<string, string | number | boolean>>>> | undefined;
+}
+export declare function parseRoofSpec(input: unknown): Result<RoofSpec, BimError>;

package/dist/specs/slabSpec.d.ts

@@ -0,0 +1,36 @@
+import { BimError } from '../errors/bimError.js';
+import { Result } from 'brepjs';
+import { MaterialLayer } from '../types/materialTypes.js';
+import { ClassificationRef } from '../types/classificationTypes.js';
+export type SlabPredefinedType = 'FLOOR' | 'ROOF' | 'LANDING' | 'BASESLAB';
+export interface SlabSpec {
+    readonly length: number;
+    readonly width: number;
+    readonly thickness: number;
+    readonly origin: [number, number, number];
+    readonly axisX: [number, number, number];
+    readonly axisZ: [number, number, number];
+    readonly predefinedType: SlabPredefinedType;
+    readonly materialName: string;
+    readonly isExternal?: boolean | undefined;
+    readonly fireRating?: string | undefined;
+    readonly acousticRating?: string | undefined;
+    readonly thermalTransmittance?: number | undefined;
+    readonly loadBearing?: boolean | undefined;
+    readonly combustible?: boolean | undefined;
+    readonly compartmentation?: boolean | undefined;
+    readonly status?: string | undefined;
+    /**
+     * When present, the slab is associated via a layered IfcMaterialLayerSet built
+     * from these layers instead of the bare `materialName` IfcMaterial.
+     */
+    readonly materialLayers?: readonly MaterialLayer[] | undefined;
+    readonly layerSetName?: string | undefined;
+    /** When present, associates the slab with an external classification code. */
+    readonly classification?: ClassificationRef | undefined;
+    readonly manufacturerName?: string | undefined;
+    readonly manufacturerModel?: string | undefined;
+    readonly manufacturerProductionYear?: number | undefined;
+    readonly customProperties?: Readonly<Record<string, Readonly<Record<string, string | number | boolean>>>> | undefined;
+}
+export declare function parseSlabSpec(input: unknown): Result<SlabSpec, BimError>;

package/dist/specs/spaceSpec.d.ts

@@ -0,0 +1,24 @@
+import { BimError } from '../errors/bimError.js';
+import { Result } from 'brepjs';
+import { ClassificationRef } from '../types/classificationTypes.js';
+export type SpacePredefinedType = 'SPACE' | 'PARKING' | 'GFA' | 'INTERNAL' | 'EXTERNAL' | 'NOTDEFINED';
+export interface SpaceSpec {
+    readonly name: string;
+    readonly length: number;
+    readonly width: number;
+    readonly height: number;
+    readonly origin: [number, number, number];
+    readonly axisX: [number, number, number];
+    readonly axisZ: [number, number, number];
+    readonly materialName: string;
+    readonly predefinedType?: SpacePredefinedType | undefined;
+    readonly longName?: string | undefined;
+    readonly isExternal?: boolean | undefined;
+    readonly status?: string | undefined;
+    readonly finishCeiling?: string | undefined;
+    readonly finishFloor?: string | undefined;
+    /** When present, associates the space with an external classification code. */
+    readonly classification?: ClassificationRef | undefined;
+    readonly customProperties?: Readonly<Record<string, Readonly<Record<string, string | number | boolean>>>> | undefined;
+}
+export declare function parseSpaceSpec(input: unknown): Result<SpaceSpec, BimError>;

package/dist/specs/spatialSpec.d.ts

@@ -0,0 +1,24 @@
+export interface ProjectSpec {
+    readonly name: string;
+    readonly description?: string;
+    /**
+     * Optional stable, globally-unique project identifier used to scope all derived
+     * GlobalIds. Supply a UUID (or any stable unique string) when the model will be
+     * federated/diffed/exported to COBie/BCF so its GlobalIds are unique across
+     * models. When omitted, the scope falls back to the project name+description
+     * (stable, but unique only per distinct name).
+     */
+    readonly projectId?: string;
+}
+export interface SiteSpec {
+    readonly name: string;
+    readonly description?: string;
+}
+export interface BuildingSpec {
+    readonly name: string;
+    readonly description?: string;
+}
+export interface StoreySpec {
+    readonly name: string;
+    readonly elevation: number;
+}

package/dist/specs/stairSpec.d.ts

@@ -0,0 +1,24 @@
+import { BimError } from '../errors/bimError.js';
+import { Result } from 'brepjs';
+import { ClassificationRef } from '../types/classificationTypes.js';
+export type StairPredefinedType = 'STRAIGHT_RUN_STAIR' | 'TWO_STRAIGHT_RUN_STAIR' | 'QUARTER_WINDING_STAIR' | 'QUARTER_TURN_STAIR' | 'HALF_WINDING_STAIR' | 'HALF_TURN_STAIR' | 'TWO_QUARTER_WINDING_STAIR' | 'TWO_QUARTER_TURN_STAIR' | 'THREE_QUARTER_WINDING_STAIR' | 'THREE_QUARTER_TURN_STAIR' | 'SPIRAL_STAIR' | 'DOUBLE_RETURN_STAIR' | 'CURVED_RUN_STAIR' | 'TWO_CURVED_RUN_STAIR' | 'NOTDEFINED';
+export interface StairFlightSpec {
+    readonly width: number;
+    readonly riserHeight: number;
+    readonly treadLength: number;
+    readonly numberOfRisers: number;
+    readonly origin: [number, number, number];
+    readonly axisX: [number, number, number];
+    readonly axisZ: [number, number, number];
+    readonly materialName: string;
+}
+export interface StairSpec {
+    readonly name?: string | undefined;
+    readonly predefinedType?: StairPredefinedType | undefined;
+    readonly flights: readonly StairFlightSpec[];
+    readonly materialName: string;
+    readonly status?: string | undefined;
+    readonly classification?: ClassificationRef | undefined;
+}
+export declare function parseStairFlightSpec(input: unknown): Result<StairFlightSpec, BimError>;
+export declare function parseStairSpec(input: unknown): Result<StairSpec, BimError>;

package/dist/specs/styleSpec.d.ts

@@ -0,0 +1,5 @@
+import { BimError } from '../errors/bimError.js';
+import { Result } from 'brepjs';
+import { SurfaceStyleSpec } from '../ifc-writer/styleWriter.js';
+export declare function parseSurfaceStyleSpec(input: unknown): Result<SurfaceStyleSpec, BimError>;
+export type { SurfaceStyleSpec } from '../ifc-writer/styleWriter.js';

package/dist/specs/wallSpec.d.ts

@@ -0,0 +1,33 @@
+import { BimError } from '../errors/bimError.js';
+import { Result } from 'brepjs';
+import { MaterialLayer } from '../types/materialTypes.js';
+import { ClassificationRef } from '../types/classificationTypes.js';
+/** A straight wall aligned along an arbitrary axis in 3D. All dimensions in mm. */
+export interface WallSpec {
+    readonly length: number;
+    readonly height: number;
+    readonly thickness: number;
+    readonly origin: [number, number, number];
+    readonly axisX: [number, number, number];
+    readonly axisZ: [number, number, number];
+    readonly materialName: string;
+    readonly isExternal?: boolean | undefined;
+    readonly fireRating?: string | undefined;
+    readonly acousticRating?: string | undefined;
+    readonly thermalTransmittance?: number | undefined;
+    readonly loadBearing?: boolean | undefined;
+    readonly status?: string | undefined;
+    /**
+     * When present, the wall is associated via a layered IfcMaterialLayerSet built
+     * from these layers instead of the bare `materialName` IfcMaterial.
+     */
+    readonly materialLayers?: readonly MaterialLayer[] | undefined;
+    readonly layerSetName?: string | undefined;
+    /** When present, associates the wall with an external classification code. */
+    readonly classification?: ClassificationRef | undefined;
+    readonly manufacturerName?: string | undefined;
+    readonly manufacturerModel?: string | undefined;
+    readonly manufacturerProductionYear?: number | undefined;
+    readonly customProperties?: Readonly<Record<string, Readonly<Record<string, string | number | boolean>>>> | undefined;
+}
+export declare function parseWallSpec(input: unknown): Result<WallSpec, BimError>;

package/dist/types/bimTypes.d.ts

@@ -0,0 +1,49 @@
+import { ValidSolid } from 'brepjs';
+import { IfcGuid } from '../identity/ifcGuid.js';
+import { LocalId } from '../identity/localId.js';
+import { WallSpec } from '../specs/wallSpec.js';
+import { SlabSpec } from '../specs/slabSpec.js';
+import { BeamSpec } from '../specs/beamSpec.js';
+import { ColumnSpec } from '../specs/columnSpec.js';
+import { DoorSpec, WindowSpec } from '../specs/openingSpec.js';
+import { ProxySpec } from '../specs/proxySpec.js';
+import { SpaceSpec } from '../specs/spaceSpec.js';
+import { RoofSpec } from '../specs/roofSpec.js';
+import { CurtainWallSpec } from '../specs/curtainWallSpec.js';
+import { CurtainWallGrid } from '../elementFns/curtainWallFns.js';
+import { FootingSpec, PileSpec } from '../specs/foundationSpec.js';
+import { StairSpec } from '../specs/stairSpec.js';
+import { RampSpec } from '../specs/rampSpec.js';
+import { RailingSpec } from '../specs/railingSpec.js';
+import { CoveringSpec } from '../specs/coveringSpec.js';
+import { ElementAssemblySpec } from '../specs/assemblySpec.js';
+import { ZoneSpec, SystemSpec } from '../specs/groupSpec.js';
+import { ProjectSpec, SiteSpec, BuildingSpec, StoreySpec } from '../specs/spatialSpec.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' | 'BUILDING' | 'STOREY';
+export type WallOpeningSpec = {
+    readonly kind: 'WALL_OPENING';
+    readonly width: number;
+    readonly height: number;
+    readonly offsetAlongWall: number;
+    readonly offsetFromFloor: number;
+};
+export type SlabOpeningSpec = {
+    readonly kind: 'SLAB_OPENING';
+    readonly sizeX: number;
+    readonly sizeY: number;
+    readonly offsetX: number;
+    readonly offsetY: number;
+};
+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 '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' | 'SPACE' | 'ROOF' | 'FOOTING' | 'PILE' | 'RAILING' | 'COVERING' ? ValidSolid : null;
+export interface BimElement<C extends BimCategory> {
+    readonly guid: IfcGuid;
+    readonly localId: LocalId;
+    readonly category: C;
+    readonly spec: BimSpecFor<C>;
+    readonly geometry: BimGeometryFor<C>;
+}
+export type AnyBimElement = BimElement<'WALL'> | BimElement<'SLAB'> | BimElement<'BEAM'> | BimElement<'COLUMN'> | BimElement<'OPENING'> | BimElement<'DOOR'> | BimElement<'WINDOW'> | BimElement<'PROXY'> | BimElement<'SPACE'> | BimElement<'ROOF'> | BimElement<'CURTAIN_WALL'> | BimElement<'FOOTING'> | BimElement<'PILE'> | BimElement<'STAIR'> | BimElement<'RAMP'> | BimElement<'RAILING'> | BimElement<'COVERING'> | BimElement<'ELEMENT_ASSEMBLY'> | BimElement<'ZONE'> | BimElement<'SYSTEM'> | BimElement<'PROJECT'> | BimElement<'SITE'> | BimElement<'BUILDING'> | BimElement<'STOREY'>;

package/dist/types/classificationTypes.d.ts

@@ -0,0 +1,16 @@
+/**
+ * A reference into an external classification system (e.g. Uniclass 2015 or
+ * OmniClass). Pure data, no imports, so it is safe to import from any layer.
+ */
+export interface ClassificationRef {
+    /** Classification system name, e.g. 'Uniclass2015'. */
+    readonly system: string;
+    /** Edition of the system, e.g. '2015'. */
+    readonly edition?: string | undefined;
+    /** URL locating the system or table. */
+    readonly location?: string | undefined;
+    /** The classification code, e.g. 'Ss_15_10_30_14'. */
+    readonly code: string;
+    /** Human-readable label for the referenced code. */
+    readonly description?: string | undefined;
+}

package/dist/types/materialTypes.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Shared material-association value types. Pure data, no imports, so they are
+ * safe to reference from both the type layer (relationships, specs) and the
+ * ifc-writer layer without risking a circular import.
+ */
+/** One physical layer in a layered material set (e.g. a wall build-up). */
+export interface MaterialLayer {
+    readonly name: string;
+    readonly thicknessMm: number;
+    readonly isVentilated?: boolean | undefined;
+    readonly priority?: number | undefined;
+    /** Bulk density (kg/m³) for analytic weight quantities; nominal lookup used when absent. */
+    readonly densityKgM3?: number | undefined;
+}

package/dist/types/relationships.d.ts

@@ -0,0 +1,116 @@
+import { IfcGuid } from '../identity/ifcGuid.js';
+import { LocalId } from '../identity/localId.js';
+import { MaterialLayer } from './materialTypes.js';
+import { ClassificationRef } from './classificationTypes.js';
+export interface AggregatesRel {
+    readonly kind: 'AGGREGATES';
+    readonly guid: IfcGuid;
+    readonly localId: LocalId;
+    readonly relatingObject: LocalId;
+    readonly relatedObjects: readonly LocalId[];
+}
+export interface ContainedInRel {
+    readonly kind: 'CONTAINED_IN';
+    readonly guid: IfcGuid;
+    readonly localId: LocalId;
+    readonly relatingStructure: LocalId;
+    readonly relatedElements: readonly LocalId[];
+}
+export interface AssociatesMaterialRel {
+    readonly kind: 'ASSOCIATES_MATERIAL';
+    readonly guid: IfcGuid;
+    readonly localId: LocalId;
+    readonly materialName: string;
+    readonly relatedObjects: readonly LocalId[];
+    /**
+     * When present, the element is associated via an IfcMaterialLayerSet built from
+     * these layers instead of the bare `materialName` IfcMaterial.
+     */
+    readonly materialLayers?: readonly MaterialLayer[] | undefined;
+    readonly layerSetName?: string | undefined;
+}
+export interface AssociatesClassificationRel {
+    readonly kind: 'ASSOCIATES_CLASSIFICATION';
+    readonly guid: IfcGuid;
+    readonly localId: LocalId;
+    readonly ref: ClassificationRef;
+    readonly relatedObjects: readonly LocalId[];
+}
+export interface VoidsWallRel {
+    readonly kind: 'VOIDS_WALL';
+    readonly guid: IfcGuid;
+    readonly localId: LocalId;
+    readonly wallLocalId: LocalId;
+    readonly openingLocalId: LocalId;
+}
+export interface VoidsSlabRel {
+    readonly kind: 'VOIDS_SLAB';
+    readonly guid: IfcGuid;
+    readonly localId: LocalId;
+    readonly slabLocalId: LocalId;
+    readonly openingLocalId: LocalId;
+}
+export interface FillsOpeningRel {
+    readonly kind: 'FILLS_OPENING';
+    readonly guid: IfcGuid;
+    readonly localId: LocalId;
+    readonly openingLocalId: LocalId;
+    readonly fillerLocalId: LocalId;
+}
+export interface SpaceBoundaryRel {
+    readonly kind: 'SPACE_BOUNDARY';
+    readonly guid: IfcGuid;
+    readonly localId: LocalId;
+    readonly spaceLocalId: LocalId;
+    readonly elementLocalId: LocalId;
+    readonly connectionType: 'PHYSICAL' | 'VIRTUAL' | 'NOTDEFINED';
+}
+/** Element-level decomposition of an IfcElementAssembly into its parts. */
+export interface NestsRel {
+    readonly kind: 'NESTS';
+    readonly guid: IfcGuid;
+    readonly localId: LocalId;
+    readonly relatingObject: LocalId;
+    readonly relatedObjects: readonly LocalId[];
+}
+/** Logical connection between two elements (IfcRelConnectsElements). */
+export interface ConnectsElementsRel {
+    readonly kind: 'CONNECTS_ELEMENTS';
+    readonly guid: IfcGuid;
+    readonly localId: LocalId;
+    readonly relatingElementLocalId: LocalId;
+    readonly relatedElementLocalId: LocalId;
+    readonly description?: string | undefined;
+}
+/** Connection between two path-based elements at specified ends (IfcRelConnectsPathElements). */
+export interface ConnectsPathElementsRel {
+    readonly kind: 'CONNECTS_PATH_ELEMENTS';
+    readonly guid: IfcGuid;
+    readonly localId: LocalId;
+    readonly relatingElementLocalId: LocalId;
+    readonly relatedElementLocalId: LocalId;
+    readonly relatingConnectionType: 'ATSTART' | 'ATEND' | 'ATPATH' | 'NOTDEFINED';
+    readonly relatedConnectionType: 'ATSTART' | 'ATEND' | 'ATPATH' | 'NOTDEFINED';
+    readonly description?: string | undefined;
+}
+/** Links a covering to the building element it covers (IfcRelCoversBldgElements). */
+export interface CoversElementRel {
+    readonly kind: 'COVERS_ELEMENT';
+    readonly guid: IfcGuid;
+    readonly localId: LocalId;
+    readonly hostLocalId: LocalId;
+    readonly coveringLocalId: LocalId;
+}
+/**
+ * Assigns members to a grouping object — a zone or system (IfcRelAssignsToGroup).
+ * `groupLocalId` is the IfcZone/IfcSystem; `memberLocalIds` are the assigned
+ * spaces or elements.
+ */
+export interface AssignsToGroupRel {
+    readonly kind: 'ASSIGNS_TO_GROUP';
+    readonly guid: IfcGuid;
+    readonly localId: LocalId;
+    readonly groupLocalId: LocalId;
+    readonly memberLocalIds: readonly LocalId[];
+}
+export type BimRelationship = AggregatesRel | ContainedInRel | AssociatesMaterialRel | AssociatesClassificationRel | VoidsWallRel | VoidsSlabRel | FillsOpeningRel | SpaceBoundaryRel | NestsRel | ConnectsElementsRel | ConnectsPathElementsRel | CoversElementRel | AssignsToGroupRel;

package/dist/units/units.d.ts

@@ -0,0 +1,7 @@
+export type LengthUnit = 'mm' | 'm' | 'in' | 'ft';
+export interface UnitSystem {
+    readonly length: LengthUnit;
+}
+export declare const DEFAULT_UNITS: UnitSystem;
+export declare function toLengthMm(value: number, unit: LengthUnit): number;
+export declare function toIfcLengthM(mm: number): number;

package/dist/validation/geometryValidity.d.ts

@@ -0,0 +1,20 @@
+import { ValidSolid } from 'brepjs';
+import { ValidationReport } from './severity.js';
+/**
+ * GEOMETRY-VALIDITY gate.
+ *
+ * Validates one or more brepjs ValidSolids for IFC export readiness:
+ *  - BRepCheck validity (isValid). Invalid topology that autoHeal cannot
+ *    repair is an error; geometry that only became valid after healing is a
+ *    warning (the exported solid differs from the authored one).
+ *  - Non-zero volume (measureVolume > MIN_VOLUME_MM3). Zero/negative volume
+ *    is an error — such a solid carries no usable geometry.
+ *
+ * The brand `ValidSolid` only asserts validity at construction time; transforms
+ * (scaling, boolean ops, sweeps) can still yield degenerate or invalid results,
+ * so the runtime checks here are not redundant with the type.
+ *
+ * `entity` is the human-readable identifier surfaced on each ValidationIssue.
+ * When validating a list it is appended with the element index.
+ */
+export declare function checkGeometryValidity(solids: ValidSolid | readonly ValidSolid[], entity?: string): ValidationReport;

package/dist/validation/referentialIntegrity.d.ts

@@ -0,0 +1,24 @@
+import { AnyBimElement } from '../types/bimTypes.js';
+import { BimRelationship } from '../types/relationships.js';
+import { ValidationReport } from './severity.js';
+export interface ModelGraph {
+    readonly elements: readonly AnyBimElement[];
+    readonly relationships: readonly BimRelationship[];
+}
+interface ModelAccessor {
+    getAllElements(): readonly AnyBimElement[];
+    getAllRelationships(): readonly BimRelationship[];
+}
+export type IntegrityInput = ModelGraph | ModelAccessor;
+/**
+ * Validates the in-memory model graph for referential integrity and spatial
+ * containment completeness, returning a ValidationReport. Flags:
+ *
+ *  - orphaned physical elements (not contained in any spatial structure),
+ *  - elements contained in more than one structure,
+ *  - voids/fills inconsistencies (a void referencing a missing host or opening,
+ *    a fill referencing a missing opening or filler),
+ *  - openings referenced by no void rel (warning).
+ */
+export declare function checkReferentialIntegrity(input: IntegrityInput): ValidationReport;
+export {};

package/dist/validation/roundTrip.d.ts

@@ -0,0 +1,36 @@
+import { ValidationIssue, ValidationReport } from './severity.js';
+/**
+ * Human-readable names of the key entities whose per-type counts are compared
+ * across a write→read→re-write round-trip. The keys double as `typeCounts` map
+ * keys so callers can assert on stable names rather than numeric web-ifc codes.
+ */
+export declare const KEY_ENTITY_NAMES: readonly ["IfcProject", "IfcWall", "IfcSlab", "IfcBeam", "IfcColumn", "IfcRelContainedInSpatialStructure", "IfcRelAggregates", "IfcPropertySet"];
+export type KeyEntityName = (typeof KEY_ENTITY_NAMES)[number];
+export interface EntityCounts {
+    /** Total number of entity lines in the model. */
+    readonly totalCount: number;
+    /** Count per key entity, keyed by IFC entity name. */
+    readonly typeCounts: Readonly<Record<string, number>>;
+}
+export interface RoundTripReport extends ValidationReport {
+    readonly firstPass: EntityCounts;
+    readonly secondPass: EntityCounts;
+}
+/**
+ * Open the given IFC bytes with web-ifc and count the total entity lines plus
+ * the per-type counts for the key entities. The model is always closed before
+ * returning, even if reading throws.
+ */
+export declare function firstPassCounts(bytes: Uint8Array): Promise<EntityCounts>;
+/**
+ * Compare two count snapshots and report any delta. A difference in the total
+ * entity-line count or in any key per-type count is an error: a stable model
+ * must round-trip without gaining or losing entities.
+ */
+export declare function compareCounts(first: EntityCounts, second: EntityCounts): ValidationIssue[];
+/**
+ * Write→read→re-write round-trip self-check. Opens the produced IFC bytes,
+ * re-saves them, re-opens the re-saved bytes, and reports any count delta in the
+ * total entity-line count or the key per-type counts (per the severity model).
+ */
+export declare function checkRoundTrip(bytes: Uint8Array): Promise<RoundTripReport>;