@metamesh/cli 0.0.0-stage → 0.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +39 -0
- package/LICENSE +200 -0
- package/README.md +86 -2
- package/dist/authoring/artifacts.d.ts +15 -0
- package/dist/authoring/artifacts.d.ts.map +1 -0
- package/dist/authoring/artifacts.js +347 -0
- package/dist/authoring/artifacts.js.map +1 -0
- package/dist/authoring/capture/render-client.js +4222 -0
- package/dist/authoring/capture/render-client.js.LEGAL.txt +9 -0
- package/dist/authoring/capture/render-client.js.map +7 -0
- package/dist/authoring/check.d.ts +4 -0
- package/dist/authoring/check.d.ts.map +1 -0
- package/dist/authoring/check.js +118 -0
- package/dist/authoring/check.js.map +1 -0
- package/dist/authoring/environment.d.ts +29 -0
- package/dist/authoring/environment.d.ts.map +1 -0
- package/dist/authoring/environment.js +182 -0
- package/dist/authoring/environment.js.map +1 -0
- package/dist/authoring/errors.d.ts +13 -0
- package/dist/authoring/errors.d.ts.map +1 -0
- package/dist/authoring/errors.js +43 -0
- package/dist/authoring/errors.js.map +1 -0
- package/dist/authoring/render-client.d.ts +6 -0
- package/dist/authoring/render-client.d.ts.map +1 -0
- package/dist/authoring/render-client.js +55 -0
- package/dist/authoring/render-client.js.map +1 -0
- package/dist/authoring/render-scene.d.ts +22 -0
- package/dist/authoring/render-scene.d.ts.map +1 -0
- package/dist/authoring/render-scene.js +139 -0
- package/dist/authoring/render-scene.js.map +1 -0
- package/dist/authoring/render-types.d.ts +81 -0
- package/dist/authoring/render-types.d.ts.map +1 -0
- package/dist/authoring/render-types.js +2 -0
- package/dist/authoring/render-types.js.map +1 -0
- package/dist/authoring/render.d.ts +23 -0
- package/dist/authoring/render.d.ts.map +1 -0
- package/dist/authoring/render.js +243 -0
- package/dist/authoring/render.js.map +1 -0
- package/dist/authoring/run.d.ts +7 -0
- package/dist/authoring/run.d.ts.map +1 -0
- package/dist/authoring/run.js +308 -0
- package/dist/authoring/run.js.map +1 -0
- package/dist/authoring/types.d.ts +175 -0
- package/dist/authoring/types.d.ts.map +1 -0
- package/dist/authoring/types.js +3 -0
- package/dist/authoring/types.js.map +1 -0
- package/dist/authoring/worker.d.ts +15 -0
- package/dist/authoring/worker.d.ts.map +1 -0
- package/dist/authoring/worker.js +163 -0
- package/dist/authoring/worker.js.map +1 -0
- package/dist/authoring.d.ts +12 -0
- package/dist/authoring.d.ts.map +1 -0
- package/dist/authoring.js +9 -0
- package/dist/authoring.js.map +1 -0
- package/dist/docs/guides/agent-authoring.md +240 -0
- package/dist/docs/guides/package.md +87 -0
- package/dist/docs/manifest.json +554 -0
- package/dist/docs/reference/authoring/AUTHORING_PROTOCOL_VERSION.md +9 -0
- package/dist/docs/reference/authoring/AuthoringDiagnostic.md +22 -0
- package/dist/docs/reference/authoring/AuthoringEnvironment.md +15 -0
- package/dist/docs/reference/authoring/AuthoringError.md +16 -0
- package/dist/docs/reference/authoring/AuthoringFailure-type.md +18 -0
- package/dist/docs/reference/authoring/AuthoringKind.md +10 -0
- package/dist/docs/reference/authoring/AuthoringPhase.md +10 -0
- package/dist/docs/reference/authoring/CapturedBuffer.md +14 -0
- package/dist/docs/reference/authoring/CapturedGeometry.md +14 -0
- package/dist/docs/reference/authoring/CapturedPart.md +19 -0
- package/dist/docs/reference/authoring/CapturedResource.md +15 -0
- package/dist/docs/reference/authoring/CapturedRun.md +14 -0
- package/dist/docs/reference/authoring/CapturedRunManifest.md +40 -0
- package/dist/docs/reference/authoring/CheckOptions.md +18 -0
- package/dist/docs/reference/authoring/CheckSuccess.md +16 -0
- package/dist/docs/reference/authoring/DocumentationEntry.md +20 -0
- package/dist/docs/reference/authoring/DocumentationManifest.md +15 -0
- package/dist/docs/reference/authoring/DocumentationSearchResult.md +13 -0
- package/dist/docs/reference/authoring/InstalledAuthoringPackage.md +15 -0
- package/dist/docs/reference/authoring/RenderCamera.md +22 -0
- package/dist/docs/reference/authoring/RenderFormat.md +10 -0
- package/dist/docs/reference/authoring/RenderOptions.md +20 -0
- package/dist/docs/reference/authoring/RenderResult.md +15 -0
- package/dist/docs/reference/authoring/RenderView.md +10 -0
- package/dist/docs/reference/authoring/RenderedImage.md +23 -0
- package/dist/docs/reference/authoring/RunOptions.md +25 -0
- package/dist/docs/reference/authoring/RunSuccess.md +14 -0
- package/dist/docs/reference/authoring/authoringFailure-value.md +10 -0
- package/dist/docs/reference/authoring/checkAuthoringSource.md +10 -0
- package/dist/docs/reference/authoring/discoverAuthoringEnvironment.md +13 -0
- package/dist/docs/reference/authoring/inspectCapturedRun.md +15 -0
- package/dist/docs/reference/authoring/installAuthoringBrowser.md +13 -0
- package/dist/docs/reference/authoring/readCapturedRun.md +10 -0
- package/dist/docs/reference/authoring/renderCapturedRun.md +13 -0
- package/dist/docs/reference/authoring/runAuthoringSource.md +13 -0
- package/dist/docs/reference/authoring/searchAuthoringDocumentation.md +16 -0
- package/dist/docs/reference/authoring/showAuthoringDocumentation.md +12 -0
- package/dist/metamesh.d.ts +3 -0
- package/dist/metamesh.d.ts.map +1 -0
- package/dist/metamesh.js +183 -0
- package/dist/metamesh.js.map +1 -0
- package/package.json +63 -3
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# CapturedBuffer
|
|
2
|
+
|
|
3
|
+
A captured file's relative path, byte length, and SHA-256 integrity digest.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.14.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/** A captured file's relative path, byte length, and SHA-256 integrity digest. */
|
|
9
|
+
export interface CapturedBuffer {
|
|
10
|
+
readonly path: string;
|
|
11
|
+
readonly bytes: number;
|
|
12
|
+
readonly sha256: string;
|
|
13
|
+
}
|
|
14
|
+
```
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# CapturedGeometry
|
|
2
|
+
|
|
3
|
+
Validated local-space mesh buffers loaded from a completed captured resource.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.14.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/** Validated local-space mesh buffers loaded from a completed captured resource. */
|
|
9
|
+
export interface CapturedGeometry {
|
|
10
|
+
readonly id: string;
|
|
11
|
+
readonly positions: Float32Array;
|
|
12
|
+
readonly indices: Uint32Array;
|
|
13
|
+
}
|
|
14
|
+
```
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# CapturedPart
|
|
2
|
+
|
|
3
|
+
Semantic part identity and appearance referencing a shared mesh with separate placement.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.14.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/** Semantic part identity and appearance referencing a shared mesh with separate placement. */
|
|
9
|
+
export interface CapturedPart {
|
|
10
|
+
readonly id: string;
|
|
11
|
+
readonly resourceId: string;
|
|
12
|
+
/** World translation in millimetres, applied after rotation. */
|
|
13
|
+
readonly position: Vector3Tuple;
|
|
14
|
+
/** Global XYZ rotation in degrees, applied once to local geometry. */
|
|
15
|
+
readonly rotation: Vector3Tuple;
|
|
16
|
+
readonly color?: string;
|
|
17
|
+
readonly measurements: SnapshotPart["measurements"];
|
|
18
|
+
}
|
|
19
|
+
```
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# CapturedResource
|
|
2
|
+
|
|
3
|
+
A shared local-space mesh resource and its measurements, before per-part placement.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.14.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/** A shared local-space mesh resource and its measurements, before per-part placement. */
|
|
9
|
+
export interface CapturedResource {
|
|
10
|
+
readonly id: string;
|
|
11
|
+
readonly positions: CapturedBuffer;
|
|
12
|
+
readonly indices: CapturedBuffer;
|
|
13
|
+
readonly measurements: SnapshotPart["measurements"];
|
|
14
|
+
}
|
|
15
|
+
```
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# CapturedRun
|
|
2
|
+
|
|
3
|
+
A validated successful capture with its manifest and shared local geometry buffers.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.14.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/** A validated successful capture with its manifest and shared local geometry buffers. */
|
|
9
|
+
export interface CapturedRun {
|
|
10
|
+
readonly directory: string;
|
|
11
|
+
readonly manifest: CapturedRunManifest;
|
|
12
|
+
readonly resources: readonly CapturedGeometry[];
|
|
13
|
+
}
|
|
14
|
+
```
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# CapturedRunManifest
|
|
2
|
+
|
|
3
|
+
A completed attempt's provenance, effective inputs, diagnostics, and captured geometry.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.14.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/** A completed attempt's provenance, effective inputs, diagnostics, and captured geometry. */
|
|
9
|
+
export interface CapturedRunManifest {
|
|
10
|
+
readonly formatVersion: 1;
|
|
11
|
+
readonly status: "complete";
|
|
12
|
+
readonly runId: string;
|
|
13
|
+
readonly createdAt: string;
|
|
14
|
+
readonly kind: AuthoringKind;
|
|
15
|
+
/** Project-relative entry and fingerprint of bundled local source files. */
|
|
16
|
+
readonly source: {
|
|
17
|
+
readonly entry: string;
|
|
18
|
+
readonly fingerprint: string;
|
|
19
|
+
};
|
|
20
|
+
readonly packages: Readonly<Record<string, string>>;
|
|
21
|
+
readonly parameters: Readonly<Record<string, unknown>>;
|
|
22
|
+
/** Effective Generator font selections, or declared and byte-verified standalone fixture revisions. */
|
|
23
|
+
readonly assets: readonly {
|
|
24
|
+
readonly faceId: string;
|
|
25
|
+
readonly revision: string;
|
|
26
|
+
readonly weight: number;
|
|
27
|
+
}[];
|
|
28
|
+
readonly policy: {
|
|
29
|
+
readonly timeoutMs: number;
|
|
30
|
+
readonly limits: ModelingLimits;
|
|
31
|
+
};
|
|
32
|
+
readonly diagnostics: readonly GenerationDiagnostic[];
|
|
33
|
+
readonly bounds: Bounds3;
|
|
34
|
+
readonly stats: FinalizedModel["stats"];
|
|
35
|
+
readonly dependencies: ModelDependencies;
|
|
36
|
+
readonly resources: readonly CapturedResource[];
|
|
37
|
+
readonly parts: readonly CapturedPart[];
|
|
38
|
+
readonly export3mf?: CapturedBuffer;
|
|
39
|
+
}
|
|
40
|
+
```
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# CheckOptions
|
|
2
|
+
|
|
3
|
+
Source entry contract and project-local resolution settings for semantic checking.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.14.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/** Source entry contract and project-local resolution settings for semantic checking. */
|
|
9
|
+
export interface CheckOptions {
|
|
10
|
+
/** Entry path, resolved from project. */
|
|
11
|
+
readonly entry: string;
|
|
12
|
+
readonly kind: AuthoringKind;
|
|
13
|
+
/** Package and path resolution root; defaults to the current working directory. */
|
|
14
|
+
readonly project?: string;
|
|
15
|
+
/** Explicit configuration path relative to project; otherwise the entry's nearest tsconfig is used. */
|
|
16
|
+
readonly tsconfig?: string;
|
|
17
|
+
}
|
|
18
|
+
```
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# CheckSuccess
|
|
2
|
+
|
|
3
|
+
A successful semantic check; source has not been evaluated and no geometry is captured.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.14.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/** A successful semantic check; source has not been evaluated and no geometry is captured. */
|
|
9
|
+
export interface CheckSuccess {
|
|
10
|
+
readonly success: true;
|
|
11
|
+
readonly entry: string;
|
|
12
|
+
readonly kind: AuthoringKind;
|
|
13
|
+
readonly tsconfig?: string;
|
|
14
|
+
readonly diagnostics: readonly AuthoringDiagnostic[];
|
|
15
|
+
}
|
|
16
|
+
```
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# DocumentationEntry
|
|
2
|
+
|
|
3
|
+
Metadata for one installed Markdown guide or public API symbol.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.14.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/** Metadata for one installed Markdown guide or public API symbol. */
|
|
9
|
+
export interface DocumentationEntry {
|
|
10
|
+
readonly id: string;
|
|
11
|
+
readonly title: string;
|
|
12
|
+
readonly summary: string;
|
|
13
|
+
/** Forward-slash relative path beside the owning documentation manifest. */
|
|
14
|
+
readonly path: string;
|
|
15
|
+
readonly importPath: string;
|
|
16
|
+
readonly availability: string;
|
|
17
|
+
readonly canonical: string;
|
|
18
|
+
readonly keywords: readonly string[];
|
|
19
|
+
}
|
|
20
|
+
```
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# DocumentationManifest
|
|
2
|
+
|
|
3
|
+
Exact-package-version index exposed through the package's docs/manifest.json export.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.14.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/** Exact-package-version index exposed through the package's docs/manifest.json export. */
|
|
9
|
+
export interface DocumentationManifest {
|
|
10
|
+
readonly formatVersion: 1;
|
|
11
|
+
readonly packageName: string;
|
|
12
|
+
readonly packageVersion: string;
|
|
13
|
+
readonly documents: readonly DocumentationEntry[];
|
|
14
|
+
}
|
|
15
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# DocumentationSearchResult
|
|
2
|
+
|
|
3
|
+
An installed documentation match carrying the exact package identity that owns it.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.14.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/** An installed documentation match carrying the exact package identity that owns it. */
|
|
9
|
+
export interface DocumentationSearchResult extends DocumentationEntry {
|
|
10
|
+
readonly packageName: string;
|
|
11
|
+
readonly packageVersion: string;
|
|
12
|
+
}
|
|
13
|
+
```
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# InstalledAuthoringPackage
|
|
2
|
+
|
|
3
|
+
A project-local MetaMesh package and its verified documentation index.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.14.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/** A project-local MetaMesh package and its verified documentation index. */
|
|
9
|
+
export interface InstalledAuthoringPackage {
|
|
10
|
+
readonly name: string;
|
|
11
|
+
readonly version: string;
|
|
12
|
+
readonly manifestPath: string;
|
|
13
|
+
readonly documentCount: number;
|
|
14
|
+
}
|
|
15
|
+
```
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# RenderCamera
|
|
2
|
+
|
|
3
|
+
Recorded orthographic camera, expressed in millimetres and world coordinates.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.14.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/** Recorded orthographic camera, expressed in millimetres and world coordinates. */
|
|
9
|
+
export interface RenderCamera {
|
|
10
|
+
readonly position: readonly [number, number, number];
|
|
11
|
+
readonly target: readonly [number, number, number];
|
|
12
|
+
readonly up: readonly [number, number, number];
|
|
13
|
+
readonly frustum: {
|
|
14
|
+
readonly left: number;
|
|
15
|
+
readonly right: number;
|
|
16
|
+
readonly top: number;
|
|
17
|
+
readonly bottom: number;
|
|
18
|
+
readonly near: number;
|
|
19
|
+
readonly far: number;
|
|
20
|
+
};
|
|
21
|
+
}
|
|
22
|
+
```
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# RenderOptions
|
|
2
|
+
|
|
3
|
+
Options for rendering a previously captured model, without executing author code.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.14.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/** Options for rendering a previously captured model, without executing author code. */
|
|
9
|
+
export interface RenderOptions {
|
|
10
|
+
readonly views?: readonly RenderView[];
|
|
11
|
+
readonly width?: number;
|
|
12
|
+
readonly height?: number;
|
|
13
|
+
readonly format?: RenderFormat;
|
|
14
|
+
readonly background?: "transparent" | `#${string}`;
|
|
15
|
+
/** Parent for a new unique capture directory; defaults to the run's renders directory. */
|
|
16
|
+
readonly outputDirectory?: string;
|
|
17
|
+
/** Browser startup, page readiness, and capture deadline; defaults to 30 seconds. */
|
|
18
|
+
readonly timeoutMs?: number;
|
|
19
|
+
}
|
|
20
|
+
```
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# RenderResult
|
|
2
|
+
|
|
3
|
+
Images always belong to one captured run and one unique output directory.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.14.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/** Images always belong to one captured run and one unique output directory. */
|
|
9
|
+
export interface RenderResult {
|
|
10
|
+
readonly runId: string;
|
|
11
|
+
readonly sourceFingerprint: string;
|
|
12
|
+
readonly directory: string;
|
|
13
|
+
readonly images: readonly RenderedImage[];
|
|
14
|
+
}
|
|
15
|
+
```
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# RenderView
|
|
2
|
+
|
|
3
|
+
Standard orthographic views in MetaMesh's Z-up coordinate system.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.14.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/** Standard orthographic views in MetaMesh's Z-up coordinate system. */
|
|
9
|
+
export type RenderView = "isometric" | "front" | "top" | "right";
|
|
10
|
+
```
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# RenderedImage
|
|
2
|
+
|
|
3
|
+
A view and its provenance, also written beside the image as JSON.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.14.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/** A view and its provenance, also written beside the image as JSON. */
|
|
9
|
+
export interface RenderedImage {
|
|
10
|
+
readonly path: string;
|
|
11
|
+
readonly metadataPath: string;
|
|
12
|
+
readonly runId: string;
|
|
13
|
+
readonly sourceFingerprint: string;
|
|
14
|
+
readonly view: RenderView;
|
|
15
|
+
readonly width: number;
|
|
16
|
+
readonly height: number;
|
|
17
|
+
readonly format: RenderFormat;
|
|
18
|
+
readonly background: string;
|
|
19
|
+
readonly camera: RenderCamera;
|
|
20
|
+
readonly rendererRevision: string;
|
|
21
|
+
readonly browserVersion: string;
|
|
22
|
+
}
|
|
23
|
+
```
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# RunOptions
|
|
2
|
+
|
|
3
|
+
Inputs and bounded execution policy for one checked, trusted local source attempt.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.14.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/** Inputs and bounded execution policy for one checked, trusted local source attempt. */
|
|
9
|
+
export interface RunOptions extends CheckOptions {
|
|
10
|
+
/** Generator overrides merged with definition defaults, or the standalone model's raw parameter map. */
|
|
11
|
+
readonly params?: Readonly<Record<string, unknown>>;
|
|
12
|
+
/** Local font descriptor JSON path relative to project; no assets are downloaded. */
|
|
13
|
+
readonly fontFixtures?: string;
|
|
14
|
+
/** Parent for a unique attempt directory; defaults to .metamesh/runs beneath project. */
|
|
15
|
+
readonly output?: string;
|
|
16
|
+
/** Child execution deadline in milliseconds, from 1 to 3600000; defaults to 30000. */
|
|
17
|
+
readonly timeoutMs?: number;
|
|
18
|
+
/** Engine resource ceilings may be lowered from their defaults, never raised. */
|
|
19
|
+
readonly limits?: Partial<ModelingLimits>;
|
|
20
|
+
/** Export the completed snapshot as 3MF in this run; defaults to false. */
|
|
21
|
+
readonly export3mf?: boolean;
|
|
22
|
+
/** Receives combined child stdout/stderr, truncated after 64 KiB. */
|
|
23
|
+
readonly onLog?: (text: string) => void;
|
|
24
|
+
}
|
|
25
|
+
```
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# RunSuccess
|
|
2
|
+
|
|
3
|
+
A successful checked execution; use this exact directory for subsequent inspection and rendering.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.14.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/** A successful checked execution; use this exact directory for subsequent inspection and rendering. */
|
|
9
|
+
export interface RunSuccess {
|
|
10
|
+
readonly success: true;
|
|
11
|
+
readonly runDirectory: string;
|
|
12
|
+
readonly manifest: CapturedRunManifest;
|
|
13
|
+
}
|
|
14
|
+
```
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# authoringFailure
|
|
2
|
+
|
|
3
|
+
Converts a thrown value to a failure envelope, preserving classified authoring diagnostics.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.14.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/** Converts a thrown value to a failure envelope, preserving classified authoring diagnostics. */
|
|
9
|
+
export declare function authoringFailure(error: unknown, fallbackPhase?: AuthoringPhase): AuthoringFailure;
|
|
10
|
+
```
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# checkAuthoringSource
|
|
2
|
+
|
|
3
|
+
Checks strict TypeScript and the selected entry-module contract without evaluating author source.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.14.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/** Checks strict TypeScript and the selected entry-module contract without evaluating author source. */
|
|
9
|
+
export declare function checkAuthoringSource(options: CheckOptions): Promise<CheckSuccess | AuthoringFailure>;
|
|
10
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# discoverAuthoringEnvironment
|
|
2
|
+
|
|
3
|
+
Discovers project-local Modeling, CLI, and optional SDK/Testkit documentation. Rejects missing required packages, stale manifests, and mixed exact package versions.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.14.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/**
|
|
9
|
+
* Discovers project-local Modeling, CLI, and optional SDK/Testkit documentation.
|
|
10
|
+
* Rejects missing required packages, stale manifests, and mixed exact package versions.
|
|
11
|
+
*/
|
|
12
|
+
export declare function discoverAuthoringEnvironment(project?: string): Promise<AuthoringEnvironment>;
|
|
13
|
+
```
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# inspectCapturedRun
|
|
2
|
+
|
|
3
|
+
Validates a completed capture and returns its manifest with an optional semantic part selection. Original source is never evaluated; incomplete captures and unknown part IDs reject.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.14.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/**
|
|
9
|
+
* Validates a completed capture and returns its manifest with an optional semantic part selection.
|
|
10
|
+
* Original source is never evaluated; incomplete captures and unknown part IDs reject.
|
|
11
|
+
*/
|
|
12
|
+
export declare function inspectCapturedRun(directory: string, partId?: string): Promise<Omit<CapturedRun, "resources"> & {
|
|
13
|
+
readonly selectedPart?: CapturedPart;
|
|
14
|
+
}>;
|
|
15
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# installAuthoringBrowser
|
|
2
|
+
|
|
3
|
+
Explicit installation of this package's pinned Chromium. Never called by render.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.14.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/** Explicit installation of this package's pinned Chromium. Never called by render. */
|
|
9
|
+
export declare function installAuthoringBrowser(): Promise<{
|
|
10
|
+
browser: "chromium";
|
|
11
|
+
executablePath: string;
|
|
12
|
+
}>;
|
|
13
|
+
```
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# readCapturedRun
|
|
2
|
+
|
|
3
|
+
Reads only immutable captured files. It never imports or executes original author source.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.14.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/** Reads only immutable captured files. It never imports or executes original author source. */
|
|
9
|
+
export declare function readCapturedRun(directory: string): Promise<CapturedRun>;
|
|
10
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# renderCapturedRun
|
|
2
|
+
|
|
3
|
+
Render validated persisted local geometry and placements. Source code is never imported, and a fresh capture directory prevents overlapping calls from overwriting evidence.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.14.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/**
|
|
9
|
+
* Render validated persisted local geometry and placements. Source code is never imported,
|
|
10
|
+
* and a fresh capture directory prevents overlapping calls from overwriting evidence.
|
|
11
|
+
*/
|
|
12
|
+
export declare function renderCapturedRun(directory: string, options?: RenderOptions): Promise<RenderResult>;
|
|
13
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# runAuthoringSource
|
|
2
|
+
|
|
3
|
+
Checks and executes trusted local source in a disposable child, then captures its finalized geometry. Returns a success or failure envelope for this fresh attempt; failed attempts cannot be rendered.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.14.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/**
|
|
9
|
+
* Checks and executes trusted local source in a disposable child, then captures its finalized geometry.
|
|
10
|
+
* Returns a success or failure envelope for this fresh attempt; failed attempts cannot be rendered.
|
|
11
|
+
*/
|
|
12
|
+
export declare function runAuthoringSource(options: RunOptions): Promise<RunSuccess | AuthoringFailure>;
|
|
13
|
+
```
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# searchAuthoringDocumentation
|
|
2
|
+
|
|
3
|
+
Ranks installed topic and symbol metadata without loading every document's body. Returns up to limit matches, defaulting to 10; supported limits are 1 through 50.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.14.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/**
|
|
9
|
+
* Ranks installed topic and symbol metadata without loading every document's body.
|
|
10
|
+
* Returns up to limit matches, defaulting to 10; supported limits are 1 through 50.
|
|
11
|
+
*/
|
|
12
|
+
export declare function searchAuthoringDocumentation(query: string, options?: {
|
|
13
|
+
readonly project?: string;
|
|
14
|
+
readonly limit?: number;
|
|
15
|
+
}): Promise<readonly DocumentationSearchResult[]>;
|
|
16
|
+
```
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# showAuthoringDocumentation
|
|
2
|
+
|
|
3
|
+
Reads one exact-version installed Markdown topic by its discovered ID, without executing source.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.14.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/** Reads one exact-version installed Markdown topic by its discovered ID, without executing source. */
|
|
9
|
+
export declare function showAuthoringDocumentation(id: string, project?: string): Promise<DocumentationSearchResult & {
|
|
10
|
+
readonly markdown: string;
|
|
11
|
+
}>;
|
|
12
|
+
```
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"metamesh.d.ts","sourceRoot":"","sources":["../src/metamesh.ts"],"names":[],"mappings":""}
|