@needle-tools/gltf-build-pipeline 2.4.0 → 2.5.0-beta

package/dist/cache/cache.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" resolution-mode="require"/>
 import { ExtensibleProperty } from "@gltf-transform/core";
 import { Logger } from "@donmccurdy/caporal";
 /**
@@ -16,7 +17,7 @@ export declare function limitCacheSize(maxSizeMB?: number): void;
  * @param key The key to store the data under.
  * @param bytes The data to store as a Uint8Array.
  */
-export declare function addToCache(key: string, bytes: Uint8Array): void;
+export declare function addToCache(key: string, bytes: Uint8Array | Buffer): void;
 /**
  * Try to get the data from the cache.
  * @param key The key to look up.

package/dist/cache/cache.js

@@ -91,6 +91,8 @@ export function addToCache(key, bytes) {
     const path = `${dir}/${key}.bin`;
     if (debugLogs)
         console.log(`Added ${(bytes.byteLength / 1024).toFixed(1)} KB to cache at \"${path}\"`);
+    if (bytes instanceof Buffer)
+        bytes = new Uint8Array(bytes);
     fs.writeFileSync(path, bytes);
 }
 /**
@@ -104,6 +106,8 @@ export function tryGetFromCache(key) {
     const path = `${dir}/${key}.bin`;
     if (fs.existsSync(path)) {
         const bytes = fs.readFileSync(path);
+        if (bytes instanceof Buffer)
+            return new Uint8Array(bytes);
         return bytes;
     }
     return null;

package/dist/transforms/needle_asset.d.ts

@@ -1,3 +1,3 @@
 import { Document, Transform } from '@gltf-transform/core';
-export declare function writeNeedleAsset(document: Document): void;
+export declare function writeNeedleAsset(document: Document, metadata?: Record<string, object | string | number | boolean>): void;
 export declare function needle_asset(): Transform;

package/dist/transforms/needle_asset.js

@@ -1,11 +1,13 @@
 import { createTransform } from '@gltf-transform/functions';
 import { getVersion } from '../index.js';
 const generatorName = "Needle Build Pipeline";
-export function writeNeedleAsset(document) {
+export function writeNeedleAsset(document, metadata) {
     const root = document.getRoot();
     const asset = root.getAsset();
     if (asset) {
         asset.extras = writeNeedleExtras(asset.extras);
+        if (metadata)
+            asset.extras = Object.assign(asset.extras, metadata);
         const version = getVersion();
         asset.generator = generatorName;
         if (version?.length > 0) {

package/dist/transforms/needle_progressive.js

@@ -218,7 +218,8 @@ export function make_progressive_textures(filePath, _options = TEXTURE_RESIZE_DE
                 const level = LOD_LEVEL[i];
                 const lodResult = await createTextureLod({
                     doc,
-                    file: filePath,
+                    inputFilepath: filePath,
+                    inputFilename: filename,
                     basePath: textureLodBasePath,
                     level: i,
                     texture,
@@ -269,11 +270,15 @@ export function make_progressive_textures(filePath, _options = TEXTURE_RESIZE_DE
     });
 }
 async function createTextureLod(args, opts) {
-    const { doc, file, basePath, level, texture, guid, textureIndex } = args;
+    const { doc, inputFilepath: file, basePath, level, texture, guid, textureIndex } = args;
     let slots = args.slots;
     const logger = doc.getLogger();
     const newDoc = new Document();
-    writeNeedleAsset(newDoc);
+    writeNeedleAsset(newDoc, {
+        source: {
+            filename: args.inputFilename
+        }
+    });
     const scene = newDoc.createScene();
     const buffer = newDoc.createBuffer();
     // add texture
@@ -593,7 +598,7 @@ export function make_progressive_meshes(filePath, _options, opts) {
                     const lod = LODS[level];
                     const guid = settings.guid;
                     // TODO: check if the LOD level did actually change the mesh - otherwise we can just skip generating lower resolutions
-                    const lodTask = createMeshLod(doc, outputDirectory, level, mesh, originalMeshInformation, guid, lod, opts);
+                    const lodTask = createMeshLod(filename, doc, outputDirectory, level, mesh, originalMeshInformation, guid, lod, opts);
                     lodTask.then(res => {
                         if (res?.success) {
                             generatedLODInfos[level] = res;
@@ -773,7 +778,7 @@ function setPrimitiveData(prim, data) {
  * @param guid a unique identifier for the mesh
  * @param error the error to use for simplification. Higher means more simplification
  */
-async function createMeshLod(doc, basePath, level, mesh, meshInfo, guid, lodLevel, opts) {
+async function createMeshLod(inputFileName, doc, basePath, level, mesh, meshInfo, guid, lodLevel, opts) {
     const logger = doc.getLogger();
     const fileExtension = ".glb";
     const fileName_withoutExtension = "mesh_lod_" + level + "_" + guid;
@@ -803,7 +808,11 @@ async function createMeshLod(doc, basePath, level, mesh, meshInfo, guid, lodLeve
         }
     }
     const newDoc = new Document();
-    writeNeedleAsset(newDoc);
+    writeNeedleAsset(newDoc, {
+        "source": {
+            filename: inputFileName,
+        }
+    });
     const newScene = newDoc.createScene();
     newDoc.createBuffer();
     const newNode = newDoc.createNode();

package/package.json

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