@needle-tools/gltf-build-pipeline 2.11.2 → 2.11.3-next.2bc6b5b

package/CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this package will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [2.11.3] - 2025-08-08
+- Fix: texture compression settings not being applied correctly
+- Change: CLI `transform` with `--progressive` does now ignore LOD files
+- Change: Increase local cache size to 5 GB
+
 ## [2.11.2] - 2025-08-07
 - Change: `product` usecase should not flatten/join objects
 

package/dist/cache/cache.d.ts

@@ -6,7 +6,7 @@ import { Logger } from "@donmccurdy/caporal";
  * This will remove all files in the cache directory.
  */
 export declare function clearCache(logger?: Logger): void;
-export declare const cacheSizeLimit = 1024;
+export declare const cacheSizeLimit: number;
 /**
  * Ensure that the cache size does not exceed the given maximum size in MB.
  * @param maxSizeMB The maximum size in MB.

package/dist/cache/cache.js

@@ -32,7 +32,7 @@ export function clearCache(logger) {
     else
         logger.info(`Cleared cache at ${dir}`);
 }
-export const cacheSizeLimit = 1024;
+export const cacheSizeLimit = 1024 * 5;
 /**
  * Ensure that the cache size does not exceed the given maximum size in MB.
  * @param maxSizeMB The maximum size in MB.

package/dist/cli/index.js

@@ -66,6 +66,8 @@ Each version will be compressed and written to the output directory.
     .option("--debug", "Enable for more verbose outout with \"--debug True\"", { validator: program.BOOLEAN, default: false })
     .option("--verbose", "Enable for more verbose outout with \"--verbose True\"", { validator: program.BOOLEAN, default: false })
     .action(async ({ logger, args, options }) => {
+    logger.level = (options.debug || options.verbose) ? "debug" : "info";
+    // const logger = new Logger((options.debug || options.verbose) ? Verbosity.DEBUG : Verbosity.INFO);
     if (options.compress === false && options.progressive === false) {
         logger.error(`[Needle Build Pipeline] v${getVersion()} You need to enable at least one of the options: --compress or --progressive`);
         return;
@@ -127,7 +129,12 @@ Each version will be compressed and written to the output directory.
                 process.exit(ERROR_CODES.LOST_FILE);
             }
         }
-        logger.info("→ Transform " + file);
+        // If we run compression in a directory that has previously generated LOD files AND this command should also generate LOD files with this command we should ignore found LOD meshes or textures
+        else if (file != input && options.progressive === true && isLOD(file)) {
+            logger.debug(`→ Ignore existing LOD file at ${file}`);
+            return;
+        }
+        logger.info(`→ Transform ${file}`);
         const progressive_results = new Array();
         if (options.progressive === true) {
             if (await make_progressive({

package/dist/extensions/NEEDLE_progressive_texture_settings/index.js

@@ -8,43 +8,14 @@ export class NEEDLE_progressive_texture_settings extends Extension {
         const textureDefinitions = context.jsonDoc.json.textures;
         if (!textureDefinitions)
             return this;
-        const root = this.document.getRoot();
-        const textures = root.listTextures();
-        /**
-         * If a texture is used in multiple slots it only appears once in the gltf-transform list
-         * So we have to store the key and the index of the texture in the list
-         */
-        const textureMap = new Map();
-        let offset = 0;
         for (let i = 0; i < textureDefinitions.length; i++) {
             const texDef = textureDefinitions[i];
             if (texDef.extensions && texDef.extensions[EXTENSION_NAME]) {
                 const ext = texDef.extensions[EXTENSION_NAME];
                 const prop = new NEEDLE_progressive_texture_settings_property(this.document.getGraph(), "");
                 Object.assign(prop, ext);
-                let textureIndex = i - offset;
-                const key = ext.guid;
-                if (textureMap.has(key)) {
-                    // we keep a track of the index offset assuming gltf-transform textures order is the same as the texture definition order. This is by no means *not* bullet-proof but I'm not sure how to do it properly right now
-                    // Perhaps we could try to find the texture with the same image source binary array as defined in the texture definition but this would also not be perfect I think...
-                    // TODO: find a better way to handle texture definition count and texture count mismatch due to a texture being used in multiple slots (where gltf-transform optimizes the texture list and removes duplicates) 
-                    offset += 1;
-                    // textureIndex = textureMap.get(key);
-                    console.log(`INFO: Progressive texture extension was ${i} already found...`);
-                    continue;
-                }
-                else {
-                    textureMap.set(key, textureIndex);
-                }
-                const tex = textures[textureIndex];
-                if (tex)
-                    tex.setExtension(EXTENSION_NAME, prop);
-                else {
-                    // console.log(textureDefinitions)
-                    console.warn(`WARN: Progressive texture at index ${i} was not found in the glTF file. This might result in falsely loaded textures for ${ext.guid} / name \"${texDef.name}\"`);
-                    // if(debug)
-                    // throw new Error(`Progressive texture at index ${i} was not found in the glTF file.`)
-                }
+                const texture = context.textures[texDef.source];
+                texture.setExtension(EXTENSION_NAME, prop);
             }
         }
         return this;

package/dist/transforms/needle_mesh_transform.js

@@ -68,6 +68,7 @@ export const needle_mesh_transform = function (context) {
 };
 async function applyMeshCompression(document, transform_context, context) {
     const isLOD = isMeshLOD(context.file);
+    const isProduct = context.config?.usecase === "product";
     const compressionModel = determineMeshCompression(document, context.file); // document.getRoot().getExtension(NEEDLE_mesh_compression.EXTENSION_NAME) as NEEDLE_mesh_compression_property;
     if (compressionModel) {
         // const rootModel = rootExtension.model as NEEDLE_mesh_compression_model_root;
@@ -79,7 +80,7 @@ async function applyMeshCompression(document, transform_context, context) {
             document.getLogger().info(`[${NAME}]: ${compressionModel.compression.toUpperCase()} → will apply ${compressionModel.compression} mesh compression`);
             if (compressionModel.compression === "draco") {
                 const transform = draco({
-                    quantizationVolume: isLOD ? "scene" : undefined
+                    quantizationVolume: isLOD || isProduct ? "scene" : undefined
                 });
                 return transform(document, transform_context);
             }
@@ -92,7 +93,7 @@ async function applyMeshCompression(document, transform_context, context) {
     // by default we still want to run draco if the root doesnt have a compression model configured
     document.getLogger().info(`[${NAME}]: → will apply draco mesh compression (default)`);
     const transform = draco({
-        quantizationVolume: isLOD ? "scene" : undefined
+        quantizationVolume: isLOD || isProduct ? "scene" : undefined
     });
     return transform(document, transform_context);
 }

package/dist/transforms/needle_progressive.js

@@ -22,7 +22,7 @@ export async function make_progressive(opts) {
         }
         // Don't re-process files that are already LODs
         if (isMeshLOD(f) || isImageLOD(f)) {
-            opts.logger.info(`Progressive Transform: Ignore existing LOD file at ${f}`);
+            opts.logger.info(`[Progressive Transform]: Ignore existing LOD file at ${f}`);
             return;
         }
         const res = await onProcess(f, opts);
@@ -40,7 +40,7 @@ export async function make_progressive(opts) {
         }
         const resultsChanged = resultsCount !== opts.results.length;
         if (opts.debug)
-            console.log(`Progressive Transform: ${opts.results.length} files processed. ${resultsChanged ? "Some results were removed" : ""}`);
+            console.log(`[Progressive Transform]: ${opts.results.length} files processed. ${resultsChanged ? "Some results were removed" : ""}`);
     }
     return success;
 }
@@ -253,7 +253,7 @@ export function make_progressive_textures(filePath, _options = TEXTURE_RESIZE_DE
                 });
                 opts.results.push(outpath);
             }
-            const key = getKey(texture);
+            const cacheKey = getKey(texture);
             // TODO: this path should be added to the NEEDLE dependencies extension
             const model = {
                 guid: textureGuid,
@@ -261,7 +261,7 @@ export function make_progressive_textures(filePath, _options = TEXTURE_RESIZE_DE
             };
             texture.setExtension(NEEDLE_PROGRESSIVE_EXTENSION_NAME, progressiveExt.createTexture(model));
             if (opts.useCache) {
-                const cached = tryGetFromCache(key);
+                const cached = tryGetFromCache(cacheKey);
                 if (cached) {
                     logger.debug(`Progressive image ${index}: using cached preview version (size: ${options.size}))`);
                     texture.setImage(cached);
@@ -275,7 +275,7 @@ export function make_progressive_textures(filePath, _options = TEXTURE_RESIZE_DE
             if (opts?.useCache === false) {
             }
             else
-                addToCache(key, texture.getImage());
+                addToCache(cacheKey, texture.getImage());
         }
         logger.debug(`Progressive transform finished in ${((Date.now() - startTime) / 1000).toFixed(1)} sec.`);
     });
@@ -492,7 +492,7 @@ async function resizeTexture(options, texture, logger, uri, slots) {
     }
     dstWidth = Math.floor(dstWidth);
     dstHeight = Math.floor(dstHeight);
-    logger.warn("> Resize texture to " + dstWidth + "x" + dstHeight + " (from " + srcWidth + "x" + srcHeight + ")");
+    logger.info(`→ Resize texture (${uri || texture.getName() || slots.join(", ")}) from ${srcWidth}x${srcHeight} to ${dstWidth}x${dstHeight}px`);
     // https://sharp.pixelplumbing.com/api-resize
     const buffer = await sharp(texture.getImage())
         .resize(dstWidth, dstHeight, {
@@ -657,11 +657,11 @@ export function make_progressive_meshes(filePath, _options, opts) {
                             const vertexDifference = lastMeshInfo.totalVertexCount - meshInfo.totalVertexCount;
                             const diff01 = vertexDifference / lastMeshInfo.totalVertexCount;
                             if (vertexDifference < 0) {
-                                console.log(`WARN: [${NAME}] Flag mesh LOD ${level}: vertex count did increase (${-vertexDifference.toFixed(0)} vertices, ${(-diff01 * 100).toFixed(4)}%) → LOD ${level} will be omitted. \"${mesh.getName()}\" at \"${lodInfo.path}\" ${JSON.stringify(lastMeshInfo)} → ${JSON.stringify(meshInfo)}`);
+                                logger.info(`[${NAME}] Flag mesh LOD ${level}: vertex count did increase (${-vertexDifference.toFixed(0)} vertices, ${(-diff01 * 100).toFixed(4)}%) → LOD ${level} will be omitted. \"${mesh.getName()}\" at \"${lodInfo.path}\" ${JSON.stringify(lastMeshInfo)} → ${JSON.stringify(meshInfo)}`);
                                 shouldOmitLevel = true;
                             }
                             else if (vertexDifference < 32 || diff01 < 0.05) {
-                                logger.warn(`[${NAME}] Flag mesh LOD ${level}: vertex count difference below threshold (removed ${vertexDifference.toFixed(0)} vertices, ${(-diff01 * 100).toFixed(4)}%) → LOD ${level} will be omitted. \"${mesh.getName()}\" at \"${lodInfo.path}\"`);
+                                logger.info(`[${NAME}] Flag mesh LOD ${level}: vertex count difference below threshold (removed ${vertexDifference.toFixed(0)} vertices, ${(-diff01 * 100).toFixed(4)}%) → LOD ${level} will be omitted. \"${mesh.getName()}\" at \"${lodInfo.path}\"`);
                                 shouldOmitLevel = true;
                             }
                         }

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

@@ -1 +1 @@
-export declare const version = "2.11.2";
+export declare const version = "2.11.3-next.2bc6b5b";

package/dist/utils/version.gen.js

@@ -1 +1 @@
-export const version = "2.11.2";
+export const version = "2.11.3-next.2bc6b5b";

package/package.json

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