@metamesh/cli 0.18.0 → 0.20.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.
Files changed (80) hide show
  1. package/CHANGELOG.md +65 -0
  2. package/README.md +66 -45
  3. package/dist/authoring/artifacts.d.ts +1 -1
  4. package/dist/authoring/artifacts.d.ts.map +1 -1
  5. package/dist/authoring/artifacts.js +5 -10
  6. package/dist/authoring/artifacts.js.map +1 -1
  7. package/dist/authoring/environment.d.ts.map +1 -1
  8. package/dist/authoring/environment.js +2 -0
  9. package/dist/authoring/environment.js.map +1 -1
  10. package/dist/authoring/execution-process.d.ts +1 -2
  11. package/dist/authoring/execution-process.d.ts.map +1 -1
  12. package/dist/authoring/execution-process.js +6 -5
  13. package/dist/authoring/execution-process.js.map +1 -1
  14. package/dist/authoring/export-capture.d.ts +22 -0
  15. package/dist/authoring/export-capture.d.ts.map +1 -0
  16. package/dist/authoring/export-capture.js +76 -0
  17. package/dist/authoring/export-capture.js.map +1 -0
  18. package/dist/authoring/render/client-bundle.js +172 -172
  19. package/dist/authoring/render/client-bundle.js.map +4 -4
  20. package/dist/authoring/render/scene.d.ts.map +1 -1
  21. package/dist/authoring/render/scene.js +2 -1
  22. package/dist/authoring/render/scene.js.map +1 -1
  23. package/dist/authoring/run.d.ts.map +1 -1
  24. package/dist/authoring/run.js +1 -2
  25. package/dist/authoring/run.js.map +1 -1
  26. package/dist/authoring/types.d.ts +4 -6
  27. package/dist/authoring/types.d.ts.map +1 -1
  28. package/dist/authoring/types.js.map +1 -1
  29. package/dist/authoring.d.ts +2 -0
  30. package/dist/authoring.d.ts.map +1 -1
  31. package/dist/authoring.js +1 -0
  32. package/dist/authoring.js.map +1 -1
  33. package/dist/docs/guides/agent-authoring.md +45 -243
  34. package/dist/docs/guides/local-authoring.md +216 -0
  35. package/dist/docs/guides/package.md +66 -45
  36. package/dist/docs/manifest.json +126 -52
  37. package/dist/docs/reference/authoring/AUTHORING_PROTOCOL_VERSION.md +1 -1
  38. package/dist/docs/reference/authoring/AuthoringDiagnostic.md +1 -1
  39. package/dist/docs/reference/authoring/AuthoringEnvironment.md +1 -1
  40. package/dist/docs/reference/authoring/AuthoringError.md +1 -1
  41. package/dist/docs/reference/authoring/AuthoringFailure-type.md +1 -1
  42. package/dist/docs/reference/authoring/AuthoringKind.md +1 -1
  43. package/dist/docs/reference/authoring/AuthoringPhase.md +2 -2
  44. package/dist/docs/reference/authoring/CaptureExportFormat.md +10 -0
  45. package/dist/docs/reference/authoring/CaptureExportOptions.md +17 -0
  46. package/dist/docs/reference/authoring/CaptureExportResult.md +15 -0
  47. package/dist/docs/reference/authoring/CapturedBuffer.md +1 -1
  48. package/dist/docs/reference/authoring/CapturedGeometry.md +1 -1
  49. package/dist/docs/reference/authoring/CapturedPart.md +1 -1
  50. package/dist/docs/reference/authoring/CapturedResource.md +1 -1
  51. package/dist/docs/reference/authoring/CapturedRun.md +1 -1
  52. package/dist/docs/reference/authoring/CapturedRunManifest.md +2 -3
  53. package/dist/docs/reference/authoring/CheckOptions.md +1 -1
  54. package/dist/docs/reference/authoring/CheckSuccess.md +1 -1
  55. package/dist/docs/reference/authoring/DocumentationEntry.md +1 -1
  56. package/dist/docs/reference/authoring/DocumentationManifest.md +1 -1
  57. package/dist/docs/reference/authoring/DocumentationSearchResult.md +1 -1
  58. package/dist/docs/reference/authoring/InstalledAuthoringPackage.md +1 -1
  59. package/dist/docs/reference/authoring/RenderCamera.md +1 -1
  60. package/dist/docs/reference/authoring/RenderFormat.md +1 -1
  61. package/dist/docs/reference/authoring/RenderOptions.md +1 -1
  62. package/dist/docs/reference/authoring/RenderResult.md +1 -1
  63. package/dist/docs/reference/authoring/RenderView.md +1 -1
  64. package/dist/docs/reference/authoring/RenderedImage.md +1 -1
  65. package/dist/docs/reference/authoring/RunOptions.md +1 -3
  66. package/dist/docs/reference/authoring/RunSuccess.md +1 -1
  67. package/dist/docs/reference/authoring/authoringFailure-value.md +1 -1
  68. package/dist/docs/reference/authoring/checkAuthoringSource.md +1 -1
  69. package/dist/docs/reference/authoring/discoverAuthoringEnvironment.md +1 -1
  70. package/dist/docs/reference/authoring/exportCapturedRun.md +10 -0
  71. package/dist/docs/reference/authoring/inspectCapturedRun.md +1 -1
  72. package/dist/docs/reference/authoring/installAuthoringBrowser.md +1 -1
  73. package/dist/docs/reference/authoring/readCapturedRun.md +1 -1
  74. package/dist/docs/reference/authoring/renderCapturedRun.md +1 -1
  75. package/dist/docs/reference/authoring/runAuthoringSource.md +1 -1
  76. package/dist/docs/reference/authoring/searchAuthoringDocumentation.md +1 -1
  77. package/dist/docs/reference/authoring/showAuthoringDocumentation.md +1 -1
  78. package/dist/metamesh.js +13 -4
  79. package/dist/metamesh.js.map +1 -1
  80. package/package.json +6 -6
@@ -0,0 +1,76 @@
1
+ import { randomUUID } from "node:crypto";
2
+ import { open, realpath, rename, rm } from "node:fs/promises";
3
+ import { basename, dirname, extname, join, resolve } from "node:path";
4
+ import { write3mf, writeGlb, writeStl, } from "@metamesh/modeling/export";
5
+ import { readCapturedRun } from "./artifacts.js";
6
+ import { AuthoringError } from "./errors.js";
7
+ /** Streams a captured model to an atomically published file using the public mesh writers. */
8
+ export async function exportCapturedRun(directory, options) {
9
+ if (!(options.format === "3mf" || options.format === "stl" || options.format === "glb"))
10
+ throw new AuthoringError("invocation", "INVALID_EXPORT_FORMAT", "Choose 3mf, stl, or glb.");
11
+ if (typeof options.output !== "string" || options.output.trim() === "")
12
+ throw new AuthoringError("invocation", "EXPORT_OUTPUT_REQUIRED", "Choose an output file.");
13
+ const path = resolve(options.output);
14
+ if (extname(path).toLowerCase() !== `.${options.format}`)
15
+ throw new AuthoringError("invocation", "INVALID_EXPORT_OUTPUT", `The output file must have a .${options.format} extension.`);
16
+ const captured = await readCapturedRun(directory);
17
+ const resources = new Map(captured.resources.map((resource) => [resource.id, resource]));
18
+ const parts = captured.manifest.parts.map((part) => ({
19
+ id: part.id,
20
+ geometry: resources.get(part.resourceId),
21
+ transform: part.transform,
22
+ ...(part.color === undefined ? {} : { color: part.color }),
23
+ }));
24
+ const temporary = `${path}.${randomUUID()}.pending`;
25
+ const writer = { "3mf": write3mf, stl: writeStl, glb: writeGlb }[options.format];
26
+ const settings = {
27
+ name: options.name ?? basename(path).replace(/\.[^.]+$/, ""),
28
+ limits: captured.manifest.policy.limits,
29
+ ...(options.signal === undefined ? {} : { signal: options.signal }),
30
+ };
31
+ let file;
32
+ try {
33
+ const destination = join(await realpath(dirname(path)), basename(path));
34
+ const protectedFiles = await Promise.all([
35
+ "manifest.json",
36
+ ...captured.manifest.resources.flatMap((resource) => [
37
+ resource.positions.path,
38
+ resource.indices.path,
39
+ ]),
40
+ ].map((file) => realpath(resolve(captured.directory, file))));
41
+ const identity = (file) => process.platform === "win32" ? file.toLowerCase() : file;
42
+ if (protectedFiles.some((file) => identity(file) === identity(destination)))
43
+ throw new AuthoringError("invocation", "CAPTURE_OUTPUT_CONFLICT", "Export output cannot replace captured model files.");
44
+ options.signal?.throwIfAborted();
45
+ file = await open(temporary, "wx");
46
+ const report = await writer(parts, async (chunk) => {
47
+ let offset = 0;
48
+ while (offset < chunk.byteLength) {
49
+ const { bytesWritten } = await file.write(chunk, offset, chunk.byteLength - offset);
50
+ if (bytesWritten === 0)
51
+ throw new Error("The export output stopped accepting bytes.");
52
+ offset += bytesWritten;
53
+ }
54
+ }, settings);
55
+ await file.close();
56
+ file = undefined;
57
+ options.signal?.throwIfAborted();
58
+ await rename(temporary, path);
59
+ return {
60
+ ...report,
61
+ path,
62
+ format: options.format,
63
+ runId: captured.manifest.runId,
64
+ sourceFingerprint: captured.manifest.source.fingerprint,
65
+ };
66
+ }
67
+ catch (error) {
68
+ if (file !== undefined)
69
+ await file.close().catch(() => undefined);
70
+ await rm(temporary, { force: true });
71
+ if (error instanceof AuthoringError)
72
+ throw error;
73
+ throw new AuthoringError("export", "EXPORT_FAILED", error instanceof Error ? error.message : String(error));
74
+ }
75
+ }
76
+ //# sourceMappingURL=export-capture.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"export-capture.js","sourceRoot":"","sources":["../../src/authoring/export-capture.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACtE,OAAO,EACL,QAAQ,EACR,QAAQ,EACR,QAAQ,GAIT,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAuB7C,8FAA8F;AAC9F,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,SAAiB,EACjB,OAA6B;IAE7B,IAAI,CAAC,CAAC,OAAO,CAAC,MAAM,KAAK,KAAK,IAAI,OAAO,CAAC,MAAM,KAAK,KAAK,IAAI,OAAO,CAAC,MAAM,KAAK,KAAK,CAAC;QACrF,MAAM,IAAI,cAAc,CAAC,YAAY,EAAE,uBAAuB,EAAE,0BAA0B,CAAC,CAAC;IAC9F,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE;QACpE,MAAM,IAAI,cAAc,CAAC,YAAY,EAAE,wBAAwB,EAAE,wBAAwB,CAAC,CAAC;IAC7F,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACrC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,KAAK,IAAI,OAAO,CAAC,MAAM,EAAE;QACtD,MAAM,IAAI,cAAc,CACtB,YAAY,EACZ,uBAAuB,EACvB,gCAAgC,OAAO,CAAC,MAAM,aAAa,CAC5D,CAAC;IACJ,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC,SAAS,CAAC,CAAC;IAClD,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;IACzF,MAAM,KAAK,GAAG,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACnD,EAAE,EAAE,IAAI,CAAC,EAAE;QACX,QAAQ,EAAE,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAE;QACzC,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,GAAG,CAAC,IAAI,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC;KAC3D,CAAC,CAAC,CAAC;IACJ,MAAM,SAAS,GAAG,GAAG,IAAI,IAAI,UAAU,EAAE,UAAU,CAAC;IACpD,MAAM,MAAM,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACjF,MAAM,QAAQ,GAAkB;QAC9B,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC;QAC5D,MAAM,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM;QACvC,GAAG,CAAC,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC;KACpE,CAAC;IACF,IAAI,IAAkD,CAAC;IACvD,IAAI,CAAC;QACH,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;QACxE,MAAM,cAAc,GAAG,MAAM,OAAO,CAAC,GAAG,CACtC;YACE,eAAe;YACf,GAAG,QAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC;gBACnD,QAAQ,CAAC,SAAS,CAAC,IAAI;gBACvB,QAAQ,CAAC,OAAO,CAAC,IAAI;aACtB,CAAC;SACH,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,CAC7D,CAAC;QACF,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAU,EAAE,CACxC,OAAO,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;QAC3D,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,QAAQ,CAAC,WAAW,CAAC,CAAC;YACzE,MAAM,IAAI,cAAc,CACtB,YAAY,EACZ,yBAAyB,EACzB,oDAAoD,CACrD,CAAC;QACJ,OAAO,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC;QACjC,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QACnC,MAAM,MAAM,GAAG,MAAM,MAAM,CACzB,KAAK,EACL,KAAK,EAAE,KAAK,EAAE,EAAE;YACd,IAAI,MAAM,GAAG,CAAC,CAAC;YACf,OAAO,MAAM,GAAG,KAAK,CAAC,UAAU,EAAE,CAAC;gBACjC,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,IAAK,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,UAAU,GAAG,MAAM,CAAC,CAAC;gBACrF,IAAI,YAAY,KAAK,CAAC;oBAAE,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;gBACtF,MAAM,IAAI,YAAY,CAAC;YACzB,CAAC;QACH,CAAC,EACD,QAAQ,CACT,CAAC;QACF,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;QACnB,IAAI,GAAG,SAAS,CAAC;QACjB,OAAO,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC;QACjC,MAAM,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QAC9B,OAAO;YACL,GAAG,MAAM;YACT,IAAI;YACJ,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,KAAK;YAC9B,iBAAiB,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW;SACxD,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,IAAI,KAAK,SAAS;YAAE,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QAClE,MAAM,EAAE,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QACrC,IAAI,KAAK,YAAY,cAAc;YAAE,MAAM,KAAK,CAAC;QACjD,MAAM,IAAI,cAAc,CACtB,QAAQ,EACR,eAAe,EACf,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CACvD,CAAC;IACJ,CAAC;AACH,CAAC"}