brepjs-bim 0.3.1 → 0.5.0

package/dist/familiesAdapter.d.ts

@@ -0,0 +1,22 @@
+import { Result } from 'brepjs';
+import { ResolvedElement } from 'brepjs-families';
+import { BimModel } from './model/bimModel.js';
+import { LocalId } from './identity/localId.js';
+import { ProjectSpec } from './specs/spatialSpec.js';
+import { BimError } from './errors/bimError.js';
+export interface FamiliesToBimOptions {
+    readonly project: ProjectSpec;
+    readonly siteName?: string | undefined;
+    readonly buildingName?: string | undefined;
+}
+export interface FamiliesBimResult {
+    readonly model: BimModel;
+    /** LocalId per geometry-bearing families key path. */
+    readonly idByKeyPath: ReadonlyMap<string, LocalId>;
+}
+/**
+ * Project a resolved families tree into an eager BimModel. The caller owns
+ * the returned model (`using`); families stays domain-neutral — this adapter
+ * is where families types meet the IFC vocabulary.
+ */
+export declare function familiesToBim(root: ResolvedElement, options: FamiliesToBimOptions): Result<FamiliesBimResult, BimError>;

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export { BimModel } from './model/bimModel.js';
+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 { toIfc, toIfcValidated } from './serialize/toIfc.js';
@@ -96,3 +96,4 @@ export type { IdsDocument, IdsSpecification, IdsFacet, IdsRestriction, IdsCardin
 export { serializeBcfFiles, parseBcfFiles } from './bcf/index.js';
 export type { BcfColoring, BcfComment, BcfComponent, BcfComponents, BcfContainerData, BcfFiles, BcfProject, BcfTopic, BcfVersion, BcfViewpoint, BcfVisibility, } from './bcf/index.js';
 export { bcfError, idsError } from './errors/bimError.js';
+export { familiesToBim, type FamiliesToBimOptions, type FamiliesBimResult, } from './familiesAdapter.js';

package/dist/model/bimModel.d.ts

@@ -23,15 +23,25 @@ import { ElementAssemblySpec } from '../specs/assemblySpec.js';
 import { ZoneSpec, SystemSpec } from '../specs/groupSpec.js';
 import { SurfaceStyleSpec } from '../ifc-writer/styleWriter.js';
 import { ProjectSpec, SiteSpec, BuildingSpec, StoreySpec } from '../specs/spatialSpec.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 {
+    readonly stableKey?: string | undefined;
+}
+/** Identity options for adders that create TWO elements: `stableKey` names
+ *  the filler (door/window), `openingStableKey` the synthesized opening. */
+export interface OpeningIdentityOptions extends ElementIdentityOptions {
+    readonly openingStableKey?: string | undefined;
+}
 export declare class BimModel {
     #private;
     init(spec: ProjectSpec): Result<LocalId, BimError>;
     [Symbol.dispose](): void;
     addSite(spec: SiteSpec): LocalId;
-    addBuilding(spec: BuildingSpec): LocalId;
-    addStorey(spec: StoreySpec): LocalId;
-    addWall(spec: WallSpec): Result<LocalId, BimError>;
-    addSlab(spec: SlabSpec): Result<LocalId, BimError>;
+    addBuilding(spec: BuildingSpec, options?: ElementIdentityOptions): LocalId;
+    addStorey(spec: StoreySpec, options?: ElementIdentityOptions): LocalId;
+    addWall(spec: WallSpec, options?: ElementIdentityOptions): Result<LocalId, BimError>;
+    addSlab(spec: SlabSpec, options?: ElementIdentityOptions): Result<LocalId, BimError>;
     addBeam(spec: BeamSpec): Result<LocalId, BimError>;
     addColumn(spec: ColumnSpec): Result<LocalId, BimError>;
     addSpace(spec: SpaceSpec): Result<LocalId, BimError>;
@@ -121,9 +131,9 @@ export declare class BimModel {
      * {@link ProxySpec.solid}).
      */
     addProxy(spec: ProxySpec): Result<LocalId, BimError>;
-    addDoor(spec: DoorSpec): Result<LocalId, BimError>;
-    addWindow(spec: WindowSpec): Result<LocalId, BimError>;
-    addSlabOpening(input: SlabOpeningInput): 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>;
     getDoors(): BimElement<'DOOR'>[];
     getWindows(): BimElement<'WINDOW'>[];
     aggregate(parentId: LocalId, childId: LocalId): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "brepjs-bim",
-  "version": "0.3.1",
+  "version": "0.5.0",
   "description": "BIM layer for brepjs — IFC4-aligned parametric building elements",
   "keywords": [
     "bim",
@@ -41,7 +41,7 @@
   ],
   "scripts": {
     "build": "vite build",
-    "typecheck": "tsc --noEmit",
+    "typecheck": "tsgo --noEmit",
     "test": "vitest run",
     "lint": "eslint src tests"
   },
@@ -59,5 +59,8 @@
     "vitest": "^4.0.0",
     "web-ifc": "^0.0.77",
     "zod": "^4.4.3"
+  },
+  "dependencies": {
+    "brepjs-families": "^0.1.0"
   }
 }