brepjs-bim 0.1.0 → 0.3.0

package/dist/elementFns/placedGeometry.d.ts

@@ -0,0 +1,18 @@
+import { ValidSolid, Result } from 'brepjs';
+import { AnyBimElement } from '../types/bimTypes.js';
+import { BimError } from '../errors/bimError.js';
+/**
+ * Returns each element's geometry transformed to its world placement, as fresh
+ * caller-owned solids, wrapped in a `Result` (Layer-2 code prefers `Result` over
+ * throwing). **Dispose the returned solids** (e.g. via `using` / `[Symbol.dispose]`)
+ * when you own their lifetime — they are independent of the model
+ * (`BimModel[Symbol.dispose]` frees only the stored, unplaced `.geometry`). On any
+ * failure the solids already built for this call are disposed before the error is
+ * returned, so no partial array is leaked.
+ *
+ * Stairs carry no element solid (`.geometry` is null), so flight solids are built
+ * from `spec.flights` and placed per flight. Curtain walls return placed panels +
+ * mullions. Elements with no solid geometry (doors/windows/ramps/groups/spatial)
+ * return an empty array.
+ */
+export declare function placedSolids(el: AnyBimElement): Result<readonly ValidSolid[], BimError>;

package/dist/identity/ifcGuid.d.ts

@@ -4,4 +4,5 @@ export type IfcGuid = string & {
 };
 export declare function newIfcGuid(): IfcGuid;
 export declare function isValidIfcGuid(s: string): s is IfcGuid;
+export declare function encodeIfcGuid(bytes: Uint8Array): IfcGuid;
 export {};

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

@@ -1,3 +1,4 @@
+import { ValidSolid } from 'brepjs';
 import { IfcWriter } from './ifcWriter.js';
 import { WallSpec } from '../specs/wallSpec.js';
 import { SlabSpec } from '../specs/slabSpec.js';
@@ -19,7 +20,9 @@ export interface LinearElementRepresentationIds {
 }
 export declare function writeWallGeometry(w: IfcWriter, spec: WallSpec, geomSubContextId: number, parentPlacementId: number | null): WallRepresentationIds;
 export declare function writeSlabGeometry(w: IfcWriter, spec: SlabSpec, geomSubContextId: number, parentPlacementId: number | null): SlabRepresentationIds;
-export declare function writeRoofGeometry(w: IfcWriter, spec: RoofSpec, geomSubContextId: number, parentPlacementId: number | null): SlabRepresentationIds;
+export declare function writeRoofGeometry(w: IfcWriter, spec: RoofSpec, solid: ValidSolid, geomSubContextId: number, parentPlacementId: number | null): SlabRepresentationIds & {
+    usedFallback: boolean;
+};
 export declare function writeProfile(w: IfcWriter, profile: Profile): number;
 export declare function writeBeamGeometry(w: IfcWriter, spec: BeamSpec, geomSubContextId: number, parentPlacementId: number | null): LinearElementRepresentationIds;
 export declare function writeColumnGeometry(w: IfcWriter, spec: ColumnSpec, geomSubContextId: number, parentPlacementId: number | null): LinearElementRepresentationIds;

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

@@ -5,10 +5,14 @@ import { IfcSchema } from './schemaVersion.js';
 import { Result } from 'brepjs';
 /** Default MVD ViewDefinition declared in the STEP FILE_DESCRIPTION header. */
 export declare const DEFAULT_MVD_VIEW_DEFINITION = "ReferenceView_v1.2";
+export interface IfcHeaderMeta {
+    readonly author?: string | undefined;
+    readonly organization?: string | undefined;
+}
 export declare class IfcWriter {
     #private;
     private constructor();
-    static create(mvdViewDefinition?: string, ifcSchema?: IfcSchema): Promise<Result<IfcWriter, BimError>>;
+    static create(mvdViewDefinition?: string, ifcSchema?: IfcSchema, header?: IfcHeaderMeta): Promise<Result<IfcWriter, BimError>>;
     nextId(): number;
     /**
      * Deterministic GlobalId for a writer-minted line, keyed on its express ID.

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

@@ -1,11 +1,17 @@
+import { ValidSolid } from 'brepjs';
 import { IfcWriter } from './ifcWriter.js';
 import { IfcGuid } from '../identity/ifcGuid.js';
 import { RailingSpec, RailingPredefinedType } from '../specs/railingSpec.js';
 export interface RailingRepresentationIds {
     localPlacementId: number;
     productDefinitionShapeId: number;
-    /** Express ID of the body representation item (the extrusion), for styling. */
-    bodyItemId: number;
+    /**
+     * Express ID of the body representation item (the swept extrusion) for surface
+     * styling, or null for a tessellated POSTED railing (no single styleable item).
+     */
+    bodyItemId: number | null;
+    /** True when tessellation fell back to a degenerate brep. */
+    usedFallback: boolean;
 }
-export declare function writeRailingGeometry(w: IfcWriter, spec: RailingSpec, geomSubContextId: number, parentPlacementId: number | null): RailingRepresentationIds;
+export declare function writeRailingGeometry(w: IfcWriter, spec: RailingSpec, solid: ValidSolid, geomSubContextId: number, parentPlacementId: number | null): RailingRepresentationIds;
 export declare function writeRailingEntity(w: IfcWriter, guid: IfcGuid, name: string, predefinedType: RailingPredefinedType, ownerHistoryId: number, localPlacementId: number, productDefinitionShapeId: number): number;

package/dist/ifcRuntime.d.ts

@@ -0,0 +1,20 @@
+import { IfcAPI } from 'web-ifc';
+/**
+ * Override how web-ifc finds its `.wasm` file. Applied by every web-ifc entry
+ * point in this package — IFC export ({@link toIfc}), import ({@link fromIfc})
+ * and validation. Required when brepjs-bim is bundled into a worker that serves
+ * the wasm itself; not needed in Node.
+ */
+export declare function setIfcWasmLocateFile(locate: ((path: string, prefix: string) => string) | undefined): void;
+/**
+ * Initialize a web-ifc API instance the way this package always wants it: with
+ * the host-provided wasm locator and forced single-threaded.
+ *
+ * Single-threaded matters in a cross-origin-isolated context (e.g. a page that
+ * sets COOP/COEP for another WASM kernel): web-ifc would otherwise load its
+ * pthread build and spawn a sub-Worker, which fails when brepjs-bim is itself
+ * bundled inside a Web Worker. In Node the flag is a no-op (web-ifc is already
+ * single-threaded there), and multithreading only speeds up parsing/geometry,
+ * not the one-shot serialize/read this package does.
+ */
+export declare function initIfcApi(api: IfcAPI): Promise<void>;

package/dist/import/placement.d.ts

@@ -1,3 +1,4 @@
+import { MatrixTransform } from 'brepjs';
 import { SpfReader } from './spfReader.js';
 /**
  * Column-major 4x4 transform, matching the layout web-ifc and OCCT use:
@@ -77,6 +78,23 @@ export declare function composeWorldPlacement(reader: SpfReader, placementExpres
  * always a proper rotation.
  */
 export declare function readAxis2Placement3D(reader: SpfReader, placementExpressId: number, scale: number): Mat4x4 | null;
+/** An (origin, axisX, axisZ) frame in mm — the authoring/display side of a placement. */
+export interface FrameInput {
+    readonly origin: Vec3;
+    readonly axisX: Vec3;
+    readonly axisZ: Vec3;
+}
+/**
+ * Builds a row-major MatrixTransform (for brepjs `applyMatrix`) from an
+ * (origin, axisX, axisZ) frame, using the SAME IFC orthonormalization as
+ * {@link readAxis2Placement3D}: z = normalize(axisZ); x = normalize(axisX
+ * projected onto the plane ⊥ z); y = z × x. The basis vectors are the matrix
+ * columns, so the row-major linear array is [Xx,Yx,Zx, Xy,Yy,Zy, Xz,Yz,Zz];
+ * translation = origin (mm). This is the display-side counterpart to the IFC
+ * writer's Axis2Placement3D (Axis=Z, RefDirection=X) so on-screen placement and
+ * the IFC export agree.
+ */
+export declare function placementToMatrix(f: FrameInput): MatrixTransform;
 /** Decomposes a column-major matrix into origin (mm) + IFC axes (Z, X). */
 export declare function decomposePlacement(m: Mat4x4): WorldPlacement;
 export declare function identityMatrix(): Mat4x4;

package/dist/index.d.ts

@@ -1,6 +1,9 @@
 export { BimModel } from './model/bimModel.js';
+export type { BimTreeNode, BimTreeSummary } from './model/treeSummary.js';
+export { placedSolids } from './elementFns/placedGeometry.js';
 export { toIfc, toIfcValidated } from './serialize/toIfc.js';
 export type { ValidatedIfcResult } from './serialize/toIfc.js';
+export { setIfcWasmLocateFile } from './ifcRuntime.js';
 export { fromIfc } from './import/fromIfc.js';
 export { disposeImportedModel } from './import/importedModel.js';
 export type { FromIfcOptions } from './import/fromIfc.js';

package/dist/model/bimModel.d.ts

@@ -2,6 +2,7 @@ import { Result } from 'brepjs';
 import { LocalId } from '../identity/localId.js';
 import { BimError } from '../errors/bimError.js';
 import { AnyBimElement, BimElement } from '../types/bimTypes.js';
+import { BimTreeSummary } from './treeSummary.js';
 import { BimRelationship } from '../types/relationships.js';
 import { ClassificationRef } from '../types/classificationTypes.js';
 import { WallSpec } from '../specs/wallSpec.js';
@@ -129,6 +130,13 @@ export declare class BimModel {
     placeIn(elementId: LocalId, containerId: LocalId): void;
     getProject(): BimElement<'PROJECT'> | null;
     getElement(id: LocalId): AnyBimElement | null;
+    /**
+     * A serializable summary of the model's structure, rooted at the project and
+     * walking the IFC spatial hierarchy (AGGREGATES: project → site → building →
+     * storey) plus the elements contained in each storey (placeIn). Useful for a
+     * read-only tree view of the model across a worker boundary.
+     */
+    toTreeSummary(): BimTreeSummary;
     getWalls(): BimElement<'WALL'>[];
     getSlabs(): BimElement<'SLAB'>[];
     getBeams(): BimElement<'BEAM'>[];

package/dist/model/treeSummary.d.ts

@@ -0,0 +1,21 @@
+import { BimCategory } from '../types/bimTypes.js';
+/**
+ * A node in a {@link BimModel}'s spatial/decomposition tree. Fully serializable
+ * (plain numbers/strings) so it can be posted across a worker boundary.
+ */
+export interface BimTreeNode {
+    /** The element's local id. */
+    readonly id: number;
+    /** Display label — the element's name, or its category when unnamed. */
+    readonly label: string;
+    /** The element's IFC category. */
+    readonly category: BimCategory;
+    readonly children: readonly BimTreeNode[];
+}
+/** A serializable summary of a model's structure, rooted at the project. */
+export interface BimTreeSummary {
+    /** The project node and its nested spatial structure + contained elements. */
+    readonly root: BimTreeNode | null;
+    /** Number of nodes in the tree (the project and everything reachable from it). */
+    readonly elementCount: number;
+}

package/dist/specs/profile.d.ts

@@ -17,6 +17,7 @@ export type IShapeProfile = {
     readonly overallDepth: number;
     readonly flangeThickness: number;
     readonly webThickness: number;
+    readonly filletRadius?: number | undefined;
 };
 export type CoreProfile = RectangularProfile | CircularProfile | IShapeProfile;
 export type Profile = CoreProfile | ExtendedProfile;
@@ -35,6 +36,7 @@ export declare const ProfileSchema: z.ZodUnion<readonly [z.ZodDiscriminatedUnion
     overallDepth: z.ZodNumber;
     flangeThickness: z.ZodNumber;
     webThickness: z.ZodNumber;
+    filletRadius: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>], "kind">, z.ZodDiscriminatedUnion<[z.ZodObject<{
     kind: z.ZodLiteral<"L_SHAPE">;
     depth: z.ZodNumber;

package/dist/specs/railingSpec.d.ts

@@ -18,6 +18,12 @@ export interface RailingSpec {
     readonly axisZ: [number, number, number];
     readonly predefinedType?: RailingPredefinedType | undefined;
     readonly materialName: string;
+    /**
+     * Geometric infill style. 'PANEL' (default) is a single swept panel; 'POSTED'
+     * is vertical posts plus top & bottom rails. Orthogonal to `predefinedType`
+     * (which is the IFC usage role, not a geometry descriptor).
+     */
+    readonly infill?: 'PANEL' | 'POSTED' | undefined;
     readonly isExternal?: boolean | undefined;
     readonly fireRating?: string | undefined;
     readonly status?: string | undefined;

package/dist/specs/roofSpec.d.ts

@@ -16,6 +16,13 @@ export interface RoofSpec {
     readonly fireRating?: string | undefined;
     readonly thermalTransmittance?: number | undefined;
     readonly status?: string | undefined;
+    /**
+     * Optional roof slope in degrees (0 < pitch < 90). Its PRESENCE opts the roof
+     * into shaped geometry built for `predefinedType` (shed/gable/hip/dome); when
+     * absent the roof is a flat slab regardless of predefinedType (backward-
+     * compatible). Ignored geometrically for DOME_ROOF (a hemisphere).
+     */
+    readonly pitch?: number | undefined;
     /**
      * When present, the roof is associated via a layered IfcMaterialLayerSet built
      * from these layers instead of the bare `materialName` IfcMaterial.

package/package.json

@@ -1,23 +1,44 @@
 {
   "name": "brepjs-bim",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "BIM layer for brepjs — IFC4-aligned parametric building elements",
-  "keywords": ["bim", "ifc", "cad", "brep"],
+  "keywords": [
+    "bim",
+    "ifc",
+    "cad",
+    "brep"
+  ],
   "author": "Andy Aragon",
   "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/andymai/brepjs",
+    "directory": "packages/brepjs-bim"
+  },
   "type": "module",
   "sideEffects": false,
-  "engines": { "node": ">=24" },
+  "engines": {
+    "node": ">=24"
+  },
   "main": "./dist/brepjs-bim.cjs",
   "module": "./dist/brepjs-bim.js",
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
-      "import": { "types": "./dist/index.d.ts", "default": "./dist/brepjs-bim.js" },
-      "require": { "types": "./dist/index.d.ts", "default": "./dist/brepjs-bim.cjs" }
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/brepjs-bim.js"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/brepjs-bim.cjs"
+      }
     }
   },
-  "files": ["dist", "LICENSE"],
+  "files": [
+    "dist",
+    "LICENSE"
+  ],
   "scripts": {
     "build": "vite build",
     "typecheck": "tsc --noEmit",