DSL Reference

This section documents the current DSL helpers exported from trueform. The API is intentionally compact and data-first. For types, see src/dsl.ts.

Import

import { context, document, part, exprLiteral } from "trueform/dsl/core";
import { sketch2d, profileRect, profileRef } from "trueform/dsl/sketch";
import { extrude, surface, cut } from "trueform/dsl/features";
import { selectorFace, predPlanar, rankMaxZ } from "trueform/dsl/selectors";
import { assembly, instance, mateFixed } from "trueform/dsl/assembly";
import { refFrame, refSurface, cosmeticThread, surfaceProfileConstraint } from "trueform/dsl/tolerancing";
import { featureArray, sketchArray } from "trueform/dsl/generators";

Compatibility note:

• trueform/dsl/geometry remains available as the broad legacy module.
• Prefer trueform/dsl/features, trueform/dsl/sketch, and trueform/dsl/selectors for clearer intent.
• If you prefer a single namespace, the dsl export is still available from trueform.

Reference Pages

• Quickstart
• Gallery
• Core
• Assembly
• Tolerancing
• Geometry and Sketching
• Features
• Patterns
• Generators
• Selectors, Predicates, Ranking
• Examples

Runtime consumer docs:

• Runtime Selection Integration
• Runtime Sketch Solver

Generated API Reference

You can generate a full API reference from TSDoc comments:

npm run docs:api

This emits static HTML to docs/public/api. When running VitePress, open /api/.