@needle-tools/gltf-build-pipeline 2.13.0 → 2.13.1

package/package.json

@@ -1,79 +1,79 @@
-{
-  "name": "@needle-tools/gltf-build-pipeline",
-  "version": "2.13.0",
-  "description": "Pipeline and tools for optimizing gltf files using gltf-transform and compression settings within glTF extensions",
-  "main": "dist/index.js",
-  "type": "module",
-  "readme": "README.md",
-  "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"
-  },
-  "bin": {
-    "gltf-build-pipeline": "dist/cli/index.js",
-    "needle-gltf": "dist/cli/index.js"
-  },
-  "imports": {
-    "#package.json": "./package.json"
-  },
-  "scripts": {
-    "start": "node scripts/index.mjs",
-    "dev": "npm-watch compile",
-    "publish-package": "npm run compile && npm publish",
-    "prepublishOnly": "npm run compile",
-    "compile": "node tools/prebuild.mjs && (tsc || exit 1) && node tools/postbuild.mjs",
-    "clear-caches": "node scripts/clear-caches.mjs",
-    "limit-caches": "node scripts/limit-caches.mjs",
-    "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"
-  },
-  "devDependencies": {
-    "@types/node": "^18.7.23",
-    "npm-watch": "^0.13.0",
-    "typescript": "^4.9.5"
-  },
-  "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"
-  },
-  "dependencies": {
-    "@donmccurdy/caporal": "~0.0.10",
-    "@gltf-transform/core": "4.2.1",
-    "@gltf-transform/extensions": "4.2.1",
-    "@gltf-transform/functions": "npm:@needle-tools/gltf-transform-functions@4.3.0-alpha.1",
-    "command-exists": "^1.2.9",
-    "command-line-args": "^5.2.1",
-    "draco3dgltf": "^1.5.3",
-    "glob": "^7.2.0",
-    "meshoptimizer": "0.25.0",
-    "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.33.4",
-    "tmp": "^0.2.1",
-    "uuid": "^9.0.1",
-    "xxhash-wasm": "^1.1.0"
-  },
-  "watch": {
-    "compile": {
-      "patterns": [
-        "src"
-      ],
-      "extensions": "ts",
-      "quiet": false
-    }
-  }
-}
+{
+  "name": "@needle-tools/gltf-build-pipeline",
+  "version": "2.13.1",
+  "description": "Pipeline and tools for optimizing gltf files using gltf-transform and compression settings within glTF extensions",
+  "main": "dist/index.js",
+  "type": "module",
+  "readme": "README.md",
+  "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"
+  },
+  "bin": {
+    "gltf-build-pipeline": "dist/cli/index.js",
+    "needle-gltf": "dist/cli/index.js"
+  },
+  "imports": {
+    "#package.json": "./package.json"
+  },
+  "scripts": {
+    "start": "node scripts/index.mjs",
+    "dev": "npm-watch compile",
+    "publish-package": "npm run compile && npm publish",
+    "prepublishOnly": "npm run compile",
+    "compile": "node tools/prebuild.mjs && (tsc || exit 1) && node tools/postbuild.mjs",
+    "clear-caches": "node scripts/clear-caches.mjs",
+    "limit-caches": "node scripts/limit-caches.mjs",
+    "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"
+  },
+  "devDependencies": {
+    "@types/node": "^18.7.23",
+    "npm-watch": "^0.13.0",
+    "typescript": "^4.9.5"
+  },
+  "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"
+  },
+  "dependencies": {
+    "@donmccurdy/caporal": "~0.0.10",
+    "@gltf-transform/core": "4.2.1",
+    "@gltf-transform/extensions": "4.2.1",
+    "@gltf-transform/functions": "npm:@needle-tools/gltf-transform-functions@4.3.0-alpha.1",
+    "command-exists": "^1.2.9",
+    "command-line-args": "^5.2.1",
+    "draco3dgltf": "^1.5.3",
+    "glob": "^7.2.0",
+    "meshoptimizer": "0.25.0",
+    "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.33.4",
+    "tmp": "^0.2.1",
+    "uuid": "^9.0.1",
+    "xxhash-wasm": "^1.1.0"
+  },
+  "watch": {
+    "compile": {
+      "patterns": [
+        "src"
+      ],
+      "extensions": "ts",
+      "quiet": false
+    }
+  }
+}

package/scripts/clear-caches.mjs

@@ -1,4 +1,4 @@
-
-import { clearCache } from '../dist/cache/index.js';
-
+
+import { clearCache } from '../dist/cache/index.js';
+
 clearCache();

package/scripts/defaults.mjs

@@ -1,12 +1,12 @@
-import { ALL_EXTENSIONS } from '@gltf-transform/extensions';
-import { ALL_EXTENSIONS as NEEDLE_EXTENSIONS } from "../dist/extensions/NEEDLE_opaque/index.js";
-import { NEEDLE_progressive } from '../dist/index.js';
-
-
-export function registerExtensions(node) {
-    node.registerExtensions(ALL_EXTENSIONS);
-    node.registerExtensions(NEEDLE_EXTENSIONS);
-    node.registerExtensions([
-        NEEDLE_progressive
-    ])
+import { ALL_EXTENSIONS } from '@gltf-transform/extensions';
+import { ALL_EXTENSIONS as NEEDLE_EXTENSIONS } from "../dist/extensions/NEEDLE_opaque/index.js";
+import { NEEDLE_progressive } from '../dist/index.js';
+
+
+export function registerExtensions(node) {
+    node.registerExtensions(ALL_EXTENSIONS);
+    node.registerExtensions(NEEDLE_EXTENSIONS);
+    node.registerExtensions([
+        NEEDLE_progressive
+    ])
 }

package/scripts/fileutils.mjs

@@ -1,6 +1,6 @@
-import { foreachGLTF as foreach } from '../dist/index.js';
-
-
-export function foreachGLTF(args, callback) {
-    return foreach(args, callback);
+import { foreachGLTF as foreach } from '../dist/index.js';
+
+
+export function foreachGLTF(args, callback) {
+    return foreach(args, callback);
 }

package/scripts/index.mjs

@@ -1,41 +1,41 @@
-
-import { spawnSync } from "child_process";
-import { getVersion } from "../dist/index.js";
-
-const workingDir = process.cwd();
-
-// Original invoked dir set by npm
-// const dir = process.env.INIT_CWD;
-
-
-const defaultArgs = { shell: true, cwd: workingDir, stdio: 'inherit' }
-
-function getCommandLineArgs(_cmd) {
-    // Wrap paths with parentheses if they contain spaces
-    const args = process.argv.slice(2);
-    for (let i = 0; i < args.length; i++) {
-        const arg = args[i];
-        if (arg.includes("\\") || arg.includes("/")) {
-            if (arg.includes(" "))
-                args[i] = "\"" + arg + "\"";
-        }
-    }
-    return args;
-}
-
-
-function runWithArgs(cmd) {
-    const commandline_args = getCommandLineArgs(cmd).join(" ");
-    spawnSync(cmd + " " + commandline_args, defaultArgs);
-}
-
-try {
-    const startTime = Date.now();
-    runWithArgs("node scripts/make-progressive.mjs");
-    runWithArgs("node scripts/pack-gltf.mjs");
-    const durationInMinutes = ((Date.now() - startTime) / 1000 / 60).toFixed(1);
-    console.log(`[Needle Build Pipeline] v${getVersion()} — Finished progressive transform and optimization in ${durationInMinutes} minutes.`);
-}
-catch (err) {
-    console.error("Failed running commandline args:", err.message);
-}
+
+import { spawnSync } from "child_process";
+import { getVersion } from "../dist/index.js";
+
+const workingDir = process.cwd();
+
+// Original invoked dir set by npm
+// const dir = process.env.INIT_CWD;
+
+
+const defaultArgs = { shell: true, cwd: workingDir, stdio: 'inherit' }
+
+function getCommandLineArgs(_cmd) {
+    // Wrap paths with parentheses if they contain spaces
+    const args = process.argv.slice(2);
+    for (let i = 0; i < args.length; i++) {
+        const arg = args[i];
+        if (arg.includes("\\") || arg.includes("/")) {
+            if (arg.includes(" "))
+                args[i] = "\"" + arg + "\"";
+        }
+    }
+    return args;
+}
+
+
+function runWithArgs(cmd) {
+    const commandline_args = getCommandLineArgs(cmd).join(" ");
+    spawnSync(cmd + " " + commandline_args, defaultArgs);
+}
+
+try {
+    const startTime = Date.now();
+    runWithArgs("node scripts/make-progressive.mjs");
+    runWithArgs("node scripts/pack-gltf.mjs");
+    const durationInMinutes = ((Date.now() - startTime) / 1000 / 60).toFixed(1);
+    console.log(`[Needle Build Pipeline] v${getVersion()} — Finished progressive transform and optimization in ${durationInMinutes} minutes.`);
+}
+catch (err) {
+    console.error("Failed running commandline args:", err.message);
+}

package/scripts/limit-caches.mjs

@@ -1,4 +1,4 @@
-
-import { limitCacheSize } from '../dist/cache/index.js';
-
+
+import { limitCacheSize } from '../dist/cache/index.js';
+
 limitCacheSize(512);

package/scripts/make-progressive.mjs

@@ -1,16 +1,16 @@
-import { getConfig, getVersion } from '../dist/index.js';
-import { make_progressive } from '../dist/transforms/needle_progressive.js';
-
-const args = process.argv;
-
-console.log(`[Needle Build Pipeline] transform to progressive — version ${getVersion()}`)
-
-make_progressive({
-    path: args,
-    results: [],
-    config: getConfig(),
-    debug: args.includes("--debug"),
-    useCache: args.includes("--no-caching") === false,
-});
-
-
+import { getConfig, getVersion } from '../dist/index.js';
+import { make_progressive } from '../dist/transforms/needle_progressive.js';
+
+const args = process.argv;
+
+console.log(`[Needle Build Pipeline] transform to progressive — version ${getVersion()}`)
+
+make_progressive({
+    path: args,
+    results: [],
+    config: getConfig(),
+    debug: args.includes("--debug"),
+    useCache: args.includes("--no-caching") === false,
+});
+
+

package/scripts/pack-gltf.mjs

@@ -1,107 +1,107 @@
-import commandLineArgs from "command-line-args";
-import { foreachGLTF } from './fileutils.mjs';
-import { getVersion, limitCacheSize, getConfig, packGLTF, printStats } from '../dist/index.js';
-import { Logger, Verbosity } from "@gltf-transform/core";
-
-console.log(`[Needle Build Pipeline] pack glTF — version ${getVersion()}`)
-
-const args = process.argv;
-const showHelp = args.includes("help");
-
-const optionDefinitions = [
-    { name: 'debug', type: Boolean },
-    { name: 'toktxPath', type: String, multiple: true },
-    { name: 'file', type: String, multiple: true },
-];
-let options = undefined;
-try {
-    options = commandLineArgs(optionDefinitions);
-}
-catch (err) {
-    if (args?.includes("debug"))
-        console.log("Failed parsing commandline args:", err.message);
-    options = {
-        file: [...process.argv],
-        debug: args?.includes("debug"),
-        toktxPath: new Array(),
-    };
-    for (const arg of args) {
-        if (arg.includes("KTX-Software")) {
-            options.toktxPath = [arg];
-            break;
-        }
-    }
-}
-
-const toktxPaths = options?.toktxPath?.join(";");
-if (showHelp) {
-    if (!toktxPaths) {
-        console.log("You can define a toktx search path by adding --toktxPath <path> to the command line. The command may appear multiple times");
-    }
-    else console.log("Toktx path at " + toktxPaths);
-}
-
-// console.log(args);
-const debug = options?.debug ?? false;
-if (debug) {
-    console.log(options);
-}
-
-let allowCaching = true;
-if (args.includes("--no-caching")) {
-    allowCaching = false;
-}
-else console.log("Use --no-caching to disable caching");
-
-const noToktx = args.includes("no-toktx");
-if (noToktx)
-    console.log("Using toktx is disabled");
-
-const packedFiles = new Set();
-
-/**
- * @type {import("../dist/index.js").ProcessStats}
- */
-const stats = {
-    startTime: Date.now(),
-    totalGPUMemoryInMB: 0,
-    totalFilesProcessed: 0,
-    totalFileSizeInMB: 0,
-    totalFileSizeInMBBefore: 0,
-};
-
-const config = getConfig();
-
-
-/** Compress a glTF file
- * @param {string} file
- */
-async function packFile(file) {
-    return packGLTF(file, file, {
-        config,
-        debug,
-        packedFiles,
-        useCache: allowCaching,
-        stats,
-    })
-}
-
-const inputArgs = args.slice(2);
-let failed = false;
-const logger = new Logger(Verbosity.INFO);
-
-foreachGLTF(inputArgs, async (file) => {
-    const res = await packFile(file);
-    if (!res) failed = true;
-}).then(async () => {
-    if (allowCaching) {
-        limitCacheSize();
-    }
-    printStats(stats, logger, config);
-    if (failed) {
-        process.exit(1);
-    }
-}).catch(err => {
-    console.error("ERR: packing failed: " + err.message);
-    if (debug) throw err;
+import commandLineArgs from "command-line-args";
+import { foreachGLTF } from './fileutils.mjs';
+import { getVersion, limitCacheSize, getConfig, packGLTF, printStats } from '../dist/index.js';
+import { Logger, Verbosity } from "@gltf-transform/core";
+
+console.log(`[Needle Build Pipeline] pack glTF — version ${getVersion()}`)
+
+const args = process.argv;
+const showHelp = args.includes("help");
+
+const optionDefinitions = [
+    { name: 'debug', type: Boolean },
+    { name: 'toktxPath', type: String, multiple: true },
+    { name: 'file', type: String, multiple: true },
+];
+let options = undefined;
+try {
+    options = commandLineArgs(optionDefinitions);
+}
+catch (err) {
+    if (args?.includes("debug"))
+        console.log("Failed parsing commandline args:", err.message);
+    options = {
+        file: [...process.argv],
+        debug: args?.includes("debug"),
+        toktxPath: new Array(),
+    };
+    for (const arg of args) {
+        if (arg.includes("KTX-Software")) {
+            options.toktxPath = [arg];
+            break;
+        }
+    }
+}
+
+const toktxPaths = options?.toktxPath?.join(";");
+if (showHelp) {
+    if (!toktxPaths) {
+        console.log("You can define a toktx search path by adding --toktxPath <path> to the command line. The command may appear multiple times");
+    }
+    else console.log("Toktx path at " + toktxPaths);
+}
+
+// console.log(args);
+const debug = options?.debug ?? false;
+if (debug) {
+    console.log(options);
+}
+
+let allowCaching = true;
+if (args.includes("--no-caching")) {
+    allowCaching = false;
+}
+else console.log("Use --no-caching to disable caching");
+
+const noToktx = args.includes("no-toktx");
+if (noToktx)
+    console.log("Using toktx is disabled");
+
+const packedFiles = new Set();
+
+/**
+ * @type {import("../dist/index.js").ProcessStats}
+ */
+const stats = {
+    startTime: Date.now(),
+    totalGPUMemoryInMB: 0,
+    totalFilesProcessed: 0,
+    totalFileSizeInMB: 0,
+    totalFileSizeInMBBefore: 0,
+};
+
+const config = getConfig();
+
+
+/** Compress a glTF file
+ * @param {string} file
+ */
+async function packFile(file) {
+    return packGLTF(file, file, {
+        config,
+        debug,
+        packedFiles,
+        useCache: allowCaching,
+        stats,
+    })
+}
+
+const inputArgs = args.slice(2);
+let failed = false;
+const logger = new Logger(Verbosity.INFO);
+
+foreachGLTF(inputArgs, async (file) => {
+    const res = await packFile(file);
+    if (!res) failed = true;
+}).then(async () => {
+    if (allowCaching) {
+        limitCacheSize();
+    }
+    printStats(stats, logger, config);
+    if (failed) {
+        process.exit(1);
+    }
+}).catch(err => {
+    console.error("ERR: packing failed: " + err.message);
+    if (debug) throw err;
 });

package/tsconfig.json

@@ -1,20 +1,20 @@
-{
-    "compilerOptions": {
-        "target": "ESNext",
-        "rootDir": "src",
-        "outDir": "dist",
-        "declaration": true,
-        "moduleResolution": "NodeNext",
-        "module": "NodeNext",
-        "esModuleInterop": true,
-        "skipLibCheck": true,
-        "resolveJsonModule": true,
-        "lib": [
-            "ESNext",
-            "DOM"
-        ],
-    },
-    "include": [
-        "src/index.ts",
-    ]
+{
+    "compilerOptions": {
+        "target": "ESNext",
+        "rootDir": "src",
+        "outDir": "dist",
+        "declaration": true,
+        "moduleResolution": "NodeNext",
+        "module": "NodeNext",
+        "esModuleInterop": true,
+        "skipLibCheck": true,
+        "resolveJsonModule": true,
+        "lib": [
+            "ESNext",
+            "DOM"
+        ],
+    },
+    "include": [
+        "src/index.ts",
+    ]
 }