@needle-tools/gltf-build-pipeline 1.6.0-alpha.3 → 1.6.0-alpha.5

package/CHANGELOG.md

@@ -4,8 +4,9 @@ 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).
 
-## [1.6.0-alpha.3] - 2023-05-28
+## [1.6.0-alpha.5] - 2023-05-28
 - fix: determine build pipeline version
+- change: throw error and exit process if packing or transform fails
 
 ## [1.6.0-alpha.2] - 2023-05-27
 - add: `gltf-build-pipeline` commandline support with `transform` and `compress` (pack-gltf) options.

package/dist/package.json

@@ -0,0 +1,66 @@
+{
+    "name": "@needle-tools/gltf-build-pipeline",
+    "version": "1.6.0-alpha.5",
+    "description": "Pipeline and tools for optimizing gltf files using gltf-transform and compression settings within glTF extensions",
+    "main": "index.mjs",
+    "type": "module",
+    "readme": "README.md",
+    "bin": {
+        "gltf-build-pipeline": "./dist/src/cli/index.js"
+    },
+    "scripts": {
+        "start": "node scripts/index.mjs",
+        "dev": "npm-watch compile",
+        "transform": "node scripts/index.mjs",
+        "transform:make-progressive": "node scripts/make-progressive.mjs",
+        "transform:pack-gltf": "node --no-experimental-fetch scripts/pack-gltf.mjs",
+        "pack-gltf": "node --no-experimental-fetch scripts/pack-gltf.mjs",
+        "dev:pack-gltf": "npm run compile && node scripts/pack-gltf.mjs",
+        "clear-caches": "node scripts/clear-caches.mjs",
+        "limit-caches": "node scripts/limit-caches.mjs",
+        "compile": "tsc || exit 1"
+    },
+    "dependencies": {
+        "@donmccurdy/caporal": "~0.0.10",
+        "@gltf-transform/core": "^3.10.1",
+        "@gltf-transform/extensions": "^3.10.1",
+        "@gltf-transform/functions": "^3.10.1",
+        "command-exists": "^1.2.9",
+        "command-line-args": "^5.2.1",
+        "draco3dgltf": "^1.5.3",
+        "glob": "^7.2.0",
+        "meshoptimizer": "^0.18.1",
+        "micromatch": "^4.0.5",
+        "ndarray": "^1.0.19",
+        "ndarray-lanczos": "^0.3.0",
+        "ndarray-pixels": "^2.0.1",
+        "p-limit": "3.1.0",
+        "semver": "^7.3.7",
+        "sharp": "^0.32.6",
+        "tmp": "^0.2.1",
+        "uuid": "^9.0.1"
+    },
+    "watch": {
+        "compile": {
+            "patterns": [
+                "src"
+            ],
+            "extensions": "ts",
+            "quiet": false
+        }
+    },
+    "devDependencies": {
+        "@types/node": "^18.7.23",
+        "npm-watch": "^0.11.0",
+        "typescript": "^4.9.5"
+    },
+    "author": {
+        "name": "Needle",
+        "email": "help@needle.tools",
+        "url": "https://needle.tools/"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/needle-tools/needle-gltf-extensions.git"
+    }
+}

package/dist/{cli → src/cli}/index.js

@@ -9,6 +9,7 @@ import { cacheSizeLimit, clearCache } from '../cache/cache.js';
 import { existsSync, statSync } from 'fs';
 import { foreachGLTF } from '../utils/fileutils.js';
 import { dirname } from 'path';
+import { ERROR_CODES } from '../constants.js';
 // For testing / dev you can run `npm link` in the package directory
 // For removing the link run `npm rm --global @needle-tools/gltf-build-pipeline`
 program
@@ -77,7 +78,7 @@ Compress a single glTF file. The input file is compressed and written to the out
             const filename = file.replaceAll("\\", "/").split("/").pop();
             outputFile = options.output?.toString() + "/" + filename;
         }
-        await packGLTF(file, outputFile, {
+        const res = await packGLTF(file, outputFile, {
             config,
             packedFiles: set,
             stats,
@@ -86,6 +87,9 @@ Compress a single glTF file. The input file is compressed and written to the out
             logger: logger,
             file_stats: file_stats,
         });
+        if (!res) {
+            process.exit(ERROR_CODES.PACKING_FAILED);
+        }
     });
     printStats(stats);
     console.log("Stats: ", options);
@@ -136,6 +140,9 @@ Each version will be compressed and written to the output directory.
             config,
             debug: false,
             useCache: true,
+        }).catch(err => {
+            logger.error(err);
+            process.exit(ERROR_CODES.PROGRESSIVE_FAILED);
         });
         const opts = {
             config,
@@ -148,10 +155,14 @@ Each version will be compressed and written to the output directory.
         };
         for (const res of progressive_results) {
             logger.info("> Compress " + res);
-            await packGLTF(res, res, opts);
+            if (!await packGLTF(res, res, opts)) {
+                process.exit(ERROR_CODES.PACKING_FAILED);
+            }
         }
         logger.info("> Compress " + file);
-        await packGLTF(file, file, opts);
+        if (!await packGLTF(file, file, opts)) {
+            process.exit(ERROR_CODES.PACKING_FAILED);
+        }
     });
     printStats(stats);
     if (options.outputStats) {

package/dist/src/constants.d.ts

@@ -0,0 +1,5 @@
+export declare const ERROR_CODES: {
+    UNKNOWN_ERROR: number;
+    PACKING_FAILED: number;
+    PROGRESSIVE_FAILED: number;
+};

package/dist/src/constants.js

@@ -0,0 +1,5 @@
+export const ERROR_CODES = {
+    UNKNOWN_ERROR: 1,
+    PACKING_FAILED: 2,
+    PROGRESSIVE_FAILED: 3,
+};

package/dist/{index.d.ts → src/index.d.ts}

@@ -5,3 +5,4 @@ export * from "./transforms/index.js";
 export * from "./extensions/index.js";
 export * from "./cache/index.js";
 export * from "./scripts/index.js";
+export * from "./constants.js";

package/dist/{index.js → src/index.js}

@@ -5,3 +5,4 @@ export * from "./transforms/index.js";
 export * from "./extensions/index.js";
 export * from "./cache/index.js";
 export * from "./scripts/index.js";
+export * from "./constants.js";

package/dist/{transforms → src/transforms}/needle_progressive.js

@@ -53,15 +53,7 @@ async function onProcess(file, opts) {
             'draco3d.decoder': await draco3d.createDecoderModule(),
             'draco3d.encoder': await draco3d.createEncoderModule(),
         });
-        const document = await io.read(file).catch((err) => {
-            // Log this message as a warning, it happens when trying to run on a already compressed gltf file (e.g. pre-processed. When logging an error we fail the build which is not desired)
-            if (err.message === "Cannot read properties of undefined (reading 'DT_FLOAT32')") {
-                console.log("WARN: \"" + err.message + "\" at \"" + file + "\"");
-            }
-            else
-                console.log("ERR: \"" + err.message + "\" at \"" + file + "\"\nStacktrace:\n" + err.stack);
-            return;
-        });
+        let document = await io.read(file);
         if (document) {
             if (opts.debug === true) {
                 if (file.includes(".debug.")) {

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

@@ -0,0 +1 @@
+export declare function getVersion(_marklocal?: boolean): string;

package/dist/src/utils/version.js

@@ -0,0 +1,5 @@
+import packageJson from "../../package.json" assert { type: "json" };
+export function getVersion(_marklocal = true) {
+    let res = packageJson.version;
+    return res;
+}

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@needle-tools/gltf-build-pipeline",
-  "version": "1.6.0-alpha.3",
+  "version": "1.6.0-alpha.5",
   "description": "Pipeline and tools for optimizing gltf files using gltf-transform and compression settings within glTF extensions",
   "main": "index.mjs",
   "type": "module",
   "readme": "README.md",
   "bin": {
-    "gltf-build-pipeline": "./dist/cli/index.js"
+    "gltf-build-pipeline": "./dist/src/cli/index.js"
   },
   "scripts": {
     "start": "node scripts/index.mjs",
@@ -63,4 +63,4 @@
     "type": "git",
     "url": "git+https://github.com/needle-tools/needle-gltf-extensions.git"
   }
-}
+}

package/tsconfig.json

@@ -6,7 +6,8 @@
         "moduleResolution": "NodeNext",
         "module": "ESNext",
         "esModuleInterop": true,
-        "skipLibCheck": true
+        "skipLibCheck": true,
+        "resolveJsonModule": true
         
     },
     "include": [

package/dist/utils/version.d.ts

@@ -1 +0,0 @@
-export declare function getVersion(marklocal?: boolean): string;

package/dist/utils/version.js

@@ -1,40 +0,0 @@
-import { existsSync, readFileSync, statSync } from 'fs';
-let version = undefined;
-let isLocal = false;
-export function getVersion(marklocal = true) {
-    if (version === undefined) {
-        console.log(process.argv);
-        const scriptLocation = process.argv[1].replaceAll("\\", "/");
-        console.log("Determining version from " + scriptLocation);
-        const path = scriptLocation.split('/');
-        let packageJsonPath = null;
-        while (path.length) {
-            const dirname = path.join('/');
-            if (statSync(dirname).isDirectory()) {
-                const filename = dirname + '/package.json';
-                if (existsSync(filename)) {
-                    packageJsonPath = filename;
-                    break;
-                }
-            }
-            path.pop();
-        }
-        if (packageJsonPath) {
-            isLocal = !path.includes("node_modules");
-            if (existsSync(packageJsonPath)) {
-                const packageJson = readFileSync(packageJsonPath, "utf8");
-                const packageVersion = JSON.parse(packageJson).version;
-                version = packageVersion ?? null;
-            }
-            else
-                console.log("Could not find package.json at " + packageJsonPath);
-        }
-        if (!version) {
-            throw new Error("Could not determine version");
-        }
-    }
-    let res = version;
-    if (marklocal && isLocal)
-        res += " (local)";
-    return res;
-}