TypeScript SDK

Generated from sdk/ts/src/index.ts and public re-export sources using the TypeScript compiler API.

Pages

Page	Contents
Design	Fluent authoring, output, simulation, and verifier methods.
Core types	IR, metrics, report, and shared public types.
Generator exports	TPMS and other procedural generator exports.

Public exports

Export	Kind	Docs	Source	Sample	Summary
Design	class	Design	sdk/ts/src/design.ts		Fluent builder for Dry L1 authoring operations and engine-backed resolution calls.
Finding	interface	Core types	sdk/ts/src/ops.ts	Verify	Single verification finding, optionally tied to a resolved segment index.
MachineKinematics	interface	Core types	sdk/ts/src/engine.ts		Machine kinematic limits used by resolveBalancedIr and resolveVerify.
Metrics	interface	Core types	sdk/ts/src/ops.ts		Simulation metrics returned by simulate.
NormalizedStarPolygonAlpha	interface	Generator exports	sdk/ts/src/generators/starPolygonLattice.ts		Normalized alpha angle and regime classification for a lattice family.
normalizeStarPolygonAlpha	function	Generator exports	sdk/ts/src/generators/starPolygonLattice.ts		Normalize an alpha angle into its effective value and geometric regime.
Op	type	Core types	sdk/ts/src/ops.ts		Authoring operation in Dry L1, before resolution into concrete toolpath segments.
PRINTERS	const	Core types	sdk/ts/src/ops.ts		Device defaults (the generic printer).
Report	interface	Core types	sdk/ts/src/ops.ts	Verify	Verification result containing all findings emitted by enabled rules.
RESOLVE_PARAMS	const	Core types	sdk/ts/src/ops.ts		Default resolver parameters for the generic built-in printer profile.
resolveBalancedIr	function	Core types	sdk/ts/src/engine.ts		Resolve a design through the kinematics-aware balanced optimization pipeline.
resolveBinary	function	Core types	sdk/ts/src/engine.ts		Resolve a design and return the L2 Dry IR encoded as the binary DRY1 format (raw bytes).
resolveGcode	function	Core types	sdk/ts/src/engine.ts		Resolve a design and emit motion g-code.
resolveIr	function	Core types	sdk/ts/src/engine.ts		Resolve a design to the L2 Dry IR.
resolveMetrics	function	Core types	sdk/ts/src/engine.ts		Resolve a design and return its simulation metrics.
resolveMetricsIr	function	Core types	sdk/ts/src/engine.ts		Simulate an already-resolved Dry IR ({ version, segments }) and return its metrics.
resolveOptimizedIr	function	Core types	sdk/ts/src/engine.ts		Resolve a design through the standard L2 optimization pipeline.
ResolveParams	interface	Core types	sdk/ts/src/ops.ts		The lowering defaults (print/travel feedrate, filament diameter) — mirrors the engine's ResolveParams.
resolveVerify	function	Core types	sdk/ts/src/engine.ts		Resolve a design and verify it against safety contracts.
Segment	interface	Core types	sdk/ts/src/ops.ts		One resolved motion or process segment in the Dry L2 IR.
SegmentKind	type	Core types	sdk/ts/src/ops.ts		One resolved L2 motion segment.
Severity	type	Core types	sdk/ts/src/ops.ts	Verify	Severity level for a verification finding.
STAR_POLYGON_FAMILIES	const	Generator exports	sdk/ts/src/generators/starPolygonLattice.ts		Metadata catalog for the supported star-polygon lattice families.
StarPolygonBasis	type	Generator exports	sdk/ts/src/generators/starPolygonLattice.ts		Base tiling used by a star-polygon lattice family.
starPolygonDentRadiusRatio	function	Generator exports	sdk/ts/src/generators/starPolygonLattice.ts		Ratio of dent radius to star-point radius for an equiangular/equilateral star n-gon.
StarPolygonFamily	type	Generator exports	sdk/ts/src/generators/starPolygonLattice.ts		Star-polygon lattice family from the original M1-M4 construction.
starPolygonFamilySpec	function	Generator exports	sdk/ts/src/generators/starPolygonLattice.ts		Return static metadata for a star-polygon lattice family.
StarPolygonFamilySpec	interface	Generator exports	sdk/ts/src/generators/starPolygonLattice.ts		Static metadata for one star-polygon lattice family.
starPolygonLattice	function	Generator exports	sdk/ts/src/generators/starPolygonLattice.ts		Generate a fluent Design containing a star-polygon lattice toolpath.
starPolygonLatticeOps	function	Generator exports	sdk/ts/src/generators/starPolygonLattice.ts		Generate Dry L1 authoring operations for a star-polygon lattice.
StarPolygonLatticeOptions	interface	Generator exports	sdk/ts/src/generators/starPolygonLattice.ts		Options for generating a star-polygon lattice toolpath.
StarPolygonRegime	type	Generator exports	sdk/ts/src/generators/starPolygonLattice.ts		Geometric regime after normalizing the input alpha angle.
Toolpath	interface	Core types	sdk/ts/src/ops.ts		The resolved L2 Dry IR.
ToolpathMeta	interface	Core types	sdk/ts/src/ops.ts		Optional provenance and invariant metadata attached to a resolved toolpath.
tpms	function	Generator exports	sdk/ts/src/generators/tpms.ts	Generative	Generate a fluent Design containing a TPMS toolpath.
TPMS_SURFACES	const	Generator exports	sdk/ts/src/generators/tpms.ts		Metadata catalog for all supported TPMS surfaces.
tpmsField	function	Generator exports	sdk/ts/src/generators/tpms.ts		Sample a surface's nodal field at (x, y, z) — world coordinates already scaled by 2π / cellSize.
tpmsOps	function	Generator exports	sdk/ts/src/generators/tpms.ts	Generative	Build the selected TPMS infill as an L1 op list.
TpmsOptions	interface	Generator exports	sdk/ts/src/generators/tpms.ts	Generative	Options for slicing a TPMS scalar field into Dry authoring operations.
TpmsSurface	type	Generator exports	sdk/ts/src/generators/tpms.ts	Generative	Supported triply periodic minimal surface names for TPMS generation.
tpmsSurfaceSpec	function	Generator exports	sdk/ts/src/generators/tpms.ts		Return display metadata for a TPMS surface.
TpmsSurfaceSpec	interface	Generator exports	sdk/ts/src/generators/tpms.ts	Generative	Display metadata for a TPMS surface.