brepjs 20.12.0 → 20.12.1

package/README.md

@@ -2,7 +2,7 @@
 
 # brepjs
 
-CAD modeling for JavaScript.
+Exact B-Rep CAD in TypeScript, built so AI agents can write parts and check them.
 
 [![npm](https://img.shields.io/npm/v/brepjs)](https://www.npmjs.com/package/brepjs)
 [![CI](https://github.com/andymai/brepjs/actions/workflows/ci.yml/badge.svg)](https://github.com/andymai/brepjs/actions/workflows/ci.yml)
@@ -10,13 +10,26 @@ CAD modeling for JavaScript.
 [![Commit activity](https://img.shields.io/github/commit-activity/m/andymai/brepjs?label=commits%2Fmonth)](https://github.com/andymai/brepjs/commits/main)
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](./LICENSE)
 
-**[▶ Try the live playground](https://brepjs.dev/playground)**: write code, watch the solid render, and export STEP, all in your browser.
+https://github.com/user-attachments/assets/a8dce262-2a86-4db2-8956-9d8ca8adcae4
 
-**[Getting Started](./docs/getting-started.md)** · **[Cheat Sheet](./docs/cheat-sheet.md)** · **[Docs](https://brepjs.dev/)**
+</div>
 
-[![brepjs playground: write TypeScript on the left, see the exact solid render on the right](https://raw.githubusercontent.com/andymai/brepjs/main/media/demo.webp)](https://brepjs.dev/playground)
+In this real session, a coding agent (Claude Code) reads the official Raspberry Pi 5 drawing, writes the case as a brepjs part, gets an error back from `brep verify`, fixes it, and adds a fan mount on request. The exported STEP opens in FreeCAD. [Watch the narrated version](https://youtu.be/n8Cbg345NRI).
 
-</div>
+Parts are plain TypeScript files and the checker is a CLI, so it isn't tied to one agent:
+
+```sh
+npm i -D brepjs brepjs-cad occt-wasm
+npx brep verify part.brep.ts
+```
+
+MCP clients can use the `brep-mcp` server instead, and Claude Code users can install the authoring skills as a plugin: `/plugin marketplace add andymai/brepjs`, then `/plugin install brepjs@brepjs`.
+
+An agent rebuilt the 46 parts in our example gallery from their descriptions, and all 46 passed verify. [How we measured it](https://brepjs.dev/agent/eval).
+
+## Or write it yourself
+
+**[▶ Try the live playground](https://brepjs.dev/playground)** · **[Getting Started](./docs/getting-started.md)** · **[Cheat Sheet](./docs/cheat-sheet.md)** · **[Docs](https://brepjs.dev/)**
 
 Shapes are exact mathematical boundaries (not triangle meshes), so booleans are precise, measurements are real, and you can export to STEP. TypeScript types prove the geometry is valid at compile time.
 
@@ -40,20 +53,6 @@ brepjs grew out of the love and care I put into [gridfinitylayouttool.com](https
 
 Neither had the type safety I wanted, so brepjs leans hard on it: branded types, `Result<T,E>`, phantom types that prove invariants at compile time. If it compiles, the geometry is valid. It's strongest at exact, manufacturable geometry — precise booleans, fillets, chamfers and shells; real volumes, areas and clearances; watertight solids that round-trip through STEP — from a single part to a full assembly (enclosures, brackets, fixtures, gridfinity bins, machined and molded parts). It isn't built for organic sculpting or dense lattices; that's what field-based (implicit/voxel) modeling is for.
 
-## Scope
-
-To set expectations, this project deliberately does not:
-
-- **Render or display geometry**: brepjs produces shape data; pass mesh output to Three.js, Babylon.js, or raw WebGL for rendering.
-- **Support organic or sculpting workflows**: brepjs models exact mechanical solids — parts and assemblies; freeform/organic sculpting and dense lattices are out of scope (that's field-based implicit/voxel territory).
-- **Output SVG or 2D files**: 2D drawing primitives exist solely as an intermediate step toward extruded 3D solids, not as a standalone 2D output format.
-- **Run server-side (SSR)**: WASM requires a browser or Node.js environment with WASM support; server-side rendering frameworks (Next.js, Nuxt, Remix) need a client-only import.
-- **Provide a GUI**: brepjs is a pure programmatic API; there is no visual editor, viewport, or file picker.
-
-## Status
-
-[occt-wasm](https://github.com/andymai/occt-wasm) (OpenCascade compiled to WebAssembly) is the default kernel. [brepkit](https://github.com/andymai/brepkit), a Rust-based kernel, is in active development as a faster replacement but not yet ready for production use. The kernel abstraction layer means switching is a one-line change. See [benchmarks](./benchmarks/results/latest.md) for performance comparisons.
-
 ## Install
 
 ```bash
@@ -106,6 +105,20 @@ Layer 0  kernel/, utils/                  WASM bindings
 
 Imports flow downward only. Boundaries are enforced in CI.
 
+## Scope
+
+To set expectations, this project deliberately does not:
+
+- **Render or display geometry**: brepjs produces shape data; pass mesh output to Three.js, Babylon.js, or raw WebGL for rendering.
+- **Support organic or sculpting workflows**: brepjs models exact mechanical solids — parts and assemblies; freeform/organic sculpting and dense lattices are out of scope (that's field-based implicit/voxel territory).
+- **Output SVG or 2D files**: 2D drawing primitives exist solely as an intermediate step toward extruded 3D solids, not as a standalone 2D output format.
+- **Run server-side (SSR)**: WASM requires a browser or Node.js environment with WASM support; server-side rendering frameworks (Next.js, Nuxt, Remix) need a client-only import.
+- **Provide a GUI**: brepjs is a pure programmatic API; there is no visual editor, viewport, or file picker.
+
+## Status
+
+[occt-wasm](https://github.com/andymai/occt-wasm) (OpenCascade compiled to WebAssembly) is the default kernel. [brepkit](https://github.com/andymai/brepkit), a Rust-based kernel, is in active development as a faster replacement but not yet ready for production use. The kernel abstraction layer means switching is a one-line change. See [benchmarks](./benchmarks/results/latest.md) for performance comparisons.
+
 ## Authoring CAD with AI (brepjs-cad)
 
 [`brepjs-cad`](https://www.npmjs.com/package/brepjs-cad) helps an AI agent (or you) author CAD in brepjs and **prove it is correct** before handing it off. An LLM can't see geometry, so it writes a `.brep.ts` part, runs it on a real kernel, and reads a deterministic report instead of guessing from how the code reads. It ships as two cooperating pieces: a **Claude Code skill** (the authoring loop) and a **verification CLI** (validity + measured dimensions + multi-view snapshots + STEP export).

package/dist/topology/apiTypes.d.ts

@@ -1,6 +1,6 @@
 import { Vec2, Vec3 } from '../core/types.js';
 import { AnyShape, Dimension, Edge, Face, Wire, Shape3D } from '../core/shapeTypes.js';
-import { ShapeFinder } from '../query/finderFns.js';
+import { EdgeFinderFn, FaceFinderFn, ShapeFinder } from '../query/finderFns.js';
 /**
  * Structural type matching a Drawing's wire-producing interface.
  * Used in place of importing the actual Drawing class to avoid
@@ -11,8 +11,9 @@ export interface DrawingLike {
         wire: Wire;
     };
 }
+type FinderFor<T extends AnyShape<Dimension>> = T extends Edge ? EdgeFinderFn : T extends Face ? FaceFinderFn : ShapeFinder<T>;
 /** Callback that configures a shape finder for inline use in modifiers. */
-export type FinderFn<T extends AnyShape<Dimension>> = (finder: ShapeFinder<T>) => ShapeFinder<T>;
+export type FinderFn<T extends AnyShape<Dimension>> = (finder: FinderFor<T>) => ShapeFinder<T>;
 /**
  * Fillet radius specification.
  *
@@ -126,3 +127,4 @@ export type Shapeable<T extends AnyShape<Dimension>> = T | WrappedMarker<T>;
 export declare function resolve<T extends AnyShape<Dimension>>(s: Shapeable<T>): T;
 /** Extract the raw branded 3D shape from a Shapeable<Shape3D>. */
 export declare function resolve3D(s: Shapeable<Shape3D>): Shape3D;
+export {};

package/dist/topology.d.ts

@@ -3,7 +3,7 @@
  *
  * @example
  * ```typescript
- * import { box, fuse, fillet, mesh } from 'brepjs/topology';
+ * import { box, fuseAll, variableFillet } from 'brepjs/topology';
  * ```
  */
 export { getHashCode, isSameShape, isEqualShape, getEdges, getFaces, getWires, getVertices, iterEdges, iterFaces, iterWires, iterVertices, getBounds, vertexPosition, invalidateShapeCache, type Bounds3D, type ShapeDescription, } from './topology/shapeFns.js';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "brepjs",
-  "version": "20.12.0",
-  "description": "Web CAD library with pluggable geometry kernel",
+  "version": "20.12.1",
+  "description": "Exact B-Rep CAD in TypeScript on OpenCascade WebAssembly, with a pluggable geometry kernel",
   "keywords": [
     "cad",
     "geometry-kernel",