brepjs-bim 0.1.0

package/LICENSE

@@ -0,0 +1,191 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025-2026 Andy Aragon
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,100 @@
+# brepjs-bim
+
+> Experimental, unpublished satellite package.
+
+A BIM (Building Information Modeling) layer for [brepjs](https://github.com/andymai/brepjs). It
+authors IFC4-aligned parametric building elements (walls, slabs, beams, columns, roofs, curtain
+walls, stairs, …), assembles them into a spatial structure (project → site → building → storey),
+and serializes the result to a valid **IFC-SPF** file — with a matching importer to read IFC back in.
+
+Pipeline: **author spec → `BimModel` (typed element + brepjs geometry) → spatial structure +
+property sets + classification → export IFC / COBie, validate, round-trip.**
+
+## Scope
+
+Parametric authoring of the common IFC4 building elements plus the data layers that make a model
+useful downstream (psets, classification, materials, quantities), with import, export, and
+validation. Geometry is produced by brepjs (OCCT); each element carries a `ValidSolid` (or, for
+curtain walls, a panel/mullion grid). Element geometry is **unplaced template geometry** in local
+coordinates — placement (`origin` / `axisX` / `axisZ`) is applied by the IFC layer via
+`IfcLocalPlacement`, not baked into the brepjs solid.
+
+- Units default to mm; IFC export emits SI metres.
+- Stable identity: deterministic IFC GUIDs (`deriveIfcGuid`) and local id counters.
+
+## Status
+
+| Area              | State                                                                                                    |
+| ----------------- | -------------------------------------------------------------------------------------------------------- |
+| Elements          | wall, slab, beam, column, roof, curtain wall, space, footing/pile, stair, ramp, railing, covering, proxy |
+| Profiles          | rectangular / circular / I-shape cores + extended L/T/U/Z/C, hollow, ellipse, arbitrary-with-voids       |
+| Openings          | door / window / slab openings cut as boolean voids; `FillsOpening` / `Voids*` relationships              |
+| 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 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                                        |
+
+## Usage
+
+Author a small model and export IFC:
+
+```ts
+import { BimModel, toIfc } from 'brepjs-bim';
+
+const model = new BimModel();
+model.init({ name: 'Example' });
+
+// Spatial structure: project → site → building → storey.
+const project = model.getProject();
+const siteId = model.addSite({ name: 'Site' });
+const buildingId = model.addBuilding({ name: 'Building' });
+const storeyId = model.addStorey({ name: 'Level 1', elevation: 0 });
+if (project) model.aggregate(project.localId, siteId);
+model.aggregate(siteId, buildingId);
+model.aggregate(buildingId, storeyId);
+
+// A parametric wall, placed on the storey. Dimensions in mm; axisX is the wall's
+// length direction and axisZ its up direction.
+const wall = model.addWall({
+  length: 4000,
+  height: 3000,
+  thickness: 200,
+  origin: [0, 0, 0],
+  axisX: [1, 0, 0],
+  axisZ: [0, 0, 1],
+  materialName: 'Concrete',
+});
+if (wall.ok) model.placeIn(wall.value, storeyId);
+
+// Renderable geometry (a brepjs ValidSolid, unplaced/local coords):
+const solid = model.getWalls()[0]?.geometry;
+
+// Serialize to an IFC-SPF byte buffer.
+const ifc = await toIfc(model, { name: 'Example', author: 'brepjs-bim' });
+// ifc.ok && ifc.value instanceof Uint8Array
+```
+
+Reading element geometry requires only the core brepjs kernel; `toIfc` / `fromIfc` additionally load
+the `web-ifc` peer dependency.
+
+All public operations return `Result<T, BimError>` (from `brepjs`); validation issues and non-fatal
+warnings travel inside the payload rather than throwing.
+
+## Design
+
+Each `add*` call parses and validates the spec (the `parse*Spec` functions are also exported for
+standalone use), builds the brepjs solid analytically from the spec, and stores a typed `BimElement`
+keyed by a `LocalId`. The IFC writer walks the model, applies placement, and emits schema-correct
+IFC entities; the importer is the inverse. No kernel/WASM changes are required.
+
+## Development
+
+```bash
+npm run typecheck --workspace=brepjs-bim
+npm run lint --workspace=brepjs-bim
+npm run build --workspace=brepjs-bim
+npm run test --workspace=brepjs-bim
+```

package/dist/bcf/bcfRead.d.ts

@@ -0,0 +1,11 @@
+import { Result } from 'brepjs';
+import { BimError } from '../errors/bimError.js';
+import { BcfContainerData, BcfFiles } from './bcfTypes.js';
+/**
+ * Parse an unzipped BCF 3.0 container (`Map<path, xml-string>`) back into the
+ * typed data model. The inverse of `serializeBcfFiles`.
+ *
+ * `FLAG: BCF_ZIP_PACKAGING_ABSENT` — callers holding a `.bcfzip` binary must
+ * unzip it into a `Map<path, string>` (external ZIP library) before calling.
+ */
+export declare function parseBcfFiles(files: BcfFiles): Result<BcfContainerData, BimError>;

package/dist/bcf/bcfTypes.d.ts

@@ -0,0 +1,81 @@
+/**
+ * BCF 3.0 (BIM Collaboration Format) typed data model.
+ *
+ * Container packaging note (`FLAG: BCF_ZIP_PACKAGING_ABSENT`): a real `.bcfzip`
+ * is a ZIP archive of these XML files. No declared ZIP dependency exists in the
+ * brepjs-bim workspace, so this module's stable interchange surface is the
+ * unzipped structure: `BcfFiles = Map<path, xml-string>`. Callers that need the
+ * binary `.bcfzip` must bring their own ZIP library and pack/unpack the map.
+ */
+/** Unzipped BCF container: archive path → XML file contents. */
+export type BcfFiles = Map<string, string>;
+export interface BcfContainerData {
+    readonly version: BcfVersion;
+    readonly project: BcfProject;
+    readonly topics: readonly BcfTopic[];
+}
+export interface BcfVersion {
+    readonly versionId: '3.0';
+    readonly detailedVersion?: string | undefined;
+}
+export interface BcfProject {
+    readonly projectId: string;
+    readonly name: string;
+}
+export interface BcfTopic {
+    readonly guid: string;
+    readonly title: string;
+    readonly topicType?: string | undefined;
+    readonly topicStatus?: string | undefined;
+    readonly priority?: string | undefined;
+    readonly index?: number | undefined;
+    readonly labels?: readonly string[] | undefined;
+    /** ISO 8601 timestamp. */
+    readonly creationDate?: string | undefined;
+    readonly creationAuthor?: string | undefined;
+    readonly modifiedDate?: string | undefined;
+    readonly modifiedAuthor?: string | undefined;
+    readonly description?: string | undefined;
+    readonly assignedTo?: string | undefined;
+    readonly dueDate?: string | undefined;
+    readonly comments: readonly BcfComment[];
+    readonly viewpoints: readonly BcfViewpoint[];
+    readonly relatedTopics?: readonly string[] | undefined;
+}
+export interface BcfComment {
+    readonly guid: string;
+    readonly date: string;
+    readonly author: string;
+    readonly comment: string;
+    /** GUID of a viewpoint owned by the same topic. */
+    readonly viewpointRef?: string | undefined;
+    readonly modifiedDate?: string | undefined;
+    readonly modifiedAuthor?: string | undefined;
+}
+export interface BcfViewpoint {
+    readonly guid: string;
+    readonly viewpointFile?: string | undefined;
+    readonly snapshotFile?: string | undefined;
+    readonly index?: number | undefined;
+    readonly components?: BcfComponents | undefined;
+}
+export interface BcfComponents {
+    readonly selection?: readonly BcfComponent[] | undefined;
+    readonly coloring?: readonly BcfColoring[] | undefined;
+    readonly visibility?: BcfVisibility | undefined;
+}
+export interface BcfComponent {
+    /** IFC GlobalId of the referenced element. */
+    readonly ifcGuid?: string | undefined;
+    readonly originatingSystem?: string | undefined;
+    readonly authoringToolId?: string | undefined;
+}
+export interface BcfColoring {
+    /** Hex ARGB colour, e.g. `FFFF0000`. */
+    readonly color: string;
+    readonly components: readonly BcfComponent[];
+}
+export interface BcfVisibility {
+    readonly defaultVisibility: boolean;
+    readonly exceptions?: readonly BcfComponent[] | undefined;
+}

package/dist/bcf/bcfWrite.d.ts

@@ -0,0 +1,14 @@
+import { BcfContainerData, BcfFiles } from './bcfTypes.js';
+/**
+ * Serialize a BCF 3.0 container into its unzipped file structure
+ * (`Map<path, xml-string>`):
+ *
+ * - `bcf.version` — container version marker
+ * - `project.bcfp` — project metadata
+ * - `{topicGuid}/markup.bcf` — one markup file per topic (topic, comments, viewpoints)
+ *
+ * `FLAG: BCF_ZIP_PACKAGING_ABSENT` — to produce an actual `.bcfzip`, ZIP these
+ * entries with an external library; no ZIP dependency is declared in the
+ * workspace.
+ */
+export declare function serializeBcfFiles(data: BcfContainerData): BcfFiles;

package/dist/bcf/bcfXml.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Minimal, zero-dependency XML helpers scoped to the BCF 3.0 subset.
+ *
+ * `DOMParser`/`XMLSerializer` are not available as Node globals (verified on
+ * Node 24.13), so BCF emission and parsing are done with hand-rolled helpers.
+ * The BCF XML used here is shallow and namespace-light, which keeps this safe.
+ */
+/** Escape text content for `<tag>…</tag>` bodies. */
+export declare function escapeXmlText(value: string): string;
+/** Escape a double-quoted attribute value. */
+export declare function escapeXmlAttr(value: string): string;
+/** Reverse the entity escaping applied above (text and attribute share entities). */
+export declare function unescapeXml(value: string): string;
+export declare function xmlDocument(rootXml: string): string;
+/**
+ * A parsed XML element node. Only the structure needed by the BCF reader is
+ * retained: tag name, attributes, child elements, and concatenated text.
+ */
+export interface XmlNode {
+    readonly tag: string;
+    readonly attrs: Readonly<Record<string, string>>;
+    readonly children: readonly XmlNode[];
+    /** Direct text content with entities decoded. */
+    readonly text: string;
+}
+/**
+ * Parse an XML string into a tree. Tolerant of the XML declaration, comments,
+ * whitespace, self-closing tags, and CDATA-free text. Throws on malformed
+ * structure (unbalanced tags); callers wrap this in a `Result`.
+ */
+export declare function parseXml(xml: string): XmlNode;
+export declare function findChild(node: XmlNode, tag: string): XmlNode | undefined;
+export declare function findChildren(node: XmlNode, tag: string): readonly XmlNode[];
+export declare function childText(node: XmlNode, tag: string): string | undefined;

package/dist/bcf/index.d.ts

@@ -0,0 +1,3 @@
+export type { BcfColoring, BcfComment, BcfComponent, BcfComponents, BcfContainerData, BcfFiles, BcfProject, BcfTopic, BcfVersion, BcfViewpoint, BcfVisibility, } from './bcfTypes.js';
+export { serializeBcfFiles } from './bcfWrite.js';
+export { parseBcfFiles } from './bcfRead.js';