opengeometry 2.0.2 → 2.0.4

package/README.md

@@ -19,12 +19,12 @@
 </p>
 
 <p align="center">
-  <a href="https://opengeometry.io">Website</a> · <a href="https://docs.opengeometry.io">Documentation</a> · <a href="https://demos.opengeometry.io">Live Demos</a> · <a href="https://opengeometry.io/blog">Blog</a> · <a href="https://www.npmjs.com/package/opengeometry">npm</a>
+  <a href="https://opengeometry.io">Website</a> · <a href="https://docs.opengeometry.io">Documentation</a> · <a href="https://demo.opengeometry.io">Live Demos</a> · <a href="https://opengeometry.io/blog">Blog</a> · <a href="https://www.npmjs.com/package/opengeometry">npm</a>
 </p>
 
 ---
 
-> **Actively under development.** We're building OpenGeometry in the open. APIs, examples, and package structure are evolving — breaking changes are still possible. Star the repo to follow along.
+> **Actively maintained and growing.** We're building OpenGeometry in the open. APIs, examples, and package structure are evolving, we are actively improving and expanding the project. Star the repo to follow along. If you have questions or want to get involved, join the [Discord](https://discord.com/invite/cZY2Vm6E) or check out the [issues](https://github.com/OpenGeometry-io/OpenGeometry/issues)
 
 ---
 
@@ -32,14 +32,39 @@
 
 OpenGeometry is an **open-source CAD kernel** purpose-built for the browser. The geometry engine is written in **Rust**, compiled to **WebAssembly**, and ships with a **Three.js integration layer** — so you can build real CAD tools that run entirely on the web.
 
-Whether you're building a parametric modeler, a BIM viewer, a 3D configurator, or any geometry-heavy web app, OpenGeometry gives you the primitives and operations you need without leaving JavaScript.
+OpenGeometry is best suited for **browser-based CAD, AEC/BIM, configurators, and geometry-heavy web tools**. Whether you're building a parametric modeler, a wall/opening workflow, a BIM viewer, or a custom Three.js modeling tool, OpenGeometry gives you kernel-backed primitives and operations without leaving JavaScript.
+
+OpenPlans is an application/toolkit built on top of OpenGeometry for AEC workflows. In this repository, OpenGeometry is the engine.
+
+## When to use OpenGeometry
+
+Use OpenGeometry when you need:
+
+- browser-based parametric modeling with Rust + WebAssembly performance
+- wall/opening subtraction and other solid boolean workflows
+- polygon extrusion into solids for CAD or AEC modeling
+- IFC, STEP, STL, and PDF-style export/projection in web apps
+- a Three.js-friendly CAD kernel instead of ad hoc mesh math
+
+## AI and Coding Agent Entrypoints
+
+If you are using ChatGPT, Claude, Gemini, Copilot, or other coding agents on this repository, start here:
+
+- [llms.txt](./llms.txt)
+- [llms-full.txt](./llms-full.txt)
+- [llm.txt](./llm.txt)
+- [AGENTS.md](./AGENTS.md)
+- [Quickstart](https://docs.opengeometry.io/quickstart)
+- [Three.js integration](https://docs.opengeometry.io/integration/threejs)
+- [Boolean operations](https://docs.opengeometry.io/api/operations/boolean-operations)
+- [Extrude](https://docs.opengeometry.io/api/operations/extrude)
 
 ### What you can do today
 
 | Category | Capabilities |
 | --- | --- |
 | **Primitives** | Lines, arcs, curves, polylines, rectangles |
-| **Shapes** | Polygons, cylinders, cuboids, spheres, wedges |
+| **Shapes** | Polygons, solids, cuboids, cylinders, spheres, wedges, sweeps, openings |
 | **Operations** | Triangulation, extrusion, sweep, offset, boolean operations |
 | **Exports** | STL, STEP, IFC, PDF projection |
 | **Integration** | Three.js scene management, WebAssembly-powered performance |
@@ -48,7 +73,7 @@ Whether you're building a parametric modeler, a BIM viewer, a 3D configurator, o
 
 See OpenGeometry in action — interactive, browser-based demos showcasing the kernel's capabilities:
 
-**[demos.opengeometry.io](https://demos.opengeometry.io)**
+**[demo.opengeometry.io](https://demo.opengeometry.io)**
 
 Demos include primitives rendering, shape generation, sweep operations, boolean operations, file exports, and more. All running client-side via WebAssembly.
 
@@ -70,6 +95,7 @@ await OpenGeometry.create({
   ).href,
 });
 
+// Initialize once before constructing Vector3 or any wrapper.
 const cuboid = new Cuboid({
   center: new Vector3(0, 0, 0),
   width: 2,
@@ -140,7 +166,7 @@ npm test
 - Contributors interested in the **Rust → WASM geometry pipeline**
 - Anyone exploring **open-source CAD kernel internals**
 
-If you just want a quick look, start with the [hosted demos](https://demos.opengeometry.io) or the [quickstart repo](https://github.com/OpenGeometry-io/quickstart-js).
+If you just want a quick look, start with the [hosted demos](https://demo.opengeometry.io) or the [quickstart repo](https://github.com/OpenGeometry-io/quickstart-js).
 
 ## Community
 
@@ -159,6 +185,8 @@ OpenGeometry is open source under the [MPL-2.0 license](./LICENSE.md). Contribut
 ## AI Agent Docs Policy
 
 - Repository-level AI agent instructions are in [AGENTS.md](./AGENTS.md).
+- LLM-friendly repo entrypoints are [llms.txt](./llms.txt), [llms-full.txt](./llms-full.txt), and
+  [llm.txt](./llm.txt).
 - All AI-generated documentation must live under [`AI-DOCs/`](./AI-DOCs/).
 - AI-generated docs should not be added under app/code folders unless explicitly requested.
 

package/index.d.ts

@@ -1,23 +1,34 @@
 /**
- * OpenGeometry Three.js adapter entrypoint.
- * @module @opengeometry/kernel-three
+ * Public OpenGeometry JavaScript entrypoint.
  */
 import { OGSceneManager, Vector3 } from "./opengeometry/pkg/opengeometry.js";
 import { SpotLabel } from "./src/markup/spotMarker.js";
 import { OpenGeometryOptions } from "./src/base-types.js";
 export type OUTLINE_TYPE = "front" | "side" | "top";
+/**
+ * Binary STL export payload returned by export helpers.
+ */
 export interface OGStlExportResult {
     bytes: Uint8Array;
     reportJson: string;
 }
+/**
+ * STEP text export payload returned by export helpers.
+ */
 export interface OGStepExportResult {
     text: string;
     reportJson: string;
 }
+/**
+ * IFC text export payload returned by export helpers.
+ */
 export interface OGIfcExportResult {
     text: string;
     reportJson: string;
 }
+/**
+ * Shared runtime entrypoint used to initialize the OpenGeometry wasm module.
+ */
 export declare class OpenGeometry {
     static version: string;
     static instance: OpenGeometry | null;
@@ -35,30 +46,36 @@ export declare class OpenGeometry {
     set enableDebug(value: boolean);
     constructor();
     /**
-     * Asynchronously creates and initializes an instance of OpenGeometry.
+     * Asynchronously initializes the OpenGeometry wasm runtime and returns a
+     * cached singleton instance on subsequent calls.
      *
-     * This factory method sets up the OpenGeometry engine by linking it with the
-     * rendering context and the WebAssembly module. It ensures all required
-     * options are provided and prepares the instance for 3D geometry operations.
+     * Call this before constructing `Vector3` or any kernel-backed wrapper.
      *
      * @param options - Configuration object for initializing OpenGeometry.
      * @returns A promise that resolves to a fully initialized OpenGeometry instance.
-     * @throws If any of the required options (`container`, `scene`, or `camera`) are missing.
      *
      * @example
      * ```ts
-     * const openGeometry = await OpenGeometry.create({
-     *   container: document.getElementById('myContainer')!,
-     *   scene: threeScene,
-     *   camera: threeCamera,
-     *   wasmURL: '/assets/opengeometry.wasm'
+     * await OpenGeometry.create({
+     *   wasmURL: "/opengeometry_bg.wasm",
      * });
      * ```
      */
     static create(options: OpenGeometryOptions): Promise<OpenGeometry>;
     private setup;
 }
-export { OGSceneManager, Vector3, SpotLabel, };
+/**
+ * Scene manager that stores serialized BRep snapshots in wasm for projection,
+ * export, and other scene-level workflows.
+ */
+export { OGSceneManager };
+/**
+ * Shared wasm-backed vector type used throughout the public API.
+ *
+ * Initialize `OpenGeometry.create(...)` before constructing `Vector3`.
+ */
+export { Vector3 };
+export { SpotLabel };
 /**
  * Primitive wrappers (line/polyline/arc/rectangle/curve).
  */