@metamesh/modeling 0.17.0 → 0.19.0

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

@@ -81,7 +81,14 @@ Full included angle strictly between zero and 180 degrees; derived depth must fi
 
 ## 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)
+- [Choose a primitive](../../guides/profiles-and-extrusion.md#choose-a-primitive)
+- [Treated boxes, frustums, and mirrored arrays](../../guides/profiles-and-extrusion.md#treated-boxes-frustums-and-mirrored-arrays)
+- [Finish a profile with a hole](../../guides/profiles-and-extrusion.md#finish-a-profile-with-a-hole)
 
-Package: `@metamesh/modeling@0.17.0`.
+## Supported imports
+
+```ts
+import type { HoleCutterRecess } from "@metamesh/modeling";
+```
+
+Package: `@metamesh/modeling@0.19.0`.

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

@@ -2,7 +2,7 @@
 
 Hull inputs are either finite points or solid recipes.
 
-**HullOptions** = \{ `points`: readonly [`Vector3Input`](Vector3Input.md)[]; `solids?`: `never`; \} \| \{ `solids`: readonly [`Solid`](Solid.md)[]; `points?`: `never`; \}
+**HullOptions** = \{ `points`: readonly [`Vector3Input`](../geometry/Vector3Input.md)[]; `solids?`: `never`; \} \| \{ `solids`: readonly [`Solid`](Solid.md)[]; `points?`: `never`; \}
 
 
 
@@ -10,13 +10,13 @@ Hull inputs are either finite points or solid recipes.
 
 ### Type Literal
 
-\{ `points`: readonly [`Vector3Input`](Vector3Input.md)[]; `solids?`: `never`; \}
+\{ `points`: readonly [`Vector3Input`](../geometry/Vector3Input.md)[]; `solids?`: `never`; \}
 
 #### points
 
 
 
-`readonly` **points**: readonly [`Vector3Input`](Vector3Input.md)[]
+`readonly` **points**: readonly [`Vector3Input`](../geometry/Vector3Input.md)[]
 
 
 
@@ -62,11 +62,18 @@ Solid input excludes point input.
 ## Related APIs
 
 - [Solid](Solid.md)
-- [Vector3Input](Vector3Input.md)
+- [Vector3Input](../geometry/Vector3Input.md)
 
 ## Guides
 
 - [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)
+- [Primitive booleans and repeated placement](../../guides/transforms-and-placement.md#primitive-booleans-and-repeated-placement)
+- [Join an independently modeled feature](../../guides/solid-joins.md#join-an-independently-modeled-feature)
 
-Package: `@metamesh/modeling@0.17.0`.
+## Supported imports
+
+```ts
+import type { HullOptions } from "@metamesh/modeling";
+```
+
+Package: `@metamesh/modeling@0.19.0`.

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

@@ -0,0 +1,26 @@
+# ImmutableValue
+
+Deeply readonly view of captured generation data, including nested arrays and tuples. Modeling value methods keep their signatures, including explicit mutable copies. This type does not make unsupported runtime values valid generation data.
+
+**ImmutableValue**\<`T`\> = `T` *extends* (...`args`: `never`[]) => `unknown` ? `T` : `T` *extends* `object` ? `{ readonly [Key in keyof T]: ImmutableValue<T[Key]> }` : `T`
+
+
+
+## Type Parameters
+
+### T
+
+`T`
+
+
+## Guides
+
+- [Complete standalone model example](../../guides/standalone-model.md#minimal-model-entry)
+
+## Supported imports
+
+```ts
+import type { ImmutableValue } from "@metamesh/modeling";
+```
+
+Package: `@metamesh/modeling@0.19.0`.

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

@@ -8,7 +8,7 @@ Positive-inside sampling, bounded to 4M native BCC grid slots and 8M field calls
 
 
 
-`readonly` **field**: (`point`: [`Vector3Data`](Vector3Data.md)) => `number`
+`readonly` **field**: (`point`: [`Vector3Data`](../geometry/Vector3Data.md)) => `number`
 
 
 
@@ -18,7 +18,7 @@ Positive-inside scalar field evaluated at finite XYZ points.
 
 <a id="point"></a>
 
-**`point`** · [`Vector3Data`](Vector3Data.md) · Required
+**`point`** · [`Vector3Data`](../geometry/Vector3Data.md) · Required
 
 
 
@@ -32,7 +32,7 @@ Positive-inside scalar field evaluated at finite XYZ points.
 
 
 
-`readonly` **bounds**: [`Bounds3Data`](Bounds3Data.md)
+`readonly` **bounds**: [`Bounds3Data`](../geometry/Bounds3Data.md)
 
 
 
@@ -77,7 +77,13 @@ Positive native geometric tolerance in millimetres; omitted uses interpolated gr
 
 ## Related APIs
 
-- [Bounds3Data](Bounds3Data.md)
-- [Vector3Data](Vector3Data.md)
+- [Bounds3Data](../geometry/Bounds3Data.md)
+- [Vector3Data](../geometry/Vector3Data.md)
 
-Package: `@metamesh/modeling@0.17.0`.
+## Supported imports
+
+```ts
+import type { ImplicitOptions } from "@metamesh/modeling";
+```
+
+Package: `@metamesh/modeling@0.19.0`.

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

@@ -0,0 +1,76 @@
+# JoinOptions
+
+Options for joining two positioned solids through a validated local straight feature collar.
+
+## Properties
+
+### source
+
+
+
+`readonly` **source**: `string` \| [`Anchor3`](../geometry/Anchor3-type.md)
+
+
+
+Outward feature-root datum, pointing toward the base. Names resolve lazily on the feature;
+explicit anchors use the operands' shared modeling coordinates. The collar grows opposite
+this direction, with its roll fixed by the anchor's up vector. Every collar section cut
+by the source plane participates, including disconnected roots.
+
+***
+
+### transition
+
+
+
+`readonly` **transition**: [`JoinTransition`](JoinTransition.md)
+
+
+
+Both dimensions must be positive, or both zero to validate contact and fuse without a blend.
+
+***
+
+### resolution?
+
+
+
+`readonly` `optional` **resolution?**: [`GeometryResolution`](../geometry/GeometryResolution.md)
+
+
+
+Physical connection sampling. Input solids retain their own captured sampling.
+
+***
+
+### limits?
+
+
+
+`readonly` `optional` **limits?**: `Partial`\<[`ModelingLimits`](../geometry/ModelingLimits.md)\>
+
+
+
+Local allocation ceilings may only lower the evaluating host's limits.
+
+
+## Related APIs
+
+- [Anchor3](../geometry/Anchor3-type.md)
+- [GeometryResolution](../geometry/GeometryResolution.md)
+- [JoinTransition](JoinTransition.md)
+- [ModelingLimits](../geometry/ModelingLimits.md)
+
+## Guides
+
+- [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/transforms-and-placement.md#primitive-booleans-and-repeated-placement)
+- [Join an independently modeled feature](../../guides/solid-joins.md#join-an-independently-modeled-feature)
+
+## Supported imports
+
+```ts
+import type { JoinOptions } from "@metamesh/modeling";
+```
+
+Package: `@metamesh/modeling@0.19.0`.

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

@@ -0,0 +1,54 @@
+# JoinTransition
+
+Connection profile and setbacks, independent of feature construction.
+
+## Properties
+
+### kind?
+
+
+
+`readonly` `optional` **kind?**: `"smooth"` \| `"straight"`
+
+
+
+Tangent-matching cubic or linear profile. Defaults to "smooth"; neither specifies a radius.
+
+***
+
+### width
+
+
+
+`readonly` **width**: `number`
+
+
+
+Nonnegative parallel-edge normal offset in millimetres perpendicular to the feature collar axis.
+
+***
+
+### height
+
+
+
+`readonly` **height**: `number`
+
+
+
+Nonnegative axial rise in millimetres above the local support contact.
+
+
+## Guides
+
+- [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/transforms-and-placement.md#primitive-booleans-and-repeated-placement)
+- [Join an independently modeled feature](../../guides/solid-joins.md#join-an-independently-modeled-feature)
+
+## Supported imports
+
+```ts
+import type { JoinTransition } from "@metamesh/modeling";
+```
+
+Package: `@metamesh/modeling@0.19.0`.

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

@@ -32,7 +32,7 @@ Alternating B intervals with a face-sized running bore.
 
 
 
-`readonly` **axis**: [`Anchor3`](Anchor3.md)
+`readonly` **axis**: [`Anchor3`](../geometry/Anchor3-type.md)
 
 
 
@@ -41,7 +41,13 @@ Centered +X pin axis with +Z roll guide; opening and lift-off withdrawal are cal
 
 ## Related APIs
 
-- [Anchor3](Anchor3.md)
+- [Anchor3](../geometry/Anchor3-type.md)
 - [Solid](Solid.md)
 
-Package: `@metamesh/modeling@0.17.0`.
+## Supported imports
+
+```ts
+import type { KnuckleHinge } from "@metamesh/modeling";
+```
+
+Package: `@metamesh/modeling@0.19.0`.

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

@@ -35,4 +35,10 @@ web reach and knuckle length must exceed `2 * Math.SQRT2 * chamfer` to retain th
 
 - [KnuckleHingeWeb](KnuckleHingeWeb.md)
 
-Package: `@metamesh/modeling@0.17.0`.
+## Supported imports
+
+```ts
+import type { KnuckleHingeHalfOptions } from "@metamesh/modeling";
+```
+
+Package: `@metamesh/modeling@0.19.0`.

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

@@ -2,7 +2,7 @@
 
 Joint declaration with independent attachments; unspecified sampling inherits the evaluating host.
 
-**KnuckleHingeOptions** = [`KnuckleHingeSpec`](KnuckleHingeSpec.md) & [`KnuckleHingeSamplingOptions`](KnuckleHingeSamplingOptions.md) & `object`
+**KnuckleHingeOptions** = [`KnuckleHingeSpec`](../geometry/KnuckleHingeSpec.md) & [`KnuckleHingeSamplingOptions`](../geometry/KnuckleHingeSamplingOptions.md) & `object`
 
 
 
@@ -32,7 +32,13 @@ Optional attachment and edge treatment for B, which always carries a running bor
 ## Related APIs
 
 - [KnuckleHingeHalfOptions](KnuckleHingeHalfOptions.md)
-- [KnuckleHingeSamplingOptions](KnuckleHingeSamplingOptions.md)
-- [KnuckleHingeSpec](KnuckleHingeSpec.md)
+- [KnuckleHingeSamplingOptions](../geometry/KnuckleHingeSamplingOptions.md)
+- [KnuckleHingeSpec](../geometry/KnuckleHingeSpec.md)
 
-Package: `@metamesh/modeling@0.17.0`.
+## Supported imports
+
+```ts
+import type { KnuckleHingeOptions } from "@metamesh/modeling";
+```
+
+Package: `@metamesh/modeling@0.19.0`.

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

@@ -50,4 +50,10 @@ Lower-face Z coordinate in the pin-centered frame, in millimetres. Must overlap
 
 Positive thickness along +Z. Each web spans its own barrel interval.
 
-Package: `@metamesh/modeling@0.17.0`.
+## Supported imports
+
+```ts
+import type { KnuckleHingeWeb } from "@metamesh/modeling";
+```
+
+Package: `@metamesh/modeling@0.19.0`.

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

@@ -2,7 +2,7 @@
 
 A Section or point loop at an explicit height or frame.
 
-**LoftStation** = [`LoftPlacement`](LoftPlacement.md) & `object`
+**LoftStation** = [`LoftPlacement`](../geometry/LoftPlacement.md) & `object`
 
 
 
@@ -12,7 +12,7 @@ A Section or point loop at an explicit height or frame.
 
 
 
-`readonly` **profile**: [`Section`](Section.md) \| [`Path2Input`](Path2Input.md)
+`readonly` **profile**: [`Section`](Section.md) \| [`Path2Input`](../geometry/Path2Input.md)
 
 
 
@@ -21,15 +21,22 @@ Filled Section recipe or ordered XY boundary point data.
 
 ## Related APIs
 
-- [LoftPlacement](LoftPlacement.md)
-- [Path2Input](Path2Input.md)
+- [LoftPlacement](../geometry/LoftPlacement.md)
+- [Path2Input](../geometry/Path2Input.md)
 - [Section](Section.md)
 
 ## Guides
 
-- [Revolve a radial profile](../../guides/recipes.md#revolve-a-radial-profile)
-- [Rotation-minimizing path sweep](../../guides/recipes.md#rotation-minimizing-path-sweep)
-- [Matched-section loft](../../guides/recipes.md#matched-section-loft)
-- [Choose a modeling path](../../guides/concepts.md#choose-a-modeling-path)
+- [Finish a profile with a hole](../../guides/profiles-and-extrusion.md#finish-a-profile-with-a-hole)
+- [Revolve a radial profile](../../guides/profiles-and-extrusion.md#revolve-a-radial-profile)
+- [Rotation-minimizing path sweep](../../guides/sweeps-and-lofts.md#rotation-minimizing-path-sweep)
+- [Matched-section loft](../../guides/sweeps-and-lofts.md#matched-section-loft)
+- [Choose a modeling path](../../guides/recipes.md#choose-a-technique)
 
-Package: `@metamesh/modeling@0.17.0`.
+## Supported imports
+
+```ts
+import type { LoftStation } from "@metamesh/modeling";
+```
+
+Package: `@metamesh/modeling@0.19.0`.

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

@@ -0,0 +1,54 @@
+# Memo
+
+Invokes fn(...args) and returns captured immutable data. Stable helpers reuse work across runs. Arguments compare with Object.is and must be deeply immutable; the exact current params or generation context instead tracks parameter fields read by the function. Functions must be pure: supply changing inputs explicitly, and do not read changing globals or ambient state.
+
+Eagerly reuses pure synchronous functions by function identity and immutable arguments.
+
+
+
+**Memo**\<`Args` *extends* readonly `unknown`[], `Result`\>(`fn`: (...`args`: `Args`) => `Result`, ...`args`: `Args`): [`ImmutableValue`](ImmutableValue.md)\<`Result`\>
+
+
+
+## Type Parameters
+
+### Args
+
+`Args` *extends* readonly `unknown`[]
+
+### Result
+
+`Result`
+
+## Parameters
+
+### fn
+
+(...`args`: `Args`) => `Result`
+
+<a id="args"></a>
+
+**`...args`** · `Args` · Required
+
+
+
+## Returns
+
+[`ImmutableValue`](ImmutableValue.md)\<`Result`\>
+
+
+## Related APIs
+
+- [ImmutableValue](ImmutableValue.md)
+
+## Guides
+
+- [Complete standalone model example](../../guides/standalone-model.md#minimal-model-entry)
+
+## Supported imports
+
+```ts
+import type { Memo } from "@metamesh/modeling";
+```
+
+Package: `@metamesh/modeling@0.19.0`.

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

@@ -6,7 +6,7 @@ Stateless portable program descriptor. Execution and caches belong to an engine
 
 ### P
 
-`P`
+`P` *extends* `object`
 
 ### S
 
@@ -45,4 +45,10 @@ Typed synchronous declaration callback.
 
 - [Complete standalone model example](../../guides/standalone-model.md#minimal-model-entry)
 
-Package: `@metamesh/modeling@0.17.0`.
+## Supported imports
+
+```ts
+import type { ModelProgram } from "@metamesh/modeling";
+```
+
+Package: `@metamesh/modeling@0.19.0`.

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

@@ -0,0 +1,87 @@
+# PartDeclaration
+
+One declared output part. Construct with the context's `part` helper.
+
+## Extends
+
+- [`PartOptions`](PartOptions.md)
+
+## Properties
+
+### id
+
+
+
+`readonly` **id**: `string`
+
+
+
+Unique canonical lowercase hyphen-separated identity, at most 64 characters.
+
+***
+
+### geometry
+
+
+
+`readonly` **geometry**: [`PartGeometry`](PartGeometry.md)
+
+
+
+Local manufacturing geometry; native objects never cross a revision.
+
+#### Inherited from
+
+[`PartOptions`](PartOptions.md).[`geometry`](PartOptions.md#geometry)
+
+***
+
+### transform?
+
+
+
+`readonly` `optional` **transform?**: [`Transform3Input`](../geometry/Transform3Input.md)
+
+
+
+Rigid local-to-world transform; translation uses millimetres. Defaults to identity.
+Accepts a fluent transform or row-major 4x4 matrix. Scale, shear, and reflection are invalid.
+
+#### Inherited from
+
+[`PartOptions`](PartOptions.md).[`transform`](PartOptions.md#transform)
+
+***
+
+### color?
+
+
+
+`readonly` `optional` **color?**: `string`
+
+
+
+Optional six-digit hexadecimal semantic part color.
+
+#### Inherited from
+
+[`PartOptions`](PartOptions.md).[`color`](PartOptions.md#color)
+
+
+## Related APIs
+
+- [PartGeometry](PartGeometry.md)
+- [PartOptions](PartOptions.md)
+- [Transform3Input](../geometry/Transform3Input.md)
+
+## Guides
+
+- [Complete standalone model example](../../guides/standalone-model.md#minimal-model-entry)
+
+## Supported imports
+
+```ts
+import type { PartDeclaration } from "@metamesh/modeling";
+```
+
+Package: `@metamesh/modeling@0.19.0`.

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

@@ -2,19 +2,25 @@
 
 Manufacturing geometry; filled sections are intermediate construction values.
 
-**PartGeometry** = [`Solid`](Solid.md) \| [`TriangleMesh`](TriangleMesh.md) \| [`ImmutableTriangleMesh`](ImmutableTriangleMesh.md)
+**PartGeometry** = [`Solid`](Solid.md) \| [`TriangleMesh`](../geometry/TriangleMesh.md) \| [`ImmutableTriangleMesh`](../geometry/ImmutableTriangleMesh.md)
 
 
 
 
 ## Related APIs
 
-- [ImmutableTriangleMesh](ImmutableTriangleMesh.md)
+- [ImmutableTriangleMesh](../geometry/ImmutableTriangleMesh.md)
 - [Solid](Solid.md)
-- [TriangleMesh](TriangleMesh.md)
+- [TriangleMesh](../geometry/TriangleMesh.md)
 
 ## Guides
 
 - [Complete standalone model example](../../guides/standalone-model.md#minimal-model-entry)
 
-Package: `@metamesh/modeling@0.17.0`.
+## Supported imports
+
+```ts
+import type { PartGeometry } from "@metamesh/modeling";
+```
+
+Package: `@metamesh/modeling@0.19.0`.

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

@@ -4,7 +4,7 @@ Appearance and rigid placement of a finished local manufacturing part.
 
 ## Extended by
 
-- [`GeneratedPart`](GeneratedPart.md)
+- [`PartDeclaration`](PartDeclaration.md)
 
 ## Properties
 
@@ -12,35 +12,24 @@ Appearance and rigid placement of a finished local manufacturing part.
 
 
 
-`readonly` **geometry**: [`ComputedValue`](ComputedValue.md)\<[`PartGeometry`](PartGeometry.md)\>
+`readonly` **geometry**: [`PartGeometry`](PartGeometry.md)
 
 
 
-Local geometry or a lazy reader; native objects never cross a revision.
+Local manufacturing geometry; native objects never cross a revision.
 
 ***
 
-### position?
+### transform?
 
 
 
-`readonly` `optional` **position?**: [`ComputedValue`](ComputedValue.md)\<[`Vector3Input`](Vector3Input.md)\>
+`readonly` `optional` **transform?**: [`Transform3Input`](../geometry/Transform3Input.md)
 
 
 
-XYZ vector or tuple translation in millimetres, applied after rotation; defaults to zero.
-
-***
-
-### rotation?
-
-
-
-`readonly` `optional` **rotation?**: [`ComputedValue`](ComputedValue.md)\<[`Vector3Input`](Vector3Input.md)\>
-
-
-
-XYZ vector or tuple of fixed global X, Y, Z rotations in degrees; defaults to zero.
+Rigid local-to-world transform; translation uses millimetres. Defaults to identity.
+Accepts a fluent transform or row-major 4x4 matrix. Scale, shear, and reflection are invalid.
 
 ***
 
@@ -57,13 +46,18 @@ Optional six-digit hexadecimal semantic part color.
 
 ## Related APIs
 
-- [ComputedValue](ComputedValue.md)
-- [GeneratedPart](GeneratedPart.md)
+- [PartDeclaration](PartDeclaration.md)
 - [PartGeometry](PartGeometry.md)
-- [Vector3Input](Vector3Input.md)
+- [Transform3Input](../geometry/Transform3Input.md)
 
 ## Guides
 
 - [Complete standalone model example](../../guides/standalone-model.md#minimal-model-entry)
 
-Package: `@metamesh/modeling@0.17.0`.
+## Supported imports
+
+```ts
+import type { PartOptions } from "@metamesh/modeling";
+```
+
+Package: `@metamesh/modeling@0.19.0`.

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

@@ -20,8 +20,14 @@ One immutable shape, or a synchronous factory called once per copy in index orde
 
 ## Guides
 
-- [Named anchors and custom frames](../../guides/recipes.md#named-anchors-and-custom-frames)
-- [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)
+- [Named anchors and custom frames](../../guides/transforms-and-placement.md#named-anchors-and-custom-frames)
+- [Primitive booleans and repeated placement](../../guides/transforms-and-placement.md#primitive-booleans-and-repeated-placement)
+- [Fluent values and standalone algorithms](../../guides/geometry-values.md#choose-fluent-values-or-standalone-algorithms)
 
-Package: `@metamesh/modeling@0.17.0`.
+## Supported imports
+
+```ts
+import type { PatternSource } from "@metamesh/modeling";
+```
+
+Package: `@metamesh/modeling@0.19.0`.