@metamesh/modeling 0.11.0 → 0.13.0

package/dist/docs/reference/engine/SessionOptions.md

@@ -0,0 +1,123 @@
+# SessionOptions
+
+Fixed generation policy and deterministic host capabilities for one model session.
+
+## Extends
+
+- [`GenerationOptions`](GenerationOptions.md)
+
+## Type Parameters
+
+### S
+
+`S` = `Record`\<`never`, `never`\>
+
+## Properties
+
+### meshValidation?
+
+
+
+`readonly` `optional` **meshValidation?**: `"topology"` \| `"solid"`
+
+
+
+Optional bounded intersection and nested-shell checks; defaults to indexed topology validation.
+
+#### Inherited from
+
+[`GenerationOptions`](GenerationOptions.md).[`meshValidation`](GenerationOptions.md#meshvalidation)
+
+***
+
+### limits?
+
+
+
+`readonly` `optional` **limits?**: `Partial`\<[`ModelingLimits`](../model/ModelingLimits.md)\>
+
+
+
+Per-build limits, no larger than the configured engine ceilings.
+
+#### Inherited from
+
+[`GenerationOptions`](GenerationOptions.md).[`limits`](GenerationOptions.md#limits)
+
+***
+
+### resolution?
+
+
+
+`readonly` `optional` **resolution?**: [`GeometryResolution`](../model/GeometryResolution.md)
+
+
+
+Physical sampling defaults; operation options and exact counts override these.
+
+#### Inherited from
+
+[`GenerationOptions`](GenerationOptions.md).[`resolution`](GenerationOptions.md#resolution)
+
+***
+
+### meshTopologyMode?
+
+
+
+`readonly` `optional` **meshTopologyMode?**: `"original"` \| `"optimized"`
+
+
+
+Optional bounded planar cleanup; unsupported candidates preserve the original part.
+
+#### Inherited from
+
+[`GenerationOptions`](GenerationOptions.md).[`meshTopologyMode`](GenerationOptions.md#meshtopologymode)
+
+***
+
+### services?
+
+
+
+`readonly` `optional` **services?**: `S`
+
+
+
+Host-owned synchronous capabilities, required when declared by the program. The original
+environment is retained; its behavior and assets must remain deterministic and fixed for
+this session. Equivalent function wrappers do not constitute an asset revision.
+
+***
+
+### cache?
+
+
+
+`readonly` `optional` **cache?**: `boolean`
+
+
+
+Enables reuse; defaults to true. Set false for uncached output equivalence checks.
+
+***
+
+### verifyCache?
+
+
+
+`readonly` `optional` **verifyCache?**: `boolean`
+
+
+
+Development-only cache-hit probe: reruns pure callbacks and compares bounded data/recipes.
+Unsupported closures or large results fail explicitly; this cannot prove arbitrary JavaScript.
+
+
+## Related APIs
+
+- [GenerationOptions](GenerationOptions.md)
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/engine/SnapshotPart.md

@@ -0,0 +1,130 @@
+# SnapshotPart
+
+A world-space manufacturing part plus its reusable local renderer resource.
+
+## Extends
+
+- [`FinalizedPart`](../model/FinalizedPart.md)
+
+## Properties
+
+### geometry
+
+
+
+`readonly` **geometry**: [`GeometryResource`](GeometryResource.md)
+
+
+
+Validated geometry in local coordinates, independent of placement and appearance.
+
+***
+
+### position
+
+
+
+`readonly` **position**: [`Vector3`](../model/Vector3.md)
+
+
+
+XYZ translation in millimetres after rotation.
+
+***
+
+### rotation
+
+
+
+`readonly` **rotation**: [`Vector3`](../model/Vector3.md)
+
+
+
+Fixed global X, then Y, then Z rotation in degrees.
+
+***
+
+### id
+
+
+
+`readonly` **id**: `string`
+
+
+
+Stable canonical lowercase identity; unique within the containing topology or output.
+
+#### Inherited from
+
+[`FinalizedPart`](../model/FinalizedPart.md).[`id`](../model/FinalizedPart.md#id)
+
+***
+
+### color?
+
+
+
+`readonly` `optional` **color?**: `string`
+
+
+
+Optional six-digit hex RGB display color.
+
+#### Inherited from
+
+[`FinalizedPart`](../model/FinalizedPart.md).[`color`](../model/FinalizedPart.md#color)
+
+***
+
+### measurements
+
+
+
+`readonly` **measurements**: [`TriangleMeshAnalysis`](../model/TriangleMeshAnalysis.md)
+
+
+
+Fresh validated facts for these exact finalized buffers.
+
+#### Inherited from
+
+[`FinalizedPart`](../model/FinalizedPart.md).[`measurements`](../model/FinalizedPart.md#measurements)
+
+***
+
+### indices
+
+
+
+`readonly` **indices**: `Uint32Array`
+
+
+
+Three unsigned vertex indices per triangle.
+
+#### Inherited from
+
+[`FinalizedPart`](../model/FinalizedPart.md).[`indices`](../model/FinalizedPart.md#indices)
+
+***
+
+### positions
+
+
+
+`readonly` **positions**: `Float32Array`
+
+
+
+Flat XYZ coordinates, three finite values per vertex.
+
+#### Inherited from
+
+[`FinalizedPart`](../model/FinalizedPart.md).[`positions`](../model/FinalizedPart.md#positions)
+
+
+## Related APIs
+
+- [GeometryResource](GeometryResource.md)
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/engine/categories/host-lifecycle.md

@@ -0,0 +1,37 @@
+# Host lifecycle
+
+Initialize, configure, finalize, and export through one engine.
+
+Create one engine in Node or a Worker, then create isolated sessions from generate() programs. run is synchronous; native allocation starts on demand and is always disposed. Snapshot parts contain reusable local geometry and authoritative world-space output. Session disposal releases caches while captured snapshots remain valid; dispose each snapshot when no longer used. Trusted ceilings apply even on cache hits. validateModel probes cheap declarations without a kernel; geometry observations use session.validate. verifyCache is an optional bounded development probe, not a proof of arbitrary JavaScript dependencies.
+
+## Functions
+
+| API | Summary |
+| --- | --- |
+| [createModelEngine](../createModelEngine.md) | Initializes one host kernel and returns a lifecycle-safe engine. No generator initializes WASM. |
+| [validateModel](../validateModel.md) | Runs declaration and immediate assertions without initializing a kernel or finalizing parts. Geometry observations require an initialized session's `validate` method instead. |
+
+## Interfaces
+
+| API | Summary |
+| --- | --- |
+| [GenerationOptions](../GenerationOptions.md) | Execution settings supplied by the host, independently of generator metadata. |
+| [Export3mfOptions](../Export3mfOptions.md) | Completed-snapshot serialization settings; filename selection belongs to the host. |
+| [ExportMeshPart](../ExportMeshPart.md) | Manufacturing buffers accepted by the snapshot exporter. |
+| [ModelEngine](../ModelEngine.md) | Host engine. No native values or manually disposable handles are exposed. |
+| [ModelEngineOptions](../ModelEngineOptions.md) | Kernel asset initialization. Networking and Worker ownership remain with the host. |
+| [GeometryResource](../GeometryResource.md) | Validated local geometry resource; accessors return owned buffer copies. |
+| [ModelDependencies](../ModelDependencies.md) | Known dependencies for inspection; plain JavaScript bindings do not reveal their parameter origin. |
+| [ModelSession](../ModelSession.md) | Stateful execution owner; a failed revision cannot change previously returned snapshots. |
+| [ModelSnapshot](../ModelSnapshot.md) | Captured immutable revision; disposal never changes another snapshot or an in-flight export. |
+| [SessionOptions](../SessionOptions.md) | Fixed generation policy and deterministic host capabilities for one model session. |
+| [SnapshotPart](../SnapshotPart.md) | A world-space manufacturing part plus its reusable local renderer resource. |
+
+## Values
+
+| API | Summary |
+| --- | --- |
+| [defaultModelingLimits](../defaultModelingLimits.md) | Default host resource ceilings for parts, vertices, triangles, and transferable bytes. |
+| [modelingWasmUrl](../modelingWasmUrl.md) | URL of the package's pinned WASM asset; browser bundlers may replace it with their emitted URL. |
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/engine/createModelEngine.md

@@ -0,0 +1,56 @@
+# createModelEngine
+
+Initializes one host kernel and returns a lifecycle-safe engine. No generator initializes WASM.
+
+**createModelEngine**(`options?`: [`ModelEngineOptions`](ModelEngineOptions.md)): `Promise`\<[`ModelEngine`](ModelEngine.md)\>
+
+
+
+## Example: Build a box in a host application
+
+```ts
+import { box, generate } from "@metamesh/modeling";
+import { createModelEngine } from "@metamesh/modeling/engine";
+
+const engine = await createModelEngine();
+const model = generate<Record<never, never>>(({ part }) => [part("body", box({ size: [30, 20, 8] }))]);
+const session = engine.createSession(model);
+try {
+  const snapshot = session.run({});
+  try {
+    await engine.export3mf(snapshot.parts);
+  } finally {
+    snapshot.dispose();
+  }
+} finally {
+  session.dispose();
+}
+```
+
+## Parameters
+
+<a id="options"></a>
+
+**`options`** · [`ModelEngineOptions`](ModelEngineOptions.md) · Optional
+
+- [`locateFile`](ModelEngineOptions.md#locatefile) · () => `string` · Optional
+
+  Resolves the kernel's WASM asset. Browser hosts supply their bundled asset URL.
+
+- [`limits`](ModelEngineOptions.md#limits) · `Partial`\<[`ModelingLimits`](../model/ModelingLimits.md)\> · Optional
+
+  Trusted application ceilings. Builds may lower them; generators receive no engine.
+
+
+
+## Returns
+
+`Promise`\<[`ModelEngine`](ModelEngine.md)\>
+
+
+## Related APIs
+
+- [ModelEngine](ModelEngine.md)
+- [ModelEngineOptions](ModelEngineOptions.md)
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/engine/defaultModelingLimits.md

@@ -0,0 +1,7 @@
+# defaultModelingLimits
+
+Default host resource ceilings for parts, vertices, triangles, and transferable bytes.
+
+`const` **defaultModelingLimits**: `Readonly`\<[`ModelingLimits`](../model/ModelingLimits.md)\>
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/engine/modelingWasmUrl.md

@@ -0,0 +1,7 @@
+# modelingWasmUrl
+
+URL of the package's pinned WASM asset; browser bundlers may replace it with their emitted URL.
+
+`const` **modelingWasmUrl**: `string`
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/engine/validateModel.md

@@ -0,0 +1,48 @@
+# validateModel
+
+Runs declaration and immediate assertions without initializing a kernel or finalizing parts. Geometry observations require an initialized session's `validate` method instead.
+
+**validateModel**\<`P`, `S`\>(`program`: [`ModelProgram`](../model/ModelProgram.md)\<`P`, `S`\>, `params`: `Readonly`\<`P`\>, ...`settings`: keyof `S` *extends* `never` ? \[`options?`: [`SessionOptions`](SessionOptions.md)\<`S`\>\] : \[`options`: [`SessionOptions`](SessionOptions.md)\<`S`\> & `object`\]): readonly [`GenerationDiagnostic`](../model/GenerationDiagnostic.md)[]
+
+
+
+## Type Parameters
+
+### P
+
+`P`
+
+### S
+
+`S`
+
+## Parameters
+
+<a id="program"></a>
+
+**`program`** · [`ModelProgram`](../model/ModelProgram.md)\<`P`, `S`\> · Required
+
+
+
+<a id="params"></a>
+
+**`params`** · `Readonly`\<`P`\> · Required
+
+
+
+<a id="settings"></a>
+
+**`...settings`** · keyof `S` *extends* `never` ? \[`options?`: [`SessionOptions`](SessionOptions.md)\<`S`\>\] : \[`options`: [`SessionOptions`](SessionOptions.md)\<`S`\> & `object`\] · Required
+
+
+
+## Returns
+
+readonly [`GenerationDiagnostic`](../model/GenerationDiagnostic.md)[]
+
+
+## Related APIs
+
+- [SessionOptions](SessionOptions.md)
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/engine.md

@@ -0,0 +1,25 @@
+# Engine API
+
+Initialize one host engine, run synchronous models, finalize bounded manufacturing snapshots, and export selected parts.
+
+Import host initialization from `@metamesh/modeling/engine`. One engine creates isolated model sessions, finalizes bounded manufacturing snapshots, and disposes native allocations on every exit.
+
+```ts
+import { box, generate } from "@metamesh/modeling";
+import { createModelEngine } from "@metamesh/modeling/engine";
+const engine = await createModelEngine();
+const model = generate<Record<never, never>>(({ part }) => [part("body", box({ size: 20 }))]);
+const session = engine.createSession(model);
+const snapshot = session.run({});
+const bytes = await engine.export3mf(snapshot.parts, { name: "Block" });
+snapshot.dispose();
+session.dispose();
+```
+
+Node resolves installed WASM automatically. Browser hosts may supply an emitted URL through `locateFile`. Generation is synchronous and cannot nest in one realm. Exports capture already finalized world geometry before awaiting and never rerun the program. Hosts own Workers, revisions, appearance, persistence, and delivery.
+
+## Categories
+
+- [Host lifecycle](engine/categories/host-lifecycle.md) — Initialize, configure, finalize, and export through one engine.
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/geometry/AcmeThreadProfileSpec.md

@@ -0,0 +1,75 @@
+# AcmeThreadProfileSpec
+
+ACME 29-degree included-angle profile.
+
+## Extends
+
+- [`ThreadProfileBaseSpec`](ThreadProfileBaseSpec.md)
+
+## Properties
+
+### kind
+
+
+
+`readonly` **kind**: `"acme"`
+
+
+
+Selects the 29-degree ACME profile family.
+
+***
+
+### depth?
+
+
+
+`readonly` `optional` **depth?**: `number`
+
+
+
+Radial depth in millimetres.
+
+#### Default Value
+
+`pitch / 2`
+
+***
+
+### pitch
+
+
+
+`readonly` **pitch**: `number`
+
+
+
+Adjacent axial thread spacing in millimetres.
+
+#### Inherited from
+
+[`ThreadProfileBaseSpec`](ThreadProfileBaseSpec.md).[`pitch`](ThreadProfileBaseSpec.md#pitch)
+
+***
+
+### tolerance?
+
+
+
+`readonly` `optional` **tolerance?**: [`GeometryToleranceOptions`](GeometryToleranceOptions.md)
+
+
+
+Optional numerical tolerance overrides.
+
+#### Inherited from
+
+[`ThreadProfileBaseSpec`](ThreadProfileBaseSpec.md).[`tolerance`](ThreadProfileBaseSpec.md#tolerance)
+
+
+## Related APIs
+
+- [GeometryToleranceOptions](GeometryToleranceOptions.md)
+- [ThreadProfileBaseSpec](ThreadProfileBaseSpec.md)
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/geometry/AlignedCircularSegmentsOptions.md

@@ -0,0 +1,79 @@
+# AlignedCircularSegmentsOptions
+
+Controls full-circle sampling that must satisfy one or more topology alignments.
+
+## Properties
+
+### alignTo
+
+
+
+`readonly` **alignTo**: readonly `number`[]
+
+
+
+Non-empty alignment factors. Every value must be a positive safe integer; the returned count
+is divisible by their checked least common multiple.
+
+***
+
+### limits?
+
+
+
+`readonly` `optional` **limits?**: `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\>
+
+
+
+Explicit sampling allocation ceilings.
+
+***
+
+### minimumSegments?
+
+
+
+`readonly` `optional` **minimumSegments?**: `number`
+
+
+
+Additional full-circle segment floor, as a safe integer of at least three.
+
+#### Default Value
+
+`3`
+
+***
+
+### segments?
+
+
+
+`readonly` `optional` **segments?**: `number`
+
+
+
+Exact full-circle segment count.
+
+This takes precedence over `resolution.circularSegments` and adaptive sampling, and must
+already satisfy every alignment factor and `minimumSegments`.
+
+***
+
+### resolution?
+
+
+
+`readonly` `optional` **resolution?**: [`GeometryResolution`](GeometryResolution.md)
+
+
+
+Operation-level physical tessellation policy over the active model-wide policy.
+
+
+## Related APIs
+
+- [GeometryResolution](GeometryResolution.md)
+- [GeometrySamplingLimits](GeometrySamplingLimits.md)
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/geometry/Anchor3.md

@@ -0,0 +1,49 @@
+# Anchor3
+
+An attachment pose on a solid or assembly.
+
+`direction` is the outward attachment normal. `up` controls roll and must not
+be parallel to `direction`; anchor construction projects and normalizes it.
+
+## Properties
+
+### direction
+
+
+
+`readonly` **direction**: [`Vector3`](Vector3.md)
+
+
+
+Unit outward normal used as the anchor's local +Z direction.
+
+***
+
+### position
+
+
+
+`readonly` **position**: [`Vector3`](Vector3.md)
+
+
+
+World-space attachment position.
+
+***
+
+### up
+
+
+
+`readonly` **up**: [`Vector3`](Vector3.md)
+
+
+
+Roll guide projected into the plane perpendicular to `direction`.
+
+
+## Related APIs
+
+- [Vector3](Vector3.md)
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/geometry/ArcCurve2.md

@@ -0,0 +1,70 @@
+# ArcCurve2
+
+Planar circular arc with counterclockwise degree angles.
+
+## Properties
+
+### kind
+
+
+
+`readonly` **kind**: `"arc"`
+
+
+
+Selects a circular arc in the XY plane.
+
+***
+
+### center
+
+
+
+`readonly` **center**: [`Vector2`](Vector2.md)
+
+
+
+Circle center in millimetres.
+
+***
+
+### radius
+
+
+
+`readonly` **radius**: `number`
+
+
+
+Positive circular radius in millimetres.
+
+***
+
+### startDegrees?
+
+
+
+`readonly` `optional` **startDegrees?**: `number`
+
+
+
+Initial angle in degrees; defaults to zero.
+
+***
+
+### sweepDegrees
+
+
+
+`readonly` **sweepDegrees**: `number`
+
+
+
+Nonzero signed sweep in degrees, bounded to one complete turn.
+
+
+## Related APIs
+
+- [Vector2](Vector2.md)
+
+Package: `@metamesh/modeling@0.13.0`.