opengeometry 1.0.9 → 2.0.1

package/README.md

@@ -0,0 +1,169 @@
+<p align="center">
+  <a href="https://opengeometry.io">
+    <img src="https://raw.githubusercontent.com/OpenGeometry-io/.github/main/profile/opengeometryTextLogo.png" alt="OpenGeometry" />
+  </a>
+</p>
+
+<h1 align="center">OpenGeometry</h1>
+
+<p align="center">
+  <strong>CAD kernel for the web — built with Rust, WebAssembly, and Three.js.</strong>
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/opengeometry"><img src="https://img.shields.io/npm/v/opengeometry?style=flat-square&color=4460FF&label=npm" alt="npm version" /></a>
+  <a href="https://github.com/OpenGeometry-io/OpenGeometry/blob/main/LICENSE.md"><img src="https://img.shields.io/github/license/opengeometry-io/opengeometry?style=flat-square" alt="License" /></a>
+  <a href="https://discord.com/invite/cZY2Vm6E"><img src="https://img.shields.io/badge/Discord-Join%20us-5865F2?style=flat-square&logo=discord&logoColor=white" alt="Discord" /></a>
+  <a href="https://x.com/openGeometry"><img src="https://img.shields.io/badge/Twitter-Follow-1DA1F2?style=flat-square&logo=x&logoColor=white" alt="Twitter" /></a>
+  <a href="https://linkedin.com/company/openGeometry"><img src="https://img.shields.io/badge/LinkedIn-Connect-0A66C2?style=flat-square&logo=linkedin&logoColor=white" alt="LinkedIn" /></a>
+</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>
+</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.
+
+---
+
+## What is OpenGeometry?
+
+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.
+
+### What you can do today
+
+| Category | Capabilities |
+| --- | --- |
+| **Primitives** | Lines, arcs, curves, polylines, rectangles |
+| **Shapes** | Polygons, cylinders, cuboids, spheres, wedges |
+| **Operations** | Triangulation, extrusion, sweep, offset, boolean operations |
+| **Exports** | STL, STEP, IFC, PDF projection |
+| **Integration** | Three.js scene management, WebAssembly-powered performance |
+
+## Demos
+
+See OpenGeometry in action — interactive, browser-based demos showcasing the kernel's capabilities:
+
+**[demos.opengeometry.io](https://demos.opengeometry.io)**
+
+Demos include primitives rendering, shape generation, sweep operations, boolean operations, file exports, and more. All running client-side via WebAssembly.
+
+## Quick Start
+
+Install from npm:
+
+```bash
+npm install opengeometry
+```
+
+```ts
+import { Cuboid, OpenGeometry, Vector3 } from "opengeometry";
+
+await OpenGeometry.create({
+  wasmURL: new URL(
+    "node_modules/opengeometry/opengeometry_bg.wasm",
+    import.meta.url
+  ).href,
+});
+
+const cuboid = new Cuboid({
+  center: new Vector3(0, 0, 0),
+  width: 2,
+  height: 1,
+  depth: 1,
+  color: 0x33aa66,
+});
+
+// Placement is strict: scale must be positive + uniform.
+cuboid.setPlacement({
+  translation: new Vector3(1, 0, 0),
+  rotation: new Vector3(0, 0.25, 0),
+  scale: new Vector3(1.25, 1.25, 1.25),
+});
+```
+
+Scenegraph behavior is snapshot-based: `add*ToScene` captures geometry at insert time. If you change placement/config later, push updates explicitly via `replaceBrepEntityInScene` or `refreshBrepEntityInScene`.
+
+For a complete walkthrough, see the [Quick Start guide](https://docs.opengeometry.io/quickstart) or clone the [quickstart-js](https://github.com/OpenGeometry-io/quickstart-js) repo.
+
+## Documentation
+
+Full API reference, guides, and concepts are available at:
+
+**[docs.opengeometry.io](https://docs.opengeometry.io)**
+
+Key pages:
+- [Installation](https://docs.opengeometry.io/installation)
+- [Quick Start](https://docs.opengeometry.io/quickstart)
+- [Architecture & Concepts](https://docs.opengeometry.io/concepts/architecture)
+- [API Reference](https://docs.opengeometry.io/api)
+
+## Repository Structure
+
+```
+main/opengeometry          Rust core → WebAssembly
+main/opengeometry-three    Three.js integration layer
+main/opengeometry-webgl    WebGL-oriented package (WIP)
+main/opengeometry-babylon  Babylon.js-oriented package (WIP)
+docs/                      Documentation source (Mintlify)
+```
+
+## Building from Source
+
+**Prerequisites:** Node.js, npm, Rust toolchain, `wasm-pack`
+
+```bash
+# Install dependencies
+npm install
+
+# Build Rust core → WebAssembly
+npm run build-core
+
+# Build everything (core + Three.js + WASM copy)
+npm run build
+
+# Run the Three.js example app locally
+npm --prefix main/opengeometry-three run dev-example-three
+
+# Run tests
+npm test
+```
+
+## Who is this for?
+
+- Teams building **browser-based CAD/BIM/geometry tools**
+- Developers evaluating **WebAssembly-powered 3D** for the web
+- 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).
+
+## Community
+
+We'd love to have you involved — whether you're using OpenGeometry, building on it, or just curious.
+
+- **[Discord](https://discord.com/invite/cZY2Vm6E)** — Chat with the team and community
+- **[Twitter / X](https://x.com/openGeometry)** — Updates and announcements
+- **[LinkedIn](https://linkedin.com/company/openGeometry)** — Company updates
+- **[GitHub Issues](https://github.com/OpenGeometry-io/OpenGeometry/issues)** — Bug reports and feature requests
+- **[Blog](https://opengeometry.io/blog)** — Deep dives and release notes
+
+## Contributing
+
+OpenGeometry is open source under the [MPL-2.0 license](./LICENSE.md). Contributions are welcome — check the [issues](https://github.com/OpenGeometry-io/OpenGeometry/issues) for good starting points or open a discussion on [Discord](https://discord.com/invite/cZY2Vm6E).
+
+## AI Agent Docs Policy
+
+- Repository-level AI agent instructions are in [AGENTS.md](./AGENTS.md).
+- 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.
+
+---
+
+<p align="center">
+  <sub><em>"It is my land. Who would I be if I did not try to make it better?" — A Knight.</em></sub>
+</p>

package/index.d.ts

@@ -2,9 +2,9 @@
  * OpenGeometry Three.js adapter entrypoint.
  * @module @opengeometry/kernel-three
  */
-import { OGSceneManager, Vector3 } from "../opengeometry/pkg/opengeometry";
-import { SpotLabel } from "./src/markup/spotMarker";
-import { OpenGeometryOptions } from "./src/base-types";
+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";
 export interface OGStlExportResult {
     bytes: Uint8Array;
@@ -62,16 +62,24 @@ export { OGSceneManager, Vector3, SpotLabel, };
 /**
  * Primitive wrappers (line/polyline/arc/rectangle/curve).
  */
-export * from './src/primitives/';
+export * from "./src/primitives/index.js";
 /**
  * Shape wrappers (polygon/cuboid/cylinder/wedge/opening/sweep/sphere).
  */
-export * from './src/shapes/';
+export * from "./src/shapes/index.js";
 /**
  * Reusable example builders for quickly wiring demo scenes.
  */
-export * from './src/examples/';
+export * from "./src/examples/index.js";
+/**
+ * First-class freeform geometry wrapper around the kernel OGFreeformGeometry API.
+ */
+export * from "./src/freeform/index.js";
+/**
+ * Editing helpers that operate on parametric entities and freeform geometry.
+ */
+export * from "./src/editor/index.js";
 /**
  * Kernel-backed modeling operations.
  */
-export * from './src/operations/';
+export * from "./src/operations/index.js";