@metamesh/cli 0.13.0 → 0.15.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 +63 -0
- package/README.md +22 -7
- package/dist/authoring/artifacts.d.ts +4 -0
- package/dist/authoring/artifacts.d.ts.map +1 -1
- package/dist/authoring/artifacts.js +31 -18
- package/dist/authoring/artifacts.js.map +1 -1
- package/dist/authoring/check.d.ts +1 -0
- package/dist/authoring/check.d.ts.map +1 -1
- package/dist/authoring/check.js +14 -1
- package/dist/authoring/check.js.map +1 -1
- package/dist/authoring/environment.d.ts +10 -0
- package/dist/authoring/environment.d.ts.map +1 -1
- package/dist/authoring/environment.js +9 -0
- package/dist/authoring/environment.js.map +1 -1
- package/dist/authoring/errors.d.ts +2 -0
- package/dist/authoring/errors.d.ts.map +1 -1
- package/dist/authoring/errors.js +2 -0
- package/dist/authoring/errors.js.map +1 -1
- package/dist/authoring/render.js +2 -2
- package/dist/authoring/render.js.map +1 -1
- package/dist/authoring/run.d.ts +4 -0
- package/dist/authoring/run.d.ts.map +1 -1
- package/dist/authoring/run.js +4 -0
- package/dist/authoring/run.js.map +1 -1
- package/dist/authoring/types.d.ts +40 -3
- package/dist/authoring/types.d.ts.map +1 -1
- package/dist/authoring/types.js +1 -0
- package/dist/authoring/types.js.map +1 -1
- package/dist/docs/guides/agent-authoring.md +64 -7
- package/dist/docs/guides/package.md +22 -7
- package/dist/docs/manifest.json +29 -29
- package/dist/docs/reference/authoring/AUTHORING_PROTOCOL_VERSION.md +2 -2
- package/dist/docs/reference/authoring/AuthoringDiagnostic.md +5 -2
- package/dist/docs/reference/authoring/AuthoringEnvironment.md +3 -2
- package/dist/docs/reference/authoring/AuthoringError.md +3 -2
- package/dist/docs/reference/authoring/AuthoringFailure-type.md +5 -2
- package/dist/docs/reference/authoring/AuthoringKind.md +3 -2
- package/dist/docs/reference/authoring/AuthoringPhase.md +3 -2
- package/dist/docs/reference/authoring/CapturedBuffer.md +3 -2
- package/dist/docs/reference/authoring/CapturedGeometry.md +3 -2
- package/dist/docs/reference/authoring/CapturedPart.md +7 -4
- package/dist/docs/reference/authoring/CapturedResource.md +3 -2
- package/dist/docs/reference/authoring/CapturedRun.md +3 -2
- package/dist/docs/reference/authoring/CapturedRunManifest.md +4 -2
- package/dist/docs/reference/authoring/CheckOptions.md +6 -2
- package/dist/docs/reference/authoring/CheckSuccess.md +3 -2
- package/dist/docs/reference/authoring/DocumentationEntry.md +4 -2
- package/dist/docs/reference/authoring/DocumentationManifest.md +3 -2
- package/dist/docs/reference/authoring/DocumentationSearchResult.md +3 -2
- package/dist/docs/reference/authoring/InstalledAuthoringPackage.md +3 -2
- package/dist/docs/reference/authoring/RenderCamera.md +1 -1
- package/dist/docs/reference/authoring/RenderFormat.md +1 -1
- package/dist/docs/reference/authoring/RenderOptions.md +1 -1
- package/dist/docs/reference/authoring/RenderResult.md +1 -1
- package/dist/docs/reference/authoring/RenderView.md +1 -1
- package/dist/docs/reference/authoring/RenderedImage.md +1 -1
- package/dist/docs/reference/authoring/RunOptions.md +10 -2
- package/dist/docs/reference/authoring/RunSuccess.md +3 -2
- package/dist/docs/reference/authoring/authoringFailure-value.md +3 -2
- package/dist/docs/reference/authoring/checkAuthoringSource.md +3 -2
- package/dist/docs/reference/authoring/discoverAuthoringEnvironment.md +6 -2
- package/dist/docs/reference/authoring/inspectCapturedRun.md +6 -2
- package/dist/docs/reference/authoring/installAuthoringBrowser.md +1 -1
- package/dist/docs/reference/authoring/readCapturedRun.md +1 -1
- package/dist/docs/reference/authoring/renderCapturedRun.md +1 -1
- package/dist/docs/reference/authoring/runAuthoringSource.md +6 -2
- package/dist/docs/reference/authoring/searchAuthoringDocumentation.md +6 -2
- package/dist/docs/reference/authoring/showAuthoringDocumentation.md +3 -2
- package/dist/metamesh.js +9 -3
- package/dist/metamesh.js.map +1 -1
- package/package.json +6 -6
package/dist/docs/manifest.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"formatVersion": 1,
|
|
3
3
|
"packageName": "@metamesh/cli",
|
|
4
|
-
"packageVersion": "0.
|
|
4
|
+
"packageVersion": "0.15.0",
|
|
5
5
|
"documents": [
|
|
6
6
|
{
|
|
7
7
|
"id": "cli/guide/agent-authoring",
|
|
@@ -35,7 +35,7 @@
|
|
|
35
35
|
{
|
|
36
36
|
"id": "cli/reference/authoring/AUTHORING_PROTOCOL_VERSION",
|
|
37
37
|
"title": "AUTHORING_PROTOCOL_VERSION",
|
|
38
|
-
"summary": "
|
|
38
|
+
"summary": "Version of the CLI authoring protocol, independent of package SemVer and engine compatibility.",
|
|
39
39
|
"path": "reference/authoring/AUTHORING_PROTOCOL_VERSION.md",
|
|
40
40
|
"importPath": "@metamesh/cli/authoring",
|
|
41
41
|
"availability": "Local Node authoring",
|
|
@@ -49,7 +49,7 @@
|
|
|
49
49
|
{
|
|
50
50
|
"id": "cli/reference/authoring/AuthoringDiagnostic",
|
|
51
51
|
"title": "AuthoringDiagnostic",
|
|
52
|
-
"summary": "
|
|
52
|
+
"summary": "A structured issue with optional source location, parameter association, and geometry context.",
|
|
53
53
|
"path": "reference/authoring/AuthoringDiagnostic.md",
|
|
54
54
|
"importPath": "@metamesh/cli/authoring",
|
|
55
55
|
"availability": "Local Node authoring",
|
|
@@ -63,7 +63,7 @@
|
|
|
63
63
|
{
|
|
64
64
|
"id": "cli/reference/authoring/AuthoringEnvironment",
|
|
65
65
|
"title": "AuthoringEnvironment",
|
|
66
|
-
"summary": "
|
|
66
|
+
"summary": "The selected project's supported protocol, matching package releases, and available workflows.",
|
|
67
67
|
"path": "reference/authoring/AuthoringEnvironment.md",
|
|
68
68
|
"importPath": "@metamesh/cli/authoring",
|
|
69
69
|
"availability": "Local Node authoring",
|
|
@@ -77,7 +77,7 @@
|
|
|
77
77
|
{
|
|
78
78
|
"id": "cli/reference/authoring/AuthoringError",
|
|
79
79
|
"title": "AuthoringError",
|
|
80
|
-
"summary": "
|
|
80
|
+
"summary": "A classified authoring exception retaining its workflow phase, stable code, and exit status.",
|
|
81
81
|
"path": "reference/authoring/AuthoringError.md",
|
|
82
82
|
"importPath": "@metamesh/cli/authoring",
|
|
83
83
|
"availability": "Local Node authoring",
|
|
@@ -91,7 +91,7 @@
|
|
|
91
91
|
{
|
|
92
92
|
"id": "cli/reference/authoring/authoringFailure",
|
|
93
93
|
"title": "authoringFailure",
|
|
94
|
-
"summary": "
|
|
94
|
+
"summary": "Converts a thrown value to a failure envelope, preserving classified authoring diagnostics.",
|
|
95
95
|
"path": "reference/authoring/authoringFailure-value.md",
|
|
96
96
|
"importPath": "@metamesh/cli/authoring",
|
|
97
97
|
"availability": "Local Node authoring",
|
|
@@ -105,7 +105,7 @@
|
|
|
105
105
|
{
|
|
106
106
|
"id": "cli/reference/authoring/AuthoringFailure",
|
|
107
107
|
"title": "AuthoringFailure",
|
|
108
|
-
"summary": "
|
|
108
|
+
"summary": "An unsuccessful command outcome; a failure directory does not establish a complete capture.",
|
|
109
109
|
"path": "reference/authoring/AuthoringFailure-type.md",
|
|
110
110
|
"importPath": "@metamesh/cli/authoring",
|
|
111
111
|
"availability": "Local Node authoring",
|
|
@@ -119,7 +119,7 @@
|
|
|
119
119
|
{
|
|
120
120
|
"id": "cli/reference/authoring/AuthoringKind",
|
|
121
121
|
"title": "AuthoringKind",
|
|
122
|
-
"summary": "
|
|
122
|
+
"summary": "Selects a standalone ModelProgram entry or an SDK Generator module with a definition.",
|
|
123
123
|
"path": "reference/authoring/AuthoringKind.md",
|
|
124
124
|
"importPath": "@metamesh/cli/authoring",
|
|
125
125
|
"availability": "Local Node authoring",
|
|
@@ -133,7 +133,7 @@
|
|
|
133
133
|
{
|
|
134
134
|
"id": "cli/reference/authoring/AuthoringPhase",
|
|
135
135
|
"title": "AuthoringPhase",
|
|
136
|
-
"summary": "
|
|
136
|
+
"summary": "The workflow stage that rejected an invocation, source, asset, or captured artifact.",
|
|
137
137
|
"path": "reference/authoring/AuthoringPhase.md",
|
|
138
138
|
"importPath": "@metamesh/cli/authoring",
|
|
139
139
|
"availability": "Local Node authoring",
|
|
@@ -147,7 +147,7 @@
|
|
|
147
147
|
{
|
|
148
148
|
"id": "cli/reference/authoring/CapturedBuffer",
|
|
149
149
|
"title": "CapturedBuffer",
|
|
150
|
-
"summary": "
|
|
150
|
+
"summary": "A captured file's relative path, byte length, and SHA-256 integrity digest.",
|
|
151
151
|
"path": "reference/authoring/CapturedBuffer.md",
|
|
152
152
|
"importPath": "@metamesh/cli/authoring",
|
|
153
153
|
"availability": "Local Node authoring",
|
|
@@ -161,7 +161,7 @@
|
|
|
161
161
|
{
|
|
162
162
|
"id": "cli/reference/authoring/CapturedGeometry",
|
|
163
163
|
"title": "CapturedGeometry",
|
|
164
|
-
"summary": "
|
|
164
|
+
"summary": "Validated local-space mesh buffers loaded from a completed captured resource.",
|
|
165
165
|
"path": "reference/authoring/CapturedGeometry.md",
|
|
166
166
|
"importPath": "@metamesh/cli/authoring",
|
|
167
167
|
"availability": "Local Node authoring",
|
|
@@ -175,7 +175,7 @@
|
|
|
175
175
|
{
|
|
176
176
|
"id": "cli/reference/authoring/CapturedPart",
|
|
177
177
|
"title": "CapturedPart",
|
|
178
|
-
"summary": "
|
|
178
|
+
"summary": "Semantic part identity and appearance referencing a shared mesh with separate placement.",
|
|
179
179
|
"path": "reference/authoring/CapturedPart.md",
|
|
180
180
|
"importPath": "@metamesh/cli/authoring",
|
|
181
181
|
"availability": "Local Node authoring",
|
|
@@ -189,7 +189,7 @@
|
|
|
189
189
|
{
|
|
190
190
|
"id": "cli/reference/authoring/CapturedResource",
|
|
191
191
|
"title": "CapturedResource",
|
|
192
|
-
"summary": "
|
|
192
|
+
"summary": "A shared local-space mesh resource and its measurements, before per-part placement.",
|
|
193
193
|
"path": "reference/authoring/CapturedResource.md",
|
|
194
194
|
"importPath": "@metamesh/cli/authoring",
|
|
195
195
|
"availability": "Local Node authoring",
|
|
@@ -203,7 +203,7 @@
|
|
|
203
203
|
{
|
|
204
204
|
"id": "cli/reference/authoring/CapturedRun",
|
|
205
205
|
"title": "CapturedRun",
|
|
206
|
-
"summary": "
|
|
206
|
+
"summary": "A validated successful capture with its manifest and shared local geometry buffers.",
|
|
207
207
|
"path": "reference/authoring/CapturedRun.md",
|
|
208
208
|
"importPath": "@metamesh/cli/authoring",
|
|
209
209
|
"availability": "Local Node authoring",
|
|
@@ -217,7 +217,7 @@
|
|
|
217
217
|
{
|
|
218
218
|
"id": "cli/reference/authoring/CapturedRunManifest",
|
|
219
219
|
"title": "CapturedRunManifest",
|
|
220
|
-
"summary": "
|
|
220
|
+
"summary": "A completed attempt's provenance, effective inputs, diagnostics, and captured geometry.",
|
|
221
221
|
"path": "reference/authoring/CapturedRunManifest.md",
|
|
222
222
|
"importPath": "@metamesh/cli/authoring",
|
|
223
223
|
"availability": "Local Node authoring",
|
|
@@ -231,7 +231,7 @@
|
|
|
231
231
|
{
|
|
232
232
|
"id": "cli/reference/authoring/checkAuthoringSource",
|
|
233
233
|
"title": "checkAuthoringSource",
|
|
234
|
-
"summary": "
|
|
234
|
+
"summary": "Checks strict TypeScript and the selected entry-module contract without evaluating author source.",
|
|
235
235
|
"path": "reference/authoring/checkAuthoringSource.md",
|
|
236
236
|
"importPath": "@metamesh/cli/authoring",
|
|
237
237
|
"availability": "Local Node authoring",
|
|
@@ -245,7 +245,7 @@
|
|
|
245
245
|
{
|
|
246
246
|
"id": "cli/reference/authoring/CheckOptions",
|
|
247
247
|
"title": "CheckOptions",
|
|
248
|
-
"summary": "
|
|
248
|
+
"summary": "Source entry contract and project-local resolution settings for semantic checking.",
|
|
249
249
|
"path": "reference/authoring/CheckOptions.md",
|
|
250
250
|
"importPath": "@metamesh/cli/authoring",
|
|
251
251
|
"availability": "Local Node authoring",
|
|
@@ -259,7 +259,7 @@
|
|
|
259
259
|
{
|
|
260
260
|
"id": "cli/reference/authoring/CheckSuccess",
|
|
261
261
|
"title": "CheckSuccess",
|
|
262
|
-
"summary": "
|
|
262
|
+
"summary": "A successful semantic check; source has not been evaluated and no geometry is captured.",
|
|
263
263
|
"path": "reference/authoring/CheckSuccess.md",
|
|
264
264
|
"importPath": "@metamesh/cli/authoring",
|
|
265
265
|
"availability": "Local Node authoring",
|
|
@@ -273,7 +273,7 @@
|
|
|
273
273
|
{
|
|
274
274
|
"id": "cli/reference/authoring/discoverAuthoringEnvironment",
|
|
275
275
|
"title": "discoverAuthoringEnvironment",
|
|
276
|
-
"summary": "
|
|
276
|
+
"summary": "Discovers project-local Modeling, CLI, and optional SDK/Testkit documentation. Rejects missing required packages, stale manifests, and mixed exact package versions.",
|
|
277
277
|
"path": "reference/authoring/discoverAuthoringEnvironment.md",
|
|
278
278
|
"importPath": "@metamesh/cli/authoring",
|
|
279
279
|
"availability": "Local Node authoring",
|
|
@@ -287,7 +287,7 @@
|
|
|
287
287
|
{
|
|
288
288
|
"id": "cli/reference/authoring/DocumentationEntry",
|
|
289
289
|
"title": "DocumentationEntry",
|
|
290
|
-
"summary": "
|
|
290
|
+
"summary": "Metadata for one installed Markdown guide or public API symbol.",
|
|
291
291
|
"path": "reference/authoring/DocumentationEntry.md",
|
|
292
292
|
"importPath": "@metamesh/cli/authoring",
|
|
293
293
|
"availability": "Local Node authoring",
|
|
@@ -301,7 +301,7 @@
|
|
|
301
301
|
{
|
|
302
302
|
"id": "cli/reference/authoring/DocumentationManifest",
|
|
303
303
|
"title": "DocumentationManifest",
|
|
304
|
-
"summary": "
|
|
304
|
+
"summary": "Exact-package-version index exposed through the package's docs/manifest.json export.",
|
|
305
305
|
"path": "reference/authoring/DocumentationManifest.md",
|
|
306
306
|
"importPath": "@metamesh/cli/authoring",
|
|
307
307
|
"availability": "Local Node authoring",
|
|
@@ -315,7 +315,7 @@
|
|
|
315
315
|
{
|
|
316
316
|
"id": "cli/reference/authoring/DocumentationSearchResult",
|
|
317
317
|
"title": "DocumentationSearchResult",
|
|
318
|
-
"summary": "
|
|
318
|
+
"summary": "An installed documentation match carrying the exact package identity that owns it.",
|
|
319
319
|
"path": "reference/authoring/DocumentationSearchResult.md",
|
|
320
320
|
"importPath": "@metamesh/cli/authoring",
|
|
321
321
|
"availability": "Local Node authoring",
|
|
@@ -329,7 +329,7 @@
|
|
|
329
329
|
{
|
|
330
330
|
"id": "cli/reference/authoring/inspectCapturedRun",
|
|
331
331
|
"title": "inspectCapturedRun",
|
|
332
|
-
"summary": "
|
|
332
|
+
"summary": "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.",
|
|
333
333
|
"path": "reference/authoring/inspectCapturedRun.md",
|
|
334
334
|
"importPath": "@metamesh/cli/authoring",
|
|
335
335
|
"availability": "Local Node authoring",
|
|
@@ -357,7 +357,7 @@
|
|
|
357
357
|
{
|
|
358
358
|
"id": "cli/reference/authoring/InstalledAuthoringPackage",
|
|
359
359
|
"title": "InstalledAuthoringPackage",
|
|
360
|
-
"summary": "
|
|
360
|
+
"summary": "A project-local MetaMesh package and its verified documentation index.",
|
|
361
361
|
"path": "reference/authoring/InstalledAuthoringPackage.md",
|
|
362
362
|
"importPath": "@metamesh/cli/authoring",
|
|
363
363
|
"availability": "Local Node authoring",
|
|
@@ -483,7 +483,7 @@
|
|
|
483
483
|
{
|
|
484
484
|
"id": "cli/reference/authoring/runAuthoringSource",
|
|
485
485
|
"title": "runAuthoringSource",
|
|
486
|
-
"summary": "
|
|
486
|
+
"summary": "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.",
|
|
487
487
|
"path": "reference/authoring/runAuthoringSource.md",
|
|
488
488
|
"importPath": "@metamesh/cli/authoring",
|
|
489
489
|
"availability": "Local Node authoring",
|
|
@@ -497,7 +497,7 @@
|
|
|
497
497
|
{
|
|
498
498
|
"id": "cli/reference/authoring/RunOptions",
|
|
499
499
|
"title": "RunOptions",
|
|
500
|
-
"summary": "
|
|
500
|
+
"summary": "Inputs and bounded execution policy for one checked, trusted local source attempt.",
|
|
501
501
|
"path": "reference/authoring/RunOptions.md",
|
|
502
502
|
"importPath": "@metamesh/cli/authoring",
|
|
503
503
|
"availability": "Local Node authoring",
|
|
@@ -511,7 +511,7 @@
|
|
|
511
511
|
{
|
|
512
512
|
"id": "cli/reference/authoring/RunSuccess",
|
|
513
513
|
"title": "RunSuccess",
|
|
514
|
-
"summary": "
|
|
514
|
+
"summary": "A successful checked execution; use this exact directory for subsequent inspection and rendering.",
|
|
515
515
|
"path": "reference/authoring/RunSuccess.md",
|
|
516
516
|
"importPath": "@metamesh/cli/authoring",
|
|
517
517
|
"availability": "Local Node authoring",
|
|
@@ -525,7 +525,7 @@
|
|
|
525
525
|
{
|
|
526
526
|
"id": "cli/reference/authoring/searchAuthoringDocumentation",
|
|
527
527
|
"title": "searchAuthoringDocumentation",
|
|
528
|
-
"summary": "
|
|
528
|
+
"summary": "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.",
|
|
529
529
|
"path": "reference/authoring/searchAuthoringDocumentation.md",
|
|
530
530
|
"importPath": "@metamesh/cli/authoring",
|
|
531
531
|
"availability": "Local Node authoring",
|
|
@@ -539,7 +539,7 @@
|
|
|
539
539
|
{
|
|
540
540
|
"id": "cli/reference/authoring/showAuthoringDocumentation",
|
|
541
541
|
"title": "showAuthoringDocumentation",
|
|
542
|
-
"summary": "
|
|
542
|
+
"summary": "Reads one exact-version installed Markdown topic by its discovered ID, without executing source.",
|
|
543
543
|
"path": "reference/authoring/showAuthoringDocumentation.md",
|
|
544
544
|
"importPath": "@metamesh/cli/authoring",
|
|
545
545
|
"availability": "Local Node authoring",
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# AUTHORING_PROTOCOL_VERSION
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Version of the CLI authoring protocol, independent of package SemVer and engine compatibility.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.15.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
8
|
AUTHORING_PROTOCOL_VERSION = 1
|
|
@@ -1,16 +1,19 @@
|
|
|
1
1
|
# AuthoringDiagnostic
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A structured issue with optional source location, parameter association, and geometry context.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.15.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** A structured issue with optional source location, parameter association, and geometry context. */
|
|
8
9
|
export interface AuthoringDiagnostic {
|
|
9
10
|
readonly code: string;
|
|
10
11
|
readonly message: string;
|
|
11
12
|
readonly severity: "error" | "warning";
|
|
12
13
|
readonly file?: string;
|
|
14
|
+
/** One-based source line, when available. */
|
|
13
15
|
readonly line?: number;
|
|
16
|
+
/** One-based source column, when available. */
|
|
14
17
|
readonly column?: number;
|
|
15
18
|
readonly parameterId?: string;
|
|
16
19
|
readonly path?: readonly (number | string)[];
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# AuthoringEnvironment
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
The selected project's supported protocol, matching package releases, and available workflows.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.15.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** The selected project's supported protocol, matching package releases, and available workflows. */
|
|
8
9
|
export interface AuthoringEnvironment {
|
|
9
10
|
readonly authoringProtocolVersion: typeof AUTHORING_PROTOCOL_VERSION;
|
|
10
11
|
readonly project: string;
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# AuthoringError
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A classified authoring exception retaining its workflow phase, stable code, and exit status.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.15.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** A classified authoring exception retaining its workflow phase, stable code, and exit status. */
|
|
8
9
|
export declare class AuthoringError extends Error {
|
|
9
10
|
readonly phase: AuthoringPhase;
|
|
10
11
|
readonly code: string;
|
|
@@ -1,15 +1,18 @@
|
|
|
1
1
|
# AuthoringFailure
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
An unsuccessful command outcome; a failure directory does not establish a complete capture.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.15.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** An unsuccessful command outcome; a failure directory does not establish a complete capture. */
|
|
8
9
|
export interface AuthoringFailure {
|
|
9
10
|
readonly success: false;
|
|
10
11
|
readonly phase: AuthoringPhase;
|
|
12
|
+
/** 1 for source or generation failures; 2 for invocation, environment, artifact, or tooling failures. */
|
|
11
13
|
readonly exitCode: 1 | 2;
|
|
12
14
|
readonly diagnostics: readonly AuthoringDiagnostic[];
|
|
15
|
+
/** This attempt's directory, when created; read its failure metadata instead of inspecting geometry. */
|
|
13
16
|
readonly runDirectory?: string;
|
|
14
17
|
}
|
|
15
18
|
```
|
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
# AuthoringKind
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Selects a standalone ModelProgram entry or an SDK Generator module with a definition.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.15.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** Selects a standalone ModelProgram entry or an SDK Generator module with a definition. */
|
|
8
9
|
export type AuthoringKind = "model" | "generator";
|
|
9
10
|
```
|
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
# AuthoringPhase
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
The workflow stage that rejected an invocation, source, asset, or captured artifact.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.15.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** The workflow stage that rejected an invocation, source, asset, or captured artifact. */
|
|
8
9
|
export type AuthoringPhase = "invocation" | "environment" | "check" | "parameters" | "assets" | "bundle" | "execute" | "artifact" | "render";
|
|
9
10
|
```
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# CapturedBuffer
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A captured file's relative path, byte length, and SHA-256 integrity digest.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.15.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** A captured file's relative path, byte length, and SHA-256 integrity digest. */
|
|
8
9
|
export interface CapturedBuffer {
|
|
9
10
|
readonly path: string;
|
|
10
11
|
readonly bytes: number;
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# CapturedGeometry
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Validated local-space mesh buffers loaded from a completed captured resource.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.15.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** Validated local-space mesh buffers loaded from a completed captured resource. */
|
|
8
9
|
export interface CapturedGeometry {
|
|
9
10
|
readonly id: string;
|
|
10
11
|
readonly positions: Float32Array;
|
|
@@ -1,15 +1,18 @@
|
|
|
1
1
|
# CapturedPart
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Semantic part identity and appearance referencing a shared mesh with separate placement.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.15.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** Semantic part identity and appearance referencing a shared mesh with separate placement. */
|
|
8
9
|
export interface CapturedPart {
|
|
9
10
|
readonly id: string;
|
|
10
11
|
readonly resourceId: string;
|
|
11
|
-
|
|
12
|
-
readonly
|
|
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;
|
|
13
16
|
readonly color?: string;
|
|
14
17
|
readonly measurements: SnapshotPart["measurements"];
|
|
15
18
|
}
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# CapturedResource
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A shared local-space mesh resource and its measurements, before per-part placement.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.15.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** A shared local-space mesh resource and its measurements, before per-part placement. */
|
|
8
9
|
export interface CapturedResource {
|
|
9
10
|
readonly id: string;
|
|
10
11
|
readonly positions: CapturedBuffer;
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# CapturedRun
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A validated successful capture with its manifest and shared local geometry buffers.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.15.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** A validated successful capture with its manifest and shared local geometry buffers. */
|
|
8
9
|
export interface CapturedRun {
|
|
9
10
|
readonly directory: string;
|
|
10
11
|
readonly manifest: CapturedRunManifest;
|
|
@@ -1,16 +1,18 @@
|
|
|
1
1
|
# CapturedRunManifest
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A completed attempt's provenance, effective inputs, diagnostics, and captured geometry.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.15.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** A completed attempt's provenance, effective inputs, diagnostics, and captured geometry. */
|
|
8
9
|
export interface CapturedRunManifest {
|
|
9
10
|
readonly formatVersion: 1;
|
|
10
11
|
readonly status: "complete";
|
|
11
12
|
readonly runId: string;
|
|
12
13
|
readonly createdAt: string;
|
|
13
14
|
readonly kind: AuthoringKind;
|
|
15
|
+
/** Project-relative entry and fingerprint of bundled local source files. */
|
|
14
16
|
readonly source: {
|
|
15
17
|
readonly entry: string;
|
|
16
18
|
readonly fingerprint: string;
|
|
@@ -1,14 +1,18 @@
|
|
|
1
1
|
# CheckOptions
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Source entry contract and project-local resolution settings for semantic checking.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.15.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** Source entry contract and project-local resolution settings for semantic checking. */
|
|
8
9
|
export interface CheckOptions {
|
|
10
|
+
/** Entry path, resolved from project. */
|
|
9
11
|
readonly entry: string;
|
|
10
12
|
readonly kind: AuthoringKind;
|
|
13
|
+
/** Package and path resolution root; defaults to the current working directory. */
|
|
11
14
|
readonly project?: string;
|
|
15
|
+
/** Explicit configuration path relative to project; otherwise the entry's nearest tsconfig is used. */
|
|
12
16
|
readonly tsconfig?: string;
|
|
13
17
|
}
|
|
14
18
|
```
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# CheckSuccess
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A successful semantic check; source has not been evaluated and no geometry is captured.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.15.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** A successful semantic check; source has not been evaluated and no geometry is captured. */
|
|
8
9
|
export interface CheckSuccess {
|
|
9
10
|
readonly success: true;
|
|
10
11
|
readonly entry: string;
|
|
@@ -1,14 +1,16 @@
|
|
|
1
1
|
# DocumentationEntry
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Metadata for one installed Markdown guide or public API symbol.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.15.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** Metadata for one installed Markdown guide or public API symbol. */
|
|
8
9
|
export interface DocumentationEntry {
|
|
9
10
|
readonly id: string;
|
|
10
11
|
readonly title: string;
|
|
11
12
|
readonly summary: string;
|
|
13
|
+
/** Forward-slash relative path beside the owning documentation manifest. */
|
|
12
14
|
readonly path: string;
|
|
13
15
|
readonly importPath: string;
|
|
14
16
|
readonly availability: string;
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# DocumentationManifest
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Exact-package-version index exposed through the package's docs/manifest.json export.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.15.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** Exact-package-version index exposed through the package's docs/manifest.json export. */
|
|
8
9
|
export interface DocumentationManifest {
|
|
9
10
|
readonly formatVersion: 1;
|
|
10
11
|
readonly packageName: string;
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# DocumentationSearchResult
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
An installed documentation match carrying the exact package identity that owns it.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.15.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** An installed documentation match carrying the exact package identity that owns it. */
|
|
8
9
|
export interface DocumentationSearchResult extends DocumentationEntry {
|
|
9
10
|
readonly packageName: string;
|
|
10
11
|
readonly packageVersion: string;
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# InstalledAuthoringPackage
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A project-local MetaMesh package and its verified documentation index.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.15.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** A project-local MetaMesh package and its verified documentation index. */
|
|
8
9
|
export interface InstalledAuthoringPackage {
|
|
9
10
|
readonly name: string;
|
|
10
11
|
readonly version: string;
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Recorded orthographic camera, expressed in millimetres and world coordinates.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.15.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
8
|
/** Recorded orthographic camera, expressed in millimetres and world coordinates. */
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Options for rendering a previously captured model, without executing author code.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.15.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
8
|
/** Options for rendering a previously captured model, without executing author code. */
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Images always belong to one captured run and one unique output directory.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.15.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
8
|
/** Images always belong to one captured run and one unique output directory. */
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Standard orthographic views in MetaMesh's Z-up coordinate system.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.
|
|
5
|
+
Import from `@metamesh/cli/authoring` (@metamesh/cli@0.15.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
8
|
/** Standard orthographic views in MetaMesh's Z-up coordinate system. */
|