Skip to content

TypeScript SDK ​

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

Pages ​

PageContents
DesignFluent authoring, output, simulation, and verifier methods.
Core typesIR, metrics, report, and shared public types.
Generator exportsTPMS and other procedural generator exports.

Public exports ​

ExportKindDocsSourceSampleSummary
DesignclassDesignsdk/ts/src/design.tsFluent builder for Dry L1 authoring operations and engine-backed resolution calls.
FindinginterfaceCore typessdk/ts/src/ops.tsVerifySingle verification finding, optionally tied to a resolved segment index.
MachineKinematicsinterfaceCore typessdk/ts/src/engine.tsMachine kinematic limits used by resolveBalancedIr and resolveVerify.
MetricsinterfaceCore typessdk/ts/src/ops.tsSimulation metrics returned by simulate.
NormalizedStarPolygonAlphainterfaceGenerator exportssdk/ts/src/generators/starPolygonLattice.tsNormalized alpha angle and regime classification for a lattice family.
normalizeStarPolygonAlphafunctionGenerator exportssdk/ts/src/generators/starPolygonLattice.tsNormalize an alpha angle into its effective value and geometric regime.
OptypeCore typessdk/ts/src/ops.tsAuthoring operation in Dry L1, before resolution into concrete toolpath segments.
PRINTERSconstCore typessdk/ts/src/ops.tsDevice defaults (the generic printer).
ReportinterfaceCore typessdk/ts/src/ops.tsVerifyVerification result containing all findings emitted by enabled rules.
RESOLVE_PARAMSconstCore typessdk/ts/src/ops.tsDefault resolver parameters for the generic built-in printer profile.
resolveBalancedIrfunctionCore typessdk/ts/src/engine.tsResolve a design through the kinematics-aware balanced optimization pipeline.
resolveBinaryfunctionCore typessdk/ts/src/engine.tsResolve a design and return the L2 Dry IR encoded as the binary DRY1 format (raw bytes).
resolveGcodefunctionCore typessdk/ts/src/engine.tsResolve a design and emit motion g-code.
resolveIrfunctionCore typessdk/ts/src/engine.tsResolve a design to the L2 Dry IR.
resolveMetricsfunctionCore typessdk/ts/src/engine.tsResolve a design and return its simulation metrics.
resolveMetricsIrfunctionCore typessdk/ts/src/engine.tsSimulate an already-resolved Dry IR ({ version, segments }) and return its metrics.
resolveOptimizedIrfunctionCore typessdk/ts/src/engine.tsResolve a design through the standard L2 optimization pipeline.
ResolveParamsinterfaceCore typessdk/ts/src/ops.tsThe lowering defaults (print/travel feedrate, filament diameter) — mirrors the engine's ResolveParams.
resolveVerifyfunctionCore typessdk/ts/src/engine.tsResolve a design and verify it against safety contracts.
SegmentinterfaceCore typessdk/ts/src/ops.tsOne resolved motion or process segment in the Dry L2 IR.
SegmentKindtypeCore typessdk/ts/src/ops.tsOne resolved L2 motion segment.
SeveritytypeCore typessdk/ts/src/ops.tsVerifySeverity level for a verification finding.
STAR_POLYGON_FAMILIESconstGenerator exportssdk/ts/src/generators/starPolygonLattice.tsMetadata catalog for the supported star-polygon lattice families.
StarPolygonBasistypeGenerator exportssdk/ts/src/generators/starPolygonLattice.tsBase tiling used by a star-polygon lattice family.
starPolygonDentRadiusRatiofunctionGenerator exportssdk/ts/src/generators/starPolygonLattice.tsRatio of dent radius to star-point radius for an equiangular/equilateral star n-gon.
StarPolygonFamilytypeGenerator exportssdk/ts/src/generators/starPolygonLattice.tsStar-polygon lattice family from the original M1-M4 construction.
starPolygonFamilySpecfunctionGenerator exportssdk/ts/src/generators/starPolygonLattice.tsReturn static metadata for a star-polygon lattice family.
StarPolygonFamilySpecinterfaceGenerator exportssdk/ts/src/generators/starPolygonLattice.tsStatic metadata for one star-polygon lattice family.
starPolygonLatticefunctionGenerator exportssdk/ts/src/generators/starPolygonLattice.tsGenerate a fluent Design containing a star-polygon lattice toolpath.
starPolygonLatticeOpsfunctionGenerator exportssdk/ts/src/generators/starPolygonLattice.tsGenerate Dry L1 authoring operations for a star-polygon lattice.
StarPolygonLatticeOptionsinterfaceGenerator exportssdk/ts/src/generators/starPolygonLattice.tsOptions for generating a star-polygon lattice toolpath.
StarPolygonRegimetypeGenerator exportssdk/ts/src/generators/starPolygonLattice.tsGeometric regime after normalizing the input alpha angle.
ToolpathinterfaceCore typessdk/ts/src/ops.tsThe resolved L2 Dry IR.
ToolpathMetainterfaceCore typessdk/ts/src/ops.tsOptional provenance and invariant metadata attached to a resolved toolpath.
tpmsfunctionGenerator exportssdk/ts/src/generators/tpms.tsGenerativeGenerate a fluent Design containing a TPMS toolpath.
TPMS_SURFACESconstGenerator exportssdk/ts/src/generators/tpms.tsMetadata catalog for all supported TPMS surfaces.
tpmsFieldfunctionGenerator exportssdk/ts/src/generators/tpms.tsSample a surface's nodal field at (x, y, z) — world coordinates already scaled by 2π / cellSize.
tpmsOpsfunctionGenerator exportssdk/ts/src/generators/tpms.tsGenerativeBuild the selected TPMS infill as an L1 op list.
TpmsOptionsinterfaceGenerator exportssdk/ts/src/generators/tpms.tsGenerativeOptions for slicing a TPMS scalar field into Dry authoring operations.
TpmsSurfacetypeGenerator exportssdk/ts/src/generators/tpms.tsGenerativeSupported triply periodic minimal surface names for TPMS generation.
tpmsSurfaceSpecfunctionGenerator exportssdk/ts/src/generators/tpms.tsReturn display metadata for a TPMS surface.
TpmsSurfaceSpecinterfaceGenerator exportssdk/ts/src/generators/tpms.tsGenerativeDisplay metadata for a TPMS surface.