@forgeax/engine-gltf 0.1.20 → 0.1.23

package/README.md

@@ -210,4 +210,63 @@ forgeax-engine-remote-gltf import apps/hello/gltf/assets/box.glb
 forgeax-engine-remote-gltf import apps/hello/gltf/assets/ --check
 ```
 
+### End-to-end source-to-Pack route
+
+The CLI creates the authoring sidecar; the shared import runner is the single
+Pack/DDC publication path. Keep these steps together when adding a glTF LOD:
+
+```mermaid
+flowchart LR
+    source["source .gltf/.glb"] --> cli["remote-gltf import"]
+    cli --> meta["source.meta.json"]
+    meta --> registry["ImporterRegistry + gltfImporter"]
+    registry --> runner["runImport"]
+    runner --> pack["Pack/DDC + Catalog"]
+```
+
+1. Run `forgeax-engine-remote-gltf import <source>` to create or refresh the
+   adjacent `<source>.meta.json` and its stable sub-asset GUIDs.
+2. Register `gltfImporter` with the build-time `ImporterRegistry` and pass the
+   sidecar to `runImport`; this validates the declared LOD GUID closure and
+   writes the Pack/DDC output.
+3. Verify the resulting Catalog/receipt and load the root GUID at runtime. The
+   complete `ImporterRegistry`/`runImport` example, including the filesystem
+   adapter, lives in [`@forgeax/engine-import`](../import/README.md#the-importload-split).
+
 See `.forgeax-harness/forgeax-loop/feat-20260515-gltf-loader-via-asset-system/plan-strategy.md` for the full roadmap.
+
+## LOD extensions
+
+The glTF adapter admits `MSFT_lod` at node level. The extension's `ids` array
+is preserved in producer order; each referenced root or lower node must resolve
+to a non-empty mesh sub-asset. Material, name, and guessed suffix conventions
+do not create LOD relations.
+
+The portable Khronos form stores coverage on the root LOD node:
+
+```json
+{
+  "extensions": { "MSFT_lod": { "ids": [1, 2] } },
+  "extras": { "MSFT_screencoverage": [0.5, 0.2, 0.01] }
+}
+```
+
+The array describes the root and lower ranges and includes a terminal discard
+threshold. The adapter keeps `[0.5, 0.2]` as the two lower-level absolute
+`MeshAsset.lods[].screenCoverage` values and drops only that terminal discard
+entry, which has no `MeshAsset` representation. The historical document-level
+`extensions.MSFT_screencoverage.scales` form remains an internal fixture
+adapter; node `extras` takes precedence when both forms are present.
+
+| Source fact | Projection | Recovery |
+|:--|:--|:--|
+| `MSFT_lod.ids` | root MeshAsset `lods[]` and `refs[]` | repair node references and reimport |
+| root `extras.MSFT_screencoverage` | absolute coverage values (terminal discard omitted) | repair values and reimport |
+| legacy document `MSFT_screencoverage.scales` | explicit fixture coverage values | migrate to node `extras`, then recook |
+| no coverage extension | shared importer defaults | keep existing sidecar values, then recook |
+
+On malformed extension data, a required-but-missing `MSFT_lod` group, an empty
+referenced mesh, or an unresolved mesh sub-asset, the importer returns
+`gltf-lod-invalid` before publication. The old sidecar and Catalog LKG are the
+recovery boundary; no relation is silently dropped by `flatMap` or a partial
+Pack is published.

package/dist/__tests__/lod-import.integration.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=lod-import.integration.test.d.ts.map

package/dist/__tests__/lod-import.integration.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lod-import.integration.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/lod-import.integration.test.ts"],"names":[],"mappings":""}

package/dist/__tests__/lod-meta-publication.integration.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=lod-meta-publication.integration.test.d.ts.map

package/dist/__tests__/lod-meta-publication.integration.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lod-meta-publication.integration.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/lod-meta-publication.integration.test.ts"],"names":[],"mappings":""}

package/dist/check-extensions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"check-extensions.d.ts","sourceRoot":"","sources":["../src/check-extensions.ts"],"names":[],"mappings":"AAuBA,OAAO,EAAO,KAAK,SAAS,EAAe,KAAK,MAAM,EAAE,MAAM,aAAa,CAAC;AAE5E,2EAA2E;AAC3E,eAAO,MAAM,mBAAmB,EAAE,SAAS,MAAM,EAGhD,CAAC;AAUF,MAAM,WAAW,qBAAqB;IACpC,6EAA6E;IAC7E,QAAQ,CAAC,eAAe,EAAE,SAAS,MAAM,EAAE,CAAC;CAC7C;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAChD,QAAQ,CAAC,cAAc,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CAC7C;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,eAAe,CAC7B,IAAI,EAAE,kBAAkB,GACvB,MAAM,CAAC,qBAAqB,EAAE,SAAS,CAAC,CAsB1C"}
+{"version":3,"file":"check-extensions.d.ts","sourceRoot":"","sources":["../src/check-extensions.ts"],"names":[],"mappings":"AAuBA,OAAO,EAAO,KAAK,SAAS,EAAe,KAAK,MAAM,EAAE,MAAM,aAAa,CAAC;AAE5E,2EAA2E;AAC3E,eAAO,MAAM,mBAAmB,EAAE,SAAS,MAAM,EAKhD,CAAC;AAUF,MAAM,WAAW,qBAAqB;IACpC,6EAA6E;IAC7E,QAAQ,CAAC,eAAe,EAAE,SAAS,MAAM,EAAE,CAAC;CAC7C;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAChD,QAAQ,CAAC,cAAc,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CAC7C;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,eAAe,CAC7B,IAAI,EAAE,kBAAkB,GACvB,MAAM,CAAC,qBAAqB,EAAE,SAAS,CAAC,CAsB1C"}

package/dist/cli-gltf.mjs

@@ -3,8 +3,9 @@ import { realpath, stat, readFile, writeFile, readdir } from 'fs/promises';
 import { resolve, dirname, join } from 'path';
 import { fileURLToPath } from 'url';
 import { parseArgs } from 'util';
-import { reconcileMeshMaterialSlotTopology, err, MESH_MATERIAL_SLOT_SOURCE_OVERRIDE_PAYLOAD_SCHEMA, ok, ImportError, IMPORT_ERROR_HINTS } from '@forgeax/engine-types';
+import { err, reconcileMeshMaterialSlotTopology, MESH_MATERIAL_SLOT_SOURCE_OVERRIDE_PAYLOAD_SCHEMA, ok, ImportError, IMPORT_ERROR_HINTS } from '@forgeax/engine-types';
 import { vec3, quat, mat4 } from '@forgeax/engine-math';
+import { deriveDefaultLodScreenCoverages, reconcileMeshLodMeta } from '@forgeax/engine-import';
 import { deriveAnimationTargetId } from '@forgeax/engine-animation/target-id';
 import { AssetGuid } from '@forgeax/engine-pack/guid';
 
@@ -27,6 +28,10 @@ var gltfErrorPolicy = {
     expected: "extension listed in v1 allowlist (see EXTENSION_ALLOWLIST in @forgeax/engine-gltf)",
     hint: "see feat-future-gltf-extensions-allowlist; remove this extension or wait for the allowlist to expand"
   },
+  "gltf-lod-invalid": {
+    expected: "MSFT_lod ids to reference unique existing node indices with valid coverage",
+    hint: "repair the MSFT_lod node relation or remove it from extensionsRequired before re-importing"
+  },
   "gltf-material-transmission-invalid": {
     expected: "KHR transmission, IOR, and volume values are finite and within their glTF ranges",
     hint: "repair the named glTF material extension value and re-import the source"
@@ -394,7 +399,9 @@ function decodeColorAccessor(input, flags = {}) {
 // src/check-extensions.ts
 var EXTENSION_ALLOWLIST = [
   "EXT_mesh_gpu_instancing",
-  "EXT_meshopt_compression"
+  "EXT_meshopt_compression",
+  "MSFT_lod",
+  "MSFT_screencoverage"
 ];
 var SUPPORTED_EXTENSIONS = [
   ...EXTENSION_ALLOWLIST,
@@ -454,6 +461,103 @@ function decodeBase64(b64) {
   return out;
 }
 
+// src/lod/parse-lod.ts
+function parseGltfLodExtension(json) {
+  const doc = json;
+  const nodes = doc.nodes ?? [];
+  const rawCoverage = doc.extensions?.MSFT_screencoverage?.scales;
+  const groups = [];
+  for (let rootNode = 0; rootNode < nodes.length; rootNode += 1) {
+    if (nodes[rootNode]?.extensions?.MSFT_lod === void 0) continue;
+    const idsRaw = nodes[rootNode]?.extensions?.MSFT_lod?.ids;
+    if (!Array.isArray(idsRaw)) {
+      return err(gltfErr("gltf-lod-invalid", { rootNode, ids: [], reason: "not-integer" }));
+    }
+    const ids = idsRaw.filter((value) => typeof value === "number");
+    if (ids.length !== idsRaw.length || ids.some((id) => !Number.isInteger(id) || id < 0 || id >= nodes.length)) {
+      return err(gltfErr("gltf-lod-invalid", { rootNode, ids, reason: "missing-node" }));
+    }
+    if (new Set(ids).size !== ids.length || ids.includes(rootNode)) {
+      return err(gltfErr("gltf-lod-invalid", { rootNode, ids, reason: "duplicate-node" }));
+    }
+    const hasMesh = (node) => {
+      if (typeof node?.mesh !== "number" || !Number.isInteger(node.mesh) || node.mesh < 0) {
+        return false;
+      }
+      const mesh = doc.meshes?.[node.mesh];
+      return mesh !== void 0 && Array.isArray(mesh.primitives) && mesh.primitives.length > 0;
+    };
+    if (!hasMesh(nodes[rootNode]) || ids.some((id) => !hasMesh(nodes[id]))) {
+      return err(gltfErr("gltf-lod-invalid", { rootNode, ids, reason: "missing-node" }));
+    }
+    const nodeCoverage = nodes[rootNode]?.extras?.MSFT_screencoverage;
+    const coverage = normalizeScreenCoverages(
+      nodeCoverage === void 0 ? rawCoverage : nodeCoverage,
+      ids.length,
+      nodeCoverage !== void 0
+    );
+    if (coverage === "invalid") {
+      return err(gltfErr("gltf-lod-invalid", { rootNode, ids, reason: "coverage" }));
+    }
+    groups.push({
+      rootNode,
+      lodNodeIds: ids,
+      screenCoverages: coverage ?? []
+    });
+  }
+  const first = groups[0];
+  if (first === void 0) {
+    if (doc.extensionsRequired?.some((extension) => extension === "MSFT_lod")) {
+      return err(gltfErr("gltf-lod-invalid", { rootNode: 0, ids: [], reason: "missing-node" }));
+    }
+    return ok({ rootNode: 0, lodNodeIds: [], screenCoverages: [], groups: [] });
+  }
+  return ok({
+    rootNode: first.rootNode,
+    lodNodeIds: first.lodNodeIds,
+    screenCoverages: first.screenCoverages,
+    groups
+  });
+}
+function normalizeScreenCoverages(raw, lodCount, officialNodeForm) {
+  if (raw === void 0) return void 0;
+  if (!Array.isArray(raw)) return "invalid";
+  if (raw.some(
+    (value) => typeof value !== "number" || !Number.isFinite(value) || value <= 0 || value > 1
+  )) {
+    return "invalid";
+  }
+  const expectedLengths = officialNodeForm ? [lodCount + 1] : [lodCount, lodCount + 1];
+  if (!expectedLengths.includes(raw.length)) return "invalid";
+  const values = raw.slice(0, lodCount);
+  for (let index = 1; index < values.length; index += 1) {
+    if (values[index] >= values[index - 1]) return "invalid";
+  }
+  return values;
+}
+function projectGltfLodMeta(input) {
+  const defaults = deriveDefaultLodScreenCoverages(input.levels.length + 1);
+  const previous = (input.previous ?? []).map((level) => ({
+    sourceKey: level.sourceKey,
+    meshGuid: level.guid,
+    ...level.screenCoverage === void 0 ? {} : { screenCoverage: level.screenCoverage }
+  }));
+  const next = input.levels.map((level, index) => ({
+    sourceKey: level.sourceKey,
+    meshGuid: level.guid,
+    screenCoverage: level.screenCoverage ?? defaults[index] ?? 0
+  }));
+  const reconciled = reconcileMeshLodMeta(previous, next);
+  if (!reconciled.ok) return err({ code: reconciled.error.code, reason: reconciled.error.reason });
+  return ok({
+    lods: reconciled.value.lods.map((level) => ({
+      sourceKey: level.sourceKey,
+      meshGuid: level.meshGuid,
+      screenCoverage: level.screenCoverage
+    }))
+  });
+}
+
 // src/material/parse-material.ts
 function tuple2(values) {
   if (values === void 0 || values.length < 2) return void 0;
@@ -1479,6 +1583,8 @@ async function parseGltfWithBin(json, ctx) {
   const extResult = checkExtensions(json);
   if (!extResult.ok) return err(extResult.error);
   const unsupportedExtensions = extResult.value.unsupportedUsed;
+  const lodResult = parseGltfLodExtension(json);
+  if (!lodResult.ok) return err(lodResult.error);
   const lightsResult = parsePunctualLights(json, ctx.filePath);
   if (!lightsResult.ok) return err(lightsResult.error);
   const meshesJson = json.meshes ?? [];
@@ -2019,7 +2125,8 @@ async function parseGltfWithBin(json, ctx) {
       matrixTrsCoexistNodes: diagnostics.matrixTrsCoexistNodes
     },
     meshPrimitiveCount,
-    lights: lightsResult.value
+    lights: lightsResult.value,
+    ...lodResult.value.lodNodeIds.length === 0 ? {} : { lod: lodResult.value }
   });
 }
 async function parseGltfForImporter(json, externalLoader, filePath, options = {}) {
@@ -2158,6 +2265,74 @@ function toAssetPack(doc, existingMeta, source) {
   const sourceOverrides = {
     ...existingMeta?.sourceOverrides ?? {}
   };
+  const lodGroups = doc.lod === void 0 ? [] : doc.lod.groups.length > 0 ? doc.lod.groups : [doc.lod];
+  for (const lodGroup of lodGroups) {
+    if (lodGroup.lodNodeIds.length === 0) continue;
+    const rootMeshIndex = doc.nodes[lodGroup.rootNode]?.meshIndex;
+    const referencedMeshIndices = [
+      rootMeshIndex,
+      ...lodGroup.lodNodeIds.map((nodeIndex) => doc.nodes[nodeIndex]?.meshIndex)
+    ];
+    if (referencedMeshIndices.some(
+      (meshIndex) => !Number.isInteger(meshIndex) || meshIndex === null || meshIndex === void 0 || !seenMeshIndices.has(meshIndex)
+    )) {
+      return err(
+        gltfErr("gltf-lod-invalid", {
+          rootNode: lodGroup.rootNode,
+          ids: lodGroup.lodNodeIds,
+          reason: "missing-node"
+        })
+      );
+    }
+    const rootOutput = rootMeshIndex === void 0 || rootMeshIndex === null ? void 0 : subAssetByKindIndex.get(`mesh:${rootMeshIndex}`);
+    const levels = lodGroup.lodNodeIds.map((nodeIndex, index) => {
+      const meshIndex = doc.nodes[nodeIndex]?.meshIndex;
+      const output = meshIndex === void 0 || meshIndex === null ? void 0 : subAssetByKindIndex.get(`mesh:${meshIndex}`);
+      return {
+        sourceKey: output?.sourceKey ?? `mesh:${meshIndex ?? nodeIndex}`,
+        meshGuid: output?.guid ?? "",
+        ...lodGroup.screenCoverages[index] === void 0 ? {} : { screenCoverage: lodGroup.screenCoverages[index] }
+      };
+    });
+    if (rootOutput?.sourceKey !== void 0 && levels.every((level) => level.meshGuid !== "")) {
+      const previousLodMeta = (() => {
+        const raw = existingMeta?.sourceOverrides?.[rootOutput.sourceKey]?.lods;
+        if (!Array.isArray(raw)) return void 0;
+        return raw.flatMap((entry) => {
+          if (entry === null || typeof entry !== "object") return [];
+          const value = entry;
+          return typeof value.sourceKey === "string" && typeof value.meshGuid === "string" ? [
+            {
+              sourceKey: value.sourceKey,
+              guid: value.meshGuid,
+              ...typeof value.screenCoverage === "number" ? { screenCoverage: value.screenCoverage } : {}
+            }
+          ] : [];
+        });
+      })();
+      const projected = projectGltfLodMeta({
+        rootSourceKey: rootOutput.sourceKey,
+        levels: levels.map((level) => ({
+          sourceKey: level.sourceKey,
+          guid: level.meshGuid,
+          ...level.screenCoverage === void 0 ? {} : { screenCoverage: level.screenCoverage }
+        })),
+        ...previousLodMeta === void 0 ? {} : { previous: previousLodMeta }
+      });
+      if (!projected.ok)
+        return err(
+          gltfErr("gltf-lod-invalid", {
+            rootNode: lodGroup.rootNode,
+            ids: lodGroup.lodNodeIds,
+            reason: "coverage"
+          })
+        );
+      sourceOverrides[rootOutput.sourceKey] = {
+        ...sourceOverrides[rootOutput.sourceKey] ?? {},
+        lods: projected.value.lods
+      };
+    }
+  }
   for (const meshIndex of seenMeshIndices) {
     const meshOutput = subAssetByKindIndex.get(`mesh:${meshIndex}`);
     if (meshOutput?.sourceKey === void 0) continue;
@@ -2252,13 +2427,13 @@ function serializeMetaJson(meta) {
 }
 
 // src/cli-gltf.ts
-function emitError(ctx, err2) {
+function emitError(ctx, err3) {
   const payload = {
-    code: err2.code,
-    expected: err2.expected,
-    hint: err2.hint
+    code: err3.code,
+    expected: err3.expected,
+    hint: err3.hint
   };
-  if (err2.detail !== void 0) payload.detail = err2.detail;
+  if (err3.detail !== void 0) payload.detail = err3.detail;
   ctx.stderrWrite(JSON.stringify(payload));
   return 1;
 }