@needle-tools/gltf-build-pipeline 2.16.0-next.85db3ce → 2.16.0-next.bc3af72

package/dist/cache/job-cache.d.ts

@@ -15,6 +15,8 @@ export declare function computeJobKey(options: JobCacheOptions, inputFilePath: s
 /**
  * Save the result of a completed job to the cache.
  * Stores the content of each output file and a manifest linking them.
+ * The caller should include all output files including external sidecar files
+ * (e.g. .pmrem.ktx2) collected via PackGLTFOptions.externalFiles.
  */
 export declare function saveJobResult(jobKey: string, outputFiles: string[], logger: ILogger): void;
 /**

package/dist/cache/job-cache.js

@@ -29,6 +29,8 @@ export function computeJobKey(options, inputFilePath) {
 /**
  * Save the result of a completed job to the cache.
  * Stores the content of each output file and a manifest linking them.
+ * The caller should include all output files including external sidecar files
+ * (e.g. .pmrem.ktx2) collected via PackGLTFOptions.externalFiles.
  */
 export function saveJobResult(jobKey, outputFiles, logger) {
     const entries = [];

package/dist/cli/index.js

@@ -192,6 +192,7 @@ Each version will be compressed and written to the output directory.
                 console.log("Progressive results:\n", progressive_results);
             }
         }
+        const externalFiles = [];
         if (options.compress === true) {
             const opts = {
                 config,
@@ -204,6 +205,7 @@ Each version will be compressed and written to the output directory.
                 // When progressive ran first, inputFile points to the progressive output copy.
                 // Pass the original source path so extensions can resolve sibling assets (e.g. .exr files).
                 sourceFile: progressive_results.length > 0 ? file : undefined,
+                externalFiles,
             };
             // If we have produced progressive assets then the array already contains the input
             if (progressive_results.length > 0) {
@@ -228,7 +230,7 @@ Each version will be compressed and written to the output directory.
             const allOutputFiles = progressive_results.length > 0
                 ? progressive_results
                 : [output || file];
-            saveJobResult(jobKey, allOutputFiles, logger);
+            saveJobResult(jobKey, [...allOutputFiles, ...externalFiles], logger);
         }
     });
     printStats(stats, logger, config);

package/dist/scripts/pack-gltf.d.ts

@@ -11,6 +11,8 @@ export type PackGLTFOptions = {
     verbose?: boolean;
     /** Original source file path, used to resolve external assets (e.g. .exr files) when inputFile differs from the source (e.g. after progressive transform) */
     sourceFile?: string;
+    /** Populated by packGLTF with absolute paths to external sidecar files produced during processing (e.g. .pmrem.ktx2) */
+    externalFiles?: string[];
 };
 /** Compress a glTF file
  */

package/dist/scripts/pack-gltf.js

@@ -7,7 +7,7 @@ import { MeshoptDecoder, MeshoptEncoder } from 'meshoptimizer';
 import { dedup, metalRough, prune, resample } from '@gltf-transform/functions';
 import { ALL_EXTENSIONS as NEEDLE_EXTENSIONS, NEEDLE_compression_texture, NEEDLE_mesh_compression, NEEDLE_pmrem, NEEDLE_lightmaps_ext, setExtensionInputFile } from '../extensions/index.js';
 import { isLOD, isMeshLOD, needle_animation_transform, needle_asset, needle_mesh_transform, needle_texture_transform, } from '../transforms/index.js';
-import { copyExternalResources, getOutputPath, getVersion, ioTryReadWithMissingResources, writeNodeIO } from "../utils/index.js";
+import { copyExternalResources, getOutputPath, getVersion, isMaterialOnlyGLB, ioTryReadWithMissingResources, writeNodeIO } from "../utils/index.js";
 import { addToCache, getHash, tryGetFromCache, } from "../cache/index.js";
 import { TestAssertionError } from '../utils/test-assert.js';
 /** Compress a glTF file
@@ -105,8 +105,11 @@ export async function packGLTF(inputFile, outputFile, options) {
             dedup({ propertyTypes: [PropertyType.MESH, PropertyType.MATERIAL] }),
         ];
         const isProgressiveAsset = isLOD(inputFile);
-        // TODO: progressive mesh LODs should not be pruned right now because it will remove e.g. UVs from meshes (and probably blend shapes too) (so we just not do it for any progressive asset) 
-        if (!isProgressiveAsset) {
+        const materialOnly = isMaterialOnlyGLB(document);
+        // TODO: progressive mesh LODs should not be pruned right now because it will remove e.g. UVs from meshes (and probably blend shapes too) (so we just not do it for any progressive asset)
+        // Material-only GLBs should not be pruned at all — they have no meshes so
+        // prune would strip materials, textures, and buffers, producing an empty file.
+        if (!isProgressiveAsset && !materialOnly) {
             transforms.push(prune({
                 // Pruning animations is not supported yet (e.g. if the animation is only referenced by a component)
                 propertyTypes: [
@@ -123,6 +126,29 @@ export async function packGLTF(inputFile, outputFile, options) {
             }));
         }
         await document.transform(...transforms);
+        // Collect external sidecar files (e.g. .pmrem.ktx2) produced by transforms
+        if (options.externalFiles) {
+            const outDir = path.dirname(outputFile);
+            const root = document.getRoot();
+            for (const tex of root.listTextures()) {
+                const uri = tex.getURI();
+                if (uri && !uri.startsWith('data:')) {
+                    const absPath = path.resolve(outDir, uri);
+                    if (existsSync(absPath)) {
+                        options.externalFiles.push(absPath);
+                    }
+                }
+            }
+            for (const buf of root.listBuffers()) {
+                const uri = buf.getURI();
+                if (uri && !uri.startsWith('data:')) {
+                    const absPath = path.resolve(outDir, uri);
+                    if (existsSync(absPath)) {
+                        options.externalFiles.push(absPath);
+                    }
+                }
+            }
+        }
         logger.debug(`← Writing to ${outputFile}`);
         await writeNodeIO(io, outputFile, document);
         if (useCache && cacheKey != undefined && existsSync(outputFile))

package/dist/utils/validate.d.ts

@@ -1,4 +1,7 @@
-import { ILogger } from "@gltf-transform/core";
+import { Document, ILogger } from "@gltf-transform/core";
+/** Returns true when the document contains materials/textures but no meshes, nodes, or scenes.
+ * These are standalone material assets that should not be pruned. */
+export declare function isMaterialOnlyGLB(document: Document): boolean;
 export declare function validateImageMimeType(mimetype: string, image: Uint8Array, logger: ILogger): {
     error: boolean;
     message: string;

package/dist/utils/validate.js

@@ -1,4 +1,11 @@
 import { ImageUtils } from "@gltf-transform/core";
+/** Returns true when the document contains materials/textures but no meshes, nodes, or scenes.
+ * These are standalone material assets that should not be pruned. */
+export function isMaterialOnlyGLB(document) {
+    const root = document.getRoot();
+    return root.listMeshes().length === 0
+        && root.listMaterials().length > 0;
+}
 export function validateImageMimeType(mimetype, image, logger) {
     const actualMimeType = ImageUtils.getMimeType(image);
     if (actualMimeType != null && actualMimeType != mimetype) {

package/dist/utils/version.gen.d.ts

@@ -1 +1 @@
-export declare const version = "2.16.0-next.85db3ce";
+export declare const version = "2.16.0-next.bc3af72";

package/dist/utils/version.gen.js

@@ -1 +1 @@
-export const version = "2.16.0-next.85db3ce";
+export const version = "2.16.0-next.bc3af72";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@needle-tools/gltf-build-pipeline",
-  "version": "2.16.0-next.85db3ce",
+  "version": "2.16.0-next.bc3af72",
   "description": "Pipeline and tools for optimizing gltf files using gltf-transform and compression settings within glTF extensions",
   "main": "dist/index.js",
   "type": "module",