@metamesh/modeling 0.16.0 → 0.18.0

package/dist/docs/reference/model/GenerateContext.md

@@ -6,7 +6,7 @@ The sole synchronous authoring context, supplied independently of Studio.
 
 ### P
 
-`P`
+`P` *extends* `object`
 
 ### S
 
@@ -18,7 +18,7 @@ The sole synchronous authoring context, supplied independently of Studio.
 
 
 
-`readonly` **params**: `Readonly`\<`P`\>
+`readonly` **params**: [`ImmutableValue`](ImmutableValue.md)\<`P`\>
 
 
 
@@ -84,21 +84,13 @@ arrays must be deeply immutable. An empty list still tracks reads inside the cal
 
 
 
-`readonly` **part**: \{(`id`: `string`, `geometry`: [`ComputedValue`](ComputedValue.md)\<[`PartGeometry`](PartGeometry.md)\>): [`GeneratedPart`](GeneratedPart.md); (`id`: `string`, `options`: [`PartOptions`](PartOptions.md)): [`GeneratedPart`](GeneratedPart.md); \}
+`readonly` **part**: (`id`: `string`, `input`: [`PartOptions`](PartOptions.md) \| [`ComputedValue`](ComputedValue.md)\<[`PartGeometry`](PartGeometry.md)\>) => [`PartDeclaration`](PartDeclaration.md)
 
 
 
 Declares a semantic part with identity placement, or explicit placement and appearance.
 
-#### Call Signature
-
-
-
-(`id`: `string`, `geometry`: [`ComputedValue`](ComputedValue.md)\<[`PartGeometry`](PartGeometry.md)\>): [`GeneratedPart`](GeneratedPart.md)
-
-
-
-##### Parameters
+#### Parameters
 
 <a id="id-1"></a>
 
@@ -106,57 +98,15 @@ Declares a semantic part with identity placement, or explicit placement and appe
 
 
 
-<a id="geometry"></a>
-
-**`geometry`** · [`ComputedValue`](ComputedValue.md)\<[`PartGeometry`](PartGeometry.md)\> · Required
-
-
-
-##### Returns
-
-[`GeneratedPart`](GeneratedPart.md)
-
-#### Call Signature
-
-
-
-(`id`: `string`, `options`: [`PartOptions`](PartOptions.md)): [`GeneratedPart`](GeneratedPart.md)
-
-
-
-##### Parameters
-
-<a id="id-2"></a>
-
-**`id`** · `string` · Required
-
-
-
-<a id="options"></a>
-
-**`options`** · [`PartOptions`](PartOptions.md) · Required
-
-- [`geometry`](PartOptions.md#geometry) · [`ComputedValue`](ComputedValue.md)\<[`PartGeometry`](PartGeometry.md)\> · Required
-
-  Local geometry or a lazy reader; native objects never cross a revision.
-
-- [`position`](PartOptions.md#position) · [`ComputedValue`](ComputedValue.md)\<[`Vector3Input`](Vector3Input.md)\> · Optional
+<a id="input"></a>
 
-  XYZ vector or tuple translation in millimetres, applied after rotation; defaults to zero.
+**`input`** · [`PartOptions`](PartOptions.md) \| [`ComputedValue`](ComputedValue.md)\<[`PartGeometry`](PartGeometry.md)\> · Required
 
-- [`rotation`](PartOptions.md#rotation) · [`ComputedValue`](ComputedValue.md)\<[`Vector3Input`](Vector3Input.md)\> · Optional
 
-  XYZ vector or tuple of fixed global X, Y, Z rotations in degrees; defaults to zero.
 
-- [`color`](PartOptions.md#color) · `string` · Optional
-
-  Optional six-digit hexadecimal semantic part color.
-
-
-
-##### Returns
+#### Returns
 
-[`GeneratedPart`](GeneratedPart.md)
+[`PartDeclaration`](PartDeclaration.md)
 
 ***
 
@@ -169,6 +119,7 @@ Declares a semantic part with identity placement, or explicit placement and appe
 
 
 Immediately aborts on false; geometry observations in the condition run first.
+This diagnostic helper does not narrow TypeScript types; use an explicit conditional guard when needed.
 
 #### Call Signature
 
@@ -192,7 +143,7 @@ Immediately aborts on false; geometry observations in the condition run first.
 
 
 
-<a id="options-1"></a>
+<a id="options"></a>
 
 **`options`** · [`DiagnosticOptions`](DiagnosticOptions.md)\<`P`\> · Optional
 
@@ -224,7 +175,7 @@ Immediately aborts on false; geometry observations in the condition run first.
 
 
 
-<a id="options-2"></a>
+<a id="options-1"></a>
 
 **`options`** · [`DiagnosticOptions`](DiagnosticOptions.md)\<`P`\> · Optional
 
@@ -254,7 +205,7 @@ Records a nonblocking issue; call only in the outer generation callback.
 
 
 
-<a id="options-3"></a>
+<a id="options-2"></a>
 
 **`options`** · [`DiagnosticOptions`](DiagnosticOptions.md)\<`P`\> · Optional
 
@@ -270,7 +221,8 @@ Records a nonblocking issue; call only in the outer generation callback.
 - [Computed](Computed.md)
 - [ComputedValue](ComputedValue.md)
 - [DiagnosticOptions](DiagnosticOptions.md)
-- [GeneratedPart](GeneratedPart.md)
+- [ImmutableValue](ImmutableValue.md)
+- [PartDeclaration](PartDeclaration.md)
 - [PartGeometry](PartGeometry.md)
 - [PartOptions](PartOptions.md)
 
@@ -278,4 +230,4 @@ Records a nonblocking issue; call only in the outer generation callback.
 
 - [Complete standalone model example](../../guides/standalone-model.md#minimal-model-entry)
 
-Package: `@metamesh/modeling@0.16.0`.
+Package: `@metamesh/modeling@0.18.0`.

package/dist/docs/reference/model/GenerationDiagnostic.md

@@ -38,9 +38,21 @@ Human-readable corrective guidance.
 
 Optional control identity, validated against the supplied parameters.
 
+***
+
+### path?
+
+
+
+`readonly` `optional` **path?**: readonly (`string` \| `number`)[]
+
+
+
+Relative field location within the parameter, or input map when parameterId is omitted.
+
 
 ## Guides
 
 - [Complete standalone model example](../../guides/standalone-model.md#minimal-model-entry)
 
-Package: `@metamesh/modeling@0.16.0`.
+Package: `@metamesh/modeling@0.18.0`.

package/dist/docs/reference/model/GenerationError.md

@@ -55,4 +55,4 @@ Issues reached in normal JavaScript order, ending with the first failed assertio
 
 - [Complete standalone model example](../../guides/standalone-model.md#minimal-model-entry)
 
-Package: `@metamesh/modeling@0.16.0`.
+Package: `@metamesh/modeling@0.18.0`.

package/dist/docs/reference/model/GeometryError.md

@@ -0,0 +1,102 @@
+# GeometryError
+
+Error raised when a geometry precondition or invariant is not satisfied.
+
+Callers may use `code` for coarse recovery decisions. Human-facing details
+remain in `message`; messages are descriptive but are not a stable API.
+
+## Example
+
+```ts
+const error = new GeometryError("INVALID_ARGUMENT", "Radius must be positive.", {
+  operation: "example",
+  details: { radius: 0 },
+});
+```
+
+## Extends
+
+- `Error`
+
+## Constructors
+
+### Constructor
+
+
+
+**new GeometryError**(`code`: [`GeometryErrorCode`](GeometryErrorCode.md), `message`: `string`, `context?`: [`GeometryErrorContext`](GeometryErrorContext.md)): `GeometryError`
+
+
+
+Creates a geometry error with a stable category, operation, and descriptive message.
+
+#### Parameters
+
+<a id="code"></a>
+
+**`code`** · [`GeometryErrorCode`](GeometryErrorCode.md) · Required
+
+Machine-readable failure category.
+
+
+
+<a id="message"></a>
+
+**`message`** · `string` · Required
+
+Human-readable diagnostic message.
+
+
+
+<a id="context"></a>
+
+**`context`** · [`GeometryErrorContext`](GeometryErrorContext.md) · Optional
+
+Operation and optional scalar facts. Defaults to `{ operation: "geometry" }`.
+
+
+
+#### Returns
+
+`GeometryError`
+
+#### Overrides
+
+`Error.constructor`
+
+## Properties
+
+### code
+
+
+
+`readonly` **code**: [`GeometryErrorCode`](GeometryErrorCode.md)
+
+
+
+Machine-readable failure category.
+
+***
+
+### context
+
+
+
+`readonly` **context**: [`GeometryErrorContext`](GeometryErrorContext.md)
+
+
+
+Operation and scalar facts associated with the failure.
+
+
+## Related APIs
+
+- [GeometryErrorCode](GeometryErrorCode.md)
+- [GeometryErrorContext](GeometryErrorContext.md)
+
+## Guides
+
+- [Geometry vocabulary](../../guides/concepts.md#geometry-vocabulary)
+- [Lifecycle and inspection](../../guides/concepts.md#lifecycle-and-inspection)
+
+Package: `@metamesh/modeling@0.18.0`.

package/dist/docs/reference/model/GeometryErrorCode.md

@@ -0,0 +1,15 @@
+# GeometryErrorCode
+
+Stable categories for invalid inputs, topology, allocation, and runtime failures.
+
+**GeometryErrorCode** = `"COMPLEXITY_LIMIT"` \| `"DEGENERATE_GEOMETRY"` \| `"INVALID_ARGUMENT"` \| `"INVALID_MESH"` \| `"INVALID_TOPOLOGY"` \| `"INVALID_TOLERANCE"` \| `"NON_FINITE_VALUE"` \| `"SELF_INTERSECTION"` \| `"SINGULAR_TRANSFORM"` \| `"UNSUPPORTED_RUNTIME"`
+
+
+
+
+## Guides
+
+- [Geometry vocabulary](../../guides/concepts.md#geometry-vocabulary)
+- [Lifecycle and inspection](../../guides/concepts.md#lifecycle-and-inspection)
+
+Package: `@metamesh/modeling@0.18.0`.

package/dist/docs/reference/model/GeometryErrorContext.md

@@ -0,0 +1,35 @@
+# GeometryErrorContext
+
+Serializable context attached to a geometry failure.
+
+## Properties
+
+### details?
+
+
+
+`readonly` `optional` **details?**: `Readonly`\<`Record`\<`string`, `string` \| `number` \| `boolean`\>\>
+
+
+
+Optional scalar facts useful for diagnostics without parsing the message.
+
+***
+
+### operation
+
+
+
+`readonly` **operation**: `string`
+
+
+
+Stable operation name, such as `normalizeContour` or `extrude`.
+
+
+## Guides
+
+- [Geometry vocabulary](../../guides/concepts.md#geometry-vocabulary)
+- [Lifecycle and inspection](../../guides/concepts.md#lifecycle-and-inspection)
+
+Package: `@metamesh/modeling@0.18.0`.

package/dist/docs/reference/model/GeometryResolution.md

@@ -67,4 +67,4 @@ Lower full-circle segment count; defaults to 16 or a lower selected circular cei
 
 - [Coordinates, units, and resolution](../../guides/concepts.md#coordinates-units-and-resolution)
 
-Package: `@metamesh/modeling@0.16.0`.
+Package: `@metamesh/modeling@0.18.0`.

package/dist/docs/reference/model/GeometrySamplingLimits.md

@@ -59,4 +59,4 @@ Maximum segments around one complete circle.
 
 - [ModelingLimits](ModelingLimits.md)
 
-Package: `@metamesh/modeling@0.16.0`.
+Package: `@metamesh/modeling@0.18.0`.

package/dist/docs/reference/model/GeometryToleranceOptions.md

@@ -43,4 +43,4 @@ Dimensionless scale multiplier. Must be finite and non-negative.
 
 - [Coordinates, units, and resolution](../../guides/concepts.md#coordinates-units-and-resolution)
 
-Package: `@metamesh/modeling@0.16.0`.
+Package: `@metamesh/modeling@0.18.0`.

package/dist/docs/reference/model/GridPatternOptions.md

@@ -47,4 +47,4 @@ Optional right-handed local axes and origin for the grid.
 - [Primitive booleans and repeated placement](../../guides/recipes.md#primitive-booleans-and-repeated-placement)
 - [Fluent values and standalone algorithms](../../guides/concepts.md#choose-fluent-values-or-standalone-algorithms)
 
-Package: `@metamesh/modeling@0.16.0`.
+Package: `@metamesh/modeling@0.18.0`.

package/dist/docs/reference/model/HeightfieldOptions.md

@@ -2,7 +2,7 @@
 
 A closed rectilinear heightfield above a flat base, with uniform or explicit XY samples in millimetres.
 
-**HeightfieldOptions** = `object` & (\{ `size`: [`Vector2Data`](Vector2Data.md); `segments`: readonly \[`x`: `number`, `y`: `number`\]; `origin?`: [`Vector2Data`](Vector2Data.md); `coordinates?`: `never`; \} \| \{ `coordinates`: \{ `x`: readonly `number`[]; `y`: readonly `number`[]; \}; `size?`: `never`; `segments?`: `never`; `origin?`: `never`; \})
+**HeightfieldOptions** = `object` & (\{ `size`: [`Vector2Input`](Vector2Input.md); `segments`: readonly \[`x`: `number`, `y`: `number`\]; `origin?`: [`Vector2Input`](Vector2Input.md); `coordinates?`: `never`; \} \| \{ `coordinates`: \{ `x`: readonly `number`[]; `y`: readonly `number`[]; \}; `size?`: `never`; `segments?`: `never`; `origin?`: `never`; \})
 
 
 
@@ -63,5 +63,6 @@ All policies retain two triangles per cell; neither estimates error elsewhere in
 ## Related APIs
 
 - [Vector2Data](Vector2Data.md)
+- [Vector2Input](Vector2Input.md)
 
-Package: `@metamesh/modeling@0.16.0`.
+Package: `@metamesh/modeling@0.18.0`.

package/dist/docs/reference/model/HoleCutterOptions.md

@@ -0,0 +1,77 @@
+# HoleCutterOptions
+
+A deferred +Z hole or pocket cutter, with exactly one circular diameter or existing Section. Profile entry chamfers expand one strictly convex contour without holes by parallel-edge offsets; the supplied sampled boundary remains authoritative. Plain profile cutters accept any Section. Circular entry chamfers retain nominal circular/frustum radii under the selected radial sizing.
+
+**HoleCutterOptions** = `object` & ([`CircularPrimitiveOptions`](CircularPrimitiveOptions.md) & [`RadialSizingOptions`](RadialSizingOptions.md) & `object` & (\{ `entryChamfer?`: `number`; `recess?`: `never`; \} \| \{ `recess`: [`HoleCutterRecess`](HoleCutterRecess.md); `entryChamfer?`: `never`; \}) \| \{ `profile`: [`Section`](Section.md); `diameter?`: `never`; `recess?`: `never`; `segments?`: `never`; `sizing?`: `never`; `entryChamfer?`: `number`; \})
+
+
+
+## Type Declaration
+
+### height
+
+
+
+`readonly` **height**: `number`
+
+
+
+Positive nominal depth along +Z, starting exactly at Z=0.
+
+### face?
+
+
+
+`readonly` `optional` **face?**: `"bottom"` \| `"top"`
+
+
+
+Opening carrying the recess or entry chamfer; defaults to top.
+
+### overrun?
+
+
+
+`readonly` `optional` **overrun?**: [`HoleCutterOverrun`](HoleCutterOverrun.md)
+
+
+
+Extra length outside each nominal face; both ends default to zero.
+
+### resolution?
+
+
+
+`readonly` `optional` **resolution?**: [`GeometryResolution`](GeometryResolution.md)
+
+
+
+Operation-level physical sampling; an existing Section retains its sampled boundary.
+
+### limits?
+
+
+
+`readonly` `optional` **limits?**: `Partial`\<[`ModelingLimits`](ModelingLimits.md)\>
+
+
+
+Local allocation ceilings may only lower the evaluating host's limits.
+
+
+## Related APIs
+
+- [CircularPrimitiveOptions](CircularPrimitiveOptions.md)
+- [GeometryResolution](GeometryResolution.md)
+- [HoleCutterOverrun](HoleCutterOverrun.md)
+- [HoleCutterRecess](HoleCutterRecess.md)
+- [ModelingLimits](ModelingLimits.md)
+- [RadialSizingOptions](RadialSizingOptions.md)
+- [Section](Section.md)
+
+## Guides
+
+- [Choose a primitive](../../guides/recipes.md#choose-a-primitive)
+- [Treated boxes, frustums, and mirrored arrays](../../guides/recipes.md#treated-boxes-frustums-and-mirrored-arrays)
+
+Package: `@metamesh/modeling@0.18.0`.

package/dist/docs/reference/model/HoleCutterOverrun.md

@@ -0,0 +1,35 @@
+# HoleCutterOverrun
+
+Explicit extra cutter length outside the nominal Z=0..height interval, in millimetres.
+
+## Properties
+
+### bottom?
+
+
+
+`readonly` `optional` **bottom?**: `number`
+
+
+
+Extension below Z=0. Omitted means zero, preserving a blind pocket's floor.
+
+***
+
+### top?
+
+
+
+`readonly` `optional` **top?**: `number`
+
+
+
+Extension above Z=height. Omitted means zero.
+
+
+## Guides
+
+- [Choose a primitive](../../guides/recipes.md#choose-a-primitive)
+- [Treated boxes, frustums, and mirrored arrays](../../guides/recipes.md#treated-boxes-frustums-and-mirrored-arrays)
+
+Package: `@metamesh/modeling@0.18.0`.

package/dist/docs/reference/model/HoleCutterRecess.md

@@ -0,0 +1,87 @@
+# HoleCutterRecess
+
+Circular screw seating dimensions in millimetres; allowances belong to the caller.
+
+**HoleCutterRecess** = \{ `kind`: `"counterbore"`; `diameter`: `number`; `depth`: `number`; \} \| \{ `kind`: `"countersink"`; `diameter`: `number`; `includedAngle`: `number`; \}
+
+
+
+## Union Members
+
+### Type Literal
+
+\{ `kind`: `"counterbore"`; `diameter`: `number`; `depth`: `number`; \}
+
+#### kind
+
+
+
+`readonly` **kind**: `"counterbore"`
+
+
+
+Cylindrical seat.
+
+#### diameter
+
+
+
+`readonly` **diameter**: `number`
+
+
+
+Positive seat diameter greater than the bore, in millimetres.
+
+#### depth
+
+
+
+`readonly` **depth**: `number`
+
+
+
+Positive seat depth no greater than height, in millimetres.
+
+***
+
+### Type Literal
+
+\{ `kind`: `"countersink"`; `diameter`: `number`; `includedAngle`: `number`; \}
+
+#### kind
+
+
+
+`readonly` **kind**: `"countersink"`
+
+
+
+Conical seat.
+
+#### diameter
+
+
+
+`readonly` **diameter**: `number`
+
+
+
+Positive mouth diameter greater than the bore, in millimetres.
+
+#### includedAngle
+
+
+
+`readonly` **includedAngle**: `number`
+
+
+
+Full included angle strictly between zero and 180 degrees; derived depth must fit height.
+
+
+## Guides
+
+- [Choose a primitive](../../guides/recipes.md#choose-a-primitive)
+- [Treated boxes, frustums, and mirrored arrays](../../guides/recipes.md#treated-boxes-frustums-and-mirrored-arrays)
+
+Package: `@metamesh/modeling@0.18.0`.

package/dist/docs/reference/model/HullOptions.md

@@ -69,4 +69,4 @@ Solid input excludes point input.
 - [Choose the Boolean by the material you want](../../guides/fundamentals.md#choose-the-boolean-by-the-material-you-want)
 - [Primitive booleans and repeated placement](../../guides/recipes.md#primitive-booleans-and-repeated-placement)
 
-Package: `@metamesh/modeling@0.16.0`.
+Package: `@metamesh/modeling@0.18.0`.

package/dist/docs/reference/model/ImmutableBuffer-type.md

@@ -1,12 +1,16 @@
 # ImmutableBuffer
 
-Owned immutable numeric data. Use copy() to obtain mutable storage for numerical work.
+Owned immutable numeric data. Iterate without copying; use copy() for mutable storage.
+
+## Extends
+
+- `Iterable`\<`number`\>
 
 ## Type Parameters
 
 ### T
 
-`T` *extends* [`NumericArray`](NumericArray.md)
+`T` *extends* [`NumericArray`](../geometry/NumericArray.md)
 
 ## Properties
 
@@ -72,6 +76,26 @@ Returns a fresh mutable array of the original numeric type; never exposes cached
 
 `T`
 
+***
+
+### \[iterator\]()
+
+
+
+**\[iterator\]**(): `IterableIterator`\<`number`\>
+
+
+
+Returns an independent read-only iterator over the numeric elements without copying them.
+
+#### Returns
+
+`IterableIterator`\<`number`\>
+
+#### Overrides
+
+`Iterable.[iterator]`
+
 
 ## Related APIs
 
@@ -81,4 +105,4 @@ Returns a fresh mutable array of the original numeric type; never exposes cached
 
 - [Complete standalone model example](../../guides/standalone-model.md#minimal-model-entry)
 
-Package: `@metamesh/modeling@0.16.0`.
+Package: `@metamesh/modeling@0.18.0`.

package/dist/docs/reference/model/ImmutableTriangleMesh.md

@@ -2,13 +2,18 @@
 
 Immutable local XYZ positions and triangle indices, suitable for a computed value or part.
 
+## Extended by
+
+- [`GeometryResource`](../engine/GeometryResource.md)
+- [`ModelPart`](../engine/ModelPart.md)
+
 ## Properties
 
 ### positions
 
 
 
-`readonly` **positions**: [`ImmutableBuffer`](ImmutableBuffer-type.md)\<`Float32Array`\<`ArrayBufferLike`\>\>
+`readonly` **positions**: [`ImmutableBuffer`](../geometry/ImmutableBuffer-type.md)\<`Float32Array`\<`ArrayBufferLike`\>\>
 
 
 
@@ -20,7 +25,7 @@ Packed XYZ coordinates in millimetres.
 
 
 
-`readonly` **indices**: [`ImmutableBuffer`](ImmutableBuffer-type.md)\<`Uint32Array`\<`ArrayBufferLike`\>\>
+`readonly` **indices**: [`ImmutableBuffer`](../geometry/ImmutableBuffer-type.md)\<`Uint32Array`\<`ArrayBufferLike`\>\>
 
 
 
@@ -35,4 +40,4 @@ Zero-based vertex indices, three per triangle.
 
 - [Complete standalone model example](../../guides/standalone-model.md#minimal-model-entry)
 
-Package: `@metamesh/modeling@0.16.0`.
+Package: `@metamesh/modeling@0.18.0`.