@needle-tools/gltf-build-pipeline 2.15.9 → 2.15.10-next.0a00d78

package/dist/cli/index.js

@@ -31,13 +31,14 @@ Caches are limited to ${cacheSizeLimit} MB disc space by default.
 `)
     .argument('<input>', "Path to a glTF, GLB or VRM file OR a directory")
     .argument('<output>', "Output path for the stats", { default: null, validator: program.STRING })
+    .option("--verbose", "Enable verbose output", { validator: program.BOOLEAN, default: false })
     .action(async ({ logger, args, options }) => {
-    logger.level = "info";
+    logger.level = options.verbose ? "debug" : "info";
     logger.info("Calculating stats for \"" + args.input + "\"");
     const input = args.input.toString();
     const filestats = new Array();
     await foreachGLTF(input, async (file) => {
-        const stats = await calculateStats(file);
+        const stats = await calculateStats(file, { verbose: !!options.verbose });
         filestats.push(stats);
     });
     let output = args.output?.toString();

package/dist/config/index.js

@@ -79,12 +79,12 @@ export function getConfig(configPath, fallbackSearchDirectory, opts) {
         const result = searchConfig(fallbackSearchDirectory, logger);
         if (result) {
             _cachedConfig = { ...defaultConfig, ...result };
-            logger.info("Using config with usecase: " + _cachedConfig.usecase);
+            logger.info(`Using config with usecase: ${_cachedConfig.usecase}`);
         }
     }
     // If no config was found, use the default config
     if (!_cachedConfig) {
-        logger.info("No config found. Using default config.");
+        logger.debug("No config found. Using default config.");
         _cachedConfig = defaultConfig;
     }
     return _cachedConfig;
@@ -112,13 +112,14 @@ export function searchConfig(directory, logger) {
     }
     return null;
 }
+const loggedConfigPaths = new Set();
 function resolveConfig(filename, content, logger) {
     // Handle config being part of `needle.config.json`
     if (filename.endsWith("needle.config.json")) {
         try {
             const config = JSON.parse(content);
             if (config.gltf) {
-                logger.info("Found \"gltf\" config at \"" + filename + "\".");
+                logger.info(`Found \"gltf\" config at \"${filename.replaceAll("\\", "/")}\".`);
                 // If the optimization config is a string, it's the usecase
                 if (typeof config.gltf === "string") {
                     return createConfig(config.gltf);
@@ -126,12 +127,15 @@ function resolveConfig(filename, content, logger) {
                 return config.gltf;
             }
             else {
-                logger.info("No \"gltf\" config found in needle.config.json. Using default config.");
+                if (!loggedConfigPaths.has(filename)) {
+                    logger.debug(`No \"gltf\" config found in needle.config.json at \"${filename.replaceAll("\\", "/")}\". You may add a \"gltf\" field to the config with the optimization config. Example: { \"gltf\": { \"usecase\": \"product\" } }. Using default config for glTF optimization now.`);
+                    loggedConfigPaths.add(filename);
+                }
                 return null;
             }
         }
         catch (err) {
-            logger.error(`Failed parsing config \"${err.message}\" at ${filename}`);
+            logger.error(`Failed parsing config \"${err.message}\" at ${filename.replaceAll("\\", "/")}`);
         }
     }
     // Handle config being the content of the file
@@ -141,12 +145,12 @@ function resolveConfig(filename, content, logger) {
         }
         catch (err) {
             if (err instanceof Error)
-                logger.error(`Failed parsing config \"${err.message}\" at ${filename}`);
+                logger.error(`Failed parsing config \"${err.message}\" at ${filename.replaceAll("\\", "/")}`);
             else
-                logger.error(`Failed parsing config \"${err}\" at ${filename}`);
+                logger.error(`Failed parsing config \"${err}\" at ${filename.replaceAll("\\", "/")}`);
         }
     }
     else {
-        logger.error("Invalid config file format. Expected JSON object at " + filename);
+        logger.error("Invalid config file format. Expected JSON object at " + filename.replaceAll("\\", "/"));
     }
 }

package/dist/extensions/NEEDLE_lightmaps/index.js

@@ -1,4 +1,4 @@
-import { Extension, ExtensionProperty, PropertyType } from '@gltf-transform/core';
+import { Extension, ExtensionProperty, PropertyType, TextureChannel } from '@gltf-transform/core';
 import { existsSync, readFileSync } from 'fs';
 import { join, dirname } from 'path';
 import { isLightmap } from '../../utils/texture.js';
@@ -21,8 +21,8 @@ class LightmapProperty extends ExtensionProperty {
         return Object.assign(super.getDefaults(), {});
     }
     /** Public wrapper around protected setRef to register references */
-    setReference(name, value) {
-        this.setRef(name, value);
+    setReference(name, value, attributes) {
+        this.setRef(name, value, attributes);
     }
 }
 /**
@@ -110,7 +110,7 @@ export class NEEDLE_lightmaps_ext extends Extension {
             let texture = null;
             let inputTextureDef;
             if (entry.pointer.startsWith('/textures/') || entry.pointer.startsWith('textures/')) {
-                // Embedded pointer — resolve to Texture via the JSON texture definition
+                // Embedded pointer — resolve  Found lightmapto Texture via the JSON texture definition
                 const prefix = entry.pointer.startsWith('/') ? '/textures/' : 'textures/';
                 const texIndex = parseInt(entry.pointer.substring(prefix.length));
                 const texDef = textureDefs[texIndex];
@@ -142,8 +142,9 @@ export class NEEDLE_lightmaps_ext extends Extension {
             if (texture) {
                 this.resolved.push({ entry, texture, inputTextureDef });
                 // Set a reference so gltf-transform won't prune/dedup this texture
-                const refName = `lightmap_${entry.pointer}`;
-                this.lightmapProp.setReference(refName, texture);
+                const refName = `lightmapTexture_${entry.pointer}`;
+                const channels = TextureChannel.R | TextureChannel.G | TextureChannel.B | TextureChannel.A;
+                this.lightmapProp.setReference(refName, texture, { channels });
                 // Also keep a reference to the buffer
                 const buffer = this.document.getRoot().listBuffers()[0];
                 if (buffer) {
@@ -151,7 +152,7 @@ export class NEEDLE_lightmaps_ext extends Extension {
                 }
             }
             else {
-                logger.error(`NEEDLE_lightmaps: Could not resolve texture for pointer "${entry.pointer}"`);
+                this.document.getLogger().error(`NEEDLE_lightmaps: Could not resolve texture for pointer "${entry.pointer}"`);
                 testAssert(false, `NEEDLE_lightmaps: Could not resolve texture for pointer "${entry.pointer}"`);
             }
         }
@@ -160,8 +161,9 @@ export class NEEDLE_lightmaps_ext extends Extension {
         for (const tex of textures) {
             if (isLightmap(tex) && tex.getMimeType() !== 'image/exr') {
                 const refName = `lightmapTexture_${tex.getName()}`;
-                this.lightmapProp.setReference(refName, tex);
-                logger.info(`Found lightmap texture "${tex.getName()}" (${tex.getMimeType()}) in ${EXTENSION_NAME}`);
+                const channels = TextureChannel.R | TextureChannel.G | TextureChannel.B | TextureChannel.A;
+                this.lightmapProp.setReference(refName, tex, { channels });
+                this.document.getLogger().debug(`[NEEDLE_lightmaps] Found lightmap texture "${tex.getName()}" (${tex.getMimeType()})`);
             }
         }
         return this;

package/dist/extensions/NEEDLE_opaque/NEEDLE_opaque.js

@@ -200,7 +200,7 @@ export function createOpaqueExtension(name, types, opts) {
                     prop.setReference("lightmapTexture", tex, { channels: TextureChannel.R | TextureChannel.G | TextureChannel.B | TextureChannel.A });
                     const texDef = textureDefinitions[i]; // @TODO: textureDefinitions and textures might not be in the same order - we need to find the texture by source index instead of assuming the order is the same
                     const name = tex.getName() || texDef?.name;
-                    logger.info(`Found lightmap texture \"${name}\" (${tex.getMimeType()}) in ${EXTENSION_NAME}`);
+                    logger.debug(`Found lightmap texture \"${name}\" (${tex.getMimeType()}) in ${EXTENSION_NAME}`);
                 }
             }
         }

package/dist/scripts/stats.d.ts

@@ -1,2 +1,5 @@
 import { FileStats } from "../utils/stats.js";
-export declare function calculateStats(inputfile: string): Promise<FileStats>;
+export interface StatsOptions {
+    verbose?: boolean;
+}
+export declare function calculateStats(inputfile: string, options?: StatsOptions): Promise<FileStats>;

package/dist/scripts/stats.js

@@ -1,10 +1,11 @@
-import { NodeIO } from "@gltf-transform/core";
+import { Logger, NodeIO, Verbosity } from "@gltf-transform/core";
 import { ALL_EXTENSIONS } from "@gltf-transform/extensions";
 import draco3d from 'draco3dgltf';
 import { MeshoptDecoder, MeshoptEncoder } from "meshoptimizer";
 import { createNewFilestats } from "../utils/stats.js";
-export async function calculateStats(inputfile) {
+export async function calculateStats(inputfile, options) {
     const io = new NodeIO()
+        .setLogger(new Logger(options?.verbose ? Verbosity.DEBUG : Verbosity.ERROR))
         .registerExtensions(ALL_EXTENSIONS)
         .registerDependencies({
         'draco3d.decoder': await draco3d.createDecoderModule(),

package/dist/transforms/needle_progressive.js

@@ -376,6 +376,11 @@ async function createTextureLod(args, opts) {
                 setLightmapName(newTexture);
                 break;
             default:
+                if (slot.startsWith("lightmapTexture_") || slot.startsWith("lightmap_")) {
+                    newMaterial.setBaseColorTexture(newTexture);
+                    setLightmapName(newTexture);
+                    break;
+                }
                 if (slot.startsWith("/textures/")) {
                     // Ensure the texture is using the alpha channel since we don't know what slots the original texture was used for
                     // see https://linear.app/needle/issue/NE-4985
@@ -408,11 +413,11 @@ async function createTextureLod(args, opts) {
     // Pass compression settings to the new texture
     const compressionSettingsExt = texture.getExtension(NEEDLE_compression_texture.EXTENSION_NAME);
     if (compressionSettingsExt !== undefined && compressionSettingsExt !== null && compressionSettingsExt.getExtensionDefinition) {
-        logger.info("> Pass compression extension to new texture");
+        logger.debug("> Pass compression extension to new texture");
         const newExt = newDoc.createExtension(NEEDLE_compression_texture);
         const compressionSettings = compressionSettingsExt.getExtensionDefinition();
-        if (compressionSettings?.mode === "none") {
-            // if the mode is set to None then we keep that setting for the new texture
+        if (compressionSettings?.mode === "none" || compressionSettings?.mode === "webp" || compressionSettings?.mode === "UASTC" || compressionSettings?.mode === "ETC1S") {
+            // explicit compression mode set by the user — keep it for LOD textures
         }
         else {
             switch (opts.config.usecase) {

package/dist/transforms/needle_toktx.js

@@ -53,6 +53,11 @@ export class NeedleToktxContext {
             if (existsSync(defaultPath))
                 this.env.PATH = `${this.env.PATH};${defaultPath}`;
         }
+        else {
+            const defaultPath = "/usr/local/bin";
+            if (existsSync(defaultPath))
+                this.env.PATH = `${this.env.PATH}:${defaultPath}`;
+        }
         // append default system paths
         if (isUsingWindows && process.env.Path?.length)
             this.env.PATH = `${this.env.PATH};${process.env.Path}`;
@@ -60,11 +65,11 @@ export class NeedleToktxContext {
         if (options.debug) {
             console.log("INFO: Found these paths including ktx:\n\t" + ktxPaths.join("\n\t") + "");
         }
-        else if (ktxPaths?.length <= 0) {
-            if (didLogEnvironmentInfo === false)
-                console.log("INFO: Environment variable 'NEEDLE_TOKTX' not set. Use 'NEEDLE_TOKTX' to specify the directory of the toktx installation (path/to/bin)");
-            didLogEnvironmentInfo = true;
-        }
+        // else if (ktxPaths?.length <= 0) {
+        //     if (didLogEnvironmentInfo === false)
+        //         console.log("INFO: You may set the 'NEEDLE_TOKTX' environment variable to specify the directory of the toktx installation (path/to/bin)")
+        //     didLogEnvironmentInfo = true;
+        // }
     }
     async prepare(document) {
         try {
@@ -72,7 +77,7 @@ export class NeedleToktxContext {
             const logger = document.getLogger();
             this.version = await checkKTXSoftware(logger, this.env);
             if (this.version === null) {
-                logger.warn(`WARN: toktx not found, skipping texture compression. Please install KTX-Software >= ${KTX_SOFTWARE_VERSION_MIN}`);
+                logger.warn(`WARN: toktx not found, skipping KTX2 texture compression. Please install KTX-Software >= ${KTX_SOFTWARE_VERSION_MIN}. You may set the 'NEEDLE_TOKTX' environment variable to specify the directory of the toktx installation (path/to/bin)`);
                 this._prepareFailed = true;
                 return false;
             }
@@ -84,8 +89,7 @@ export class NeedleToktxContext {
             this.numTextures = document.getRoot().listTextures().length;
         }
         catch (e) {
-            console.error(e);
-            console.log("Error preparing toktx transform");
+            console.error("ERR: preparing toktx transform failed: " + e);
             this._prepareFailed = true;
             return false;
         }

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

@@ -1 +1 @@
-export declare const version = "2.15.9";
+export declare const version = "2.15.10-next.0a00d78";

package/dist/utils/version.gen.js

@@ -1 +1 @@
-export const version = "2.15.9";
+export const version = "2.15.10-next.0a00d78";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@needle-tools/gltf-build-pipeline",
-  "version": "2.15.9",
+  "version": "2.15.10-next.0a00d78",
   "description": "Pipeline and tools for optimizing gltf files using gltf-transform and compression settings within glTF extensions",
   "main": "dist/index.js",
   "type": "module",
@@ -55,10 +55,10 @@
     "vitest": "^3.1.1"
   },
   "optionalDependencies": {
-    "@img/sharp-darwin-arm64": "^0.33.4",
-    "@img/sharp-darwin-x64": "^0.33.4",
-    "@img/sharp-linux-arm": "^0.33.4",
-    "@img/sharp-win32-x64": "^0.33.4"
+    "@img/sharp-darwin-arm64": "^0.34.5",
+    "@img/sharp-darwin-x64": "^0.34.5",
+    "@img/sharp-linux-arm": "^0.34.5",
+    "@img/sharp-win32-x64": "^0.34.5"
   },
   "dependencies": {
     "@donmccurdy/caporal": "~0.0.10",
@@ -73,10 +73,10 @@
     "micromatch": "^4.0.5",
     "ndarray": "^1.0.19",
     "ndarray-lanczos": "^0.3.0",
-    "ndarray-pixels": "^2.0.1",
+    "ndarray-pixels": "^5.0.1",
     "p-limit": "3.1.0",
     "semver": "^7.3.7",
-    "sharp": "^0.33.4",
+    "sharp": "^0.34.5",
     "tmp": "^0.2.1",
     "uuid": "^9.0.1",
     "xxhash-wasm": "^1.1.0"