@needle-tools/gltf-build-pipeline 2.1.0-alpha.6 → 2.2.0-alpha.2

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@needle-tools/gltf-build-pipeline",
-  "version": "2.1.0-alpha.6",
+  "version": "2.2.0-alpha.2",
   "description": "Pipeline and tools for optimizing gltf files using gltf-transform and compression settings within glTF extensions",
-  "main": "index.mjs",
+  "main": "dist/index.js",
   "type": "module",
   "readme": "README.md",
   "author": {
@@ -15,14 +15,17 @@
     "url": "git+https://github.com/needle-tools/needle-gltf-extensions.git"
   },
   "bin": {
-    "gltf-build-pipeline": "./dist/src/cli/index.js",
-    "needle-gltf": "./dist/src/cli/index.js"
+    "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",
-    "compile": "tsc || exit 1",
-    "clear-caches":  "node scripts/clear-caches.mjs",
+    "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",
@@ -31,7 +34,6 @@
     "dev:pack-gltf": "npm run compile && node scripts/pack-gltf.mjs"
   },
   "devDependencies": {
-    "@img/sharp-win32-x64": "^0.33.4",
     "@types/node": "^18.7.23",
     "npm-watch": "^0.13.0",
     "typescript": "^4.9.5"
@@ -44,7 +46,6 @@
   },
   "dependencies": {
     "@donmccurdy/caporal": "~0.0.10",
-    "@gltf-transform/cli": "^4.0.1",
     "@gltf-transform/core": "^4.0.1",
     "@gltf-transform/extensions": "^4.0.1",
     "@gltf-transform/functions": "^4.0.1",
@@ -72,4 +73,4 @@
       "quiet": false
     }
   }
-}
+}

package/scripts/clear-caches.mjs

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

package/scripts/defaults.mjs

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

package/scripts/fileutils.mjs

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

package/scripts/index.mjs

@@ -1,6 +1,6 @@
 
 import { spawnSync } from "child_process";
-import { getVersion } from "../dist/src/index.js";
+import { getVersion } from "../dist/index.js";
 
 const workingDir = process.cwd();
 

package/scripts/limit-caches.mjs

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

package/scripts/make-progressive.mjs

@@ -1,5 +1,5 @@
-import { getConfig, getVersion } from '../dist/src/index.js';
-import { make_progressive } from '../dist/src/transforms/needle_progressive.js';
+import { getConfig, getVersion } from '../dist/index.js';
+import { make_progressive } from '../dist/transforms/needle_progressive.js';
 
 const args = process.argv;
 

package/scripts/pack-gltf.mjs

@@ -1,6 +1,6 @@
 import commandLineArgs from "command-line-args";
 import { foreachGLTF } from './fileutils.mjs';
-import { getVersion, limitCacheSize, getConfig, packGLTF, printStats } from '../dist/src/index.js';
+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()}`)
@@ -60,7 +60,7 @@ if (noToktx)
 const packedFiles = new Set();
 
 /**
- * @type {import("../dist/src/index.js").Stats}
+ * @type {import("../dist/index.js").Stats}
  */
 const stats = {
     startTime: Date.now(),

package/tsconfig.json

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

package/dist/___config.json

@@ -1,3 +0,0 @@
-{
-    "usecase": "test"
-}

package/dist/package.json

@@ -1,75 +0,0 @@
-{
-    "name": "@needle-tools/gltf-build-pipeline",
-    "version": "2.1.0-alpha.6",
-    "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",
-    "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/src/cli/index.js",
-        "needle-gltf": "./dist/src/cli/index.js"
-    },
-    "scripts": {
-        "start": "node scripts/index.mjs",
-        "dev": "npm-watch compile",
-        "compile": "tsc || exit 1",
-        "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": {
-        "@img/sharp-win32-x64": "^0.33.4",
-        "@types/node": "^18.7.23",
-        "npm-watch": "^0.13.0",
-        "typescript": "^4.9.5"
-    },
-    "optionalDependencies": {
-        "@img/sharp-linux-arm": "^0.33.4",
-        "@img/sharp-win32-x64": "^0.33.4",
-        "@img/sharp-darwin-arm64": "^0.33.4",
-        "@img/sharp-darwin-x64": "^0.33.4"
-    },
-    "dependencies": {
-        "@donmccurdy/caporal": "~0.0.10",
-        "@gltf-transform/cli": "^4.0.1",
-        "@gltf-transform/core": "^4.0.1",
-        "@gltf-transform/extensions": "^4.0.1",
-        "@gltf-transform/functions": "^4.0.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.33.4",
-        "tmp": "^0.2.1",
-        "uuid": "^9.0.1"
-    },
-    "watch": {
-        "compile": {
-            "patterns": [
-                "src"
-            ],
-            "extensions": "ts",
-            "quiet": false
-        }
-    }
-}

package/dist/src/cli/index.js

@@ -1,192 +0,0 @@
-#! /usr/bin/env node
-import { program } from '@donmccurdy/caporal';
-import { packGLTF } from "../scripts/index.js";
-import { printStats, writeFileStatsToFile } from '../utils/stats.js';
-import { getVersion } from '../utils/version.js';
-import { UsecaseOptions, createConfig, getConfig } from '../config/index.js';
-import { make_progressive } from '../transforms/needle_progressive.js';
-import { cacheSizeLimit, clearCache } from '../cache/cache.js';
-import { existsSync, statSync } from 'fs';
-import { foreachGLTF, getDirName } from '../utils/fileutils.js';
-import path, { 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
-    .command("version", "Print current verison")
-    .action(async ({ logger }) => {
-    logger.info(getVersion());
-})
-    .command("clear-caches", "Clear all caches")
-    .help(`Clears all cached files
-Caches are limited to ${cacheSizeLimit} MB disc space by default.
-`)
-    .action(async ({ logger }) => {
-    logger.info("Clearing caches");
-    clearCache(logger);
-})
-    .command("compress", "Compress glTF, GLB or VRM files")
-    .help(`
-Compress a single glTF file. The input file is compressed and written to the output file.  
-`)
-    .argument('<input>', "The input glTF, GLB or VRM file that should be compressed OR a directory that contains files to be compressed")
-    .argument('<output>', "The output file. If not provided, the input file will be overwritten.", { default: "" })
-    .option("--usecase <usecase>", `The usecase for the compression allows you to determine how your asset is supposed to be used:\nThis will set compression and transform settings on a high level if no other settings are found.\nPossible options: [${UsecaseOptions.join(", ")}] e.g. \"--usecase ${UsecaseOptions[0]}\"`, { validator: program.STRING })
-    .option("--config <config>", "The path to a JSON file containing the compression settings. This can also be a needle.config.json file with a \"compression\" object or usecase string.", { validator: program.STRING })
-    .option("--stats", "Output a stats file next to input file (or inside the input directory). It will be named as the input file/directory \"<input>.needle.stats.json\"", { validator: program.BOOLEAN, default: false })
-    .option("--cache", "Use \"--cache False\" to disable caching.\nWhen caching is enabled then previously processed files will be detected and loaded from disc cache instead of being processed again if settings or the file contents have not changed.", { validator: program.BOOLEAN, default: true })
-    .option("--debug", "Enable for more verbose outout with \"--debug True\"", { validator: program.BOOLEAN, default: false })
-    .action(async ({ logger, args, options }) => {
-    logger.info("Transforming glTF file: " + args.input);
-    const stats = {
-        startTime: Date.now(),
-        totalGPUMemoryInMB: 0,
-        totalFilesProcessed: 0,
-        totalFileSizeInMB: 0,
-        totalFileSizeInMBBefore: 0,
-    };
-    const file = args.input.toString();
-    let config = getConfig(options.config?.toString(), file);
-    if (options.usecase) {
-        logger.info("Using usecase: " + options.usecase);
-        config = { ...createConfig(options.usecase.toString()), ...config, };
-        if (config.usecase != "default" && config.usecase != options.usecase.toString()) {
-            logger.warn(`Conflicting usecase. Your specific config at \"${options.config}\" has a different usecase than the one provided by the CLI: \"${options.usecase}\". Using the usecase from the config file.`);
-        }
-        else {
-            config.usecase = options.usecase.toString();
-        }
-    }
-    const debug = options.debug === true;
-    const isDirectory = statSync(file).isDirectory();
-    const outDir = isDirectory ? file : dirname(file);
-    let outputIsDirectory = false;
-    if (statSync(file).isDirectory() && options.output) {
-        if (statSync(options.output.toString()).isDirectory()) {
-            outputIsDirectory = true;
-            if (!existsSync(options.output.toString())) {
-                logger.error("Output directory does not exist: " + options.output.toString());
-                return;
-            }
-        }
-        else {
-            logger.error("--output must be a directory if input is a directory");
-            return;
-        }
-    }
-    const file_stats = [];
-    const set = new Set();
-    await foreachGLTF(file, async (file) => {
-        let outputFile = args.output?.toString();
-        if (!outputFile?.length) {
-            outputFile = file;
-        }
-        if (outputIsDirectory) {
-            const filename = file.replaceAll("\\", "/").split("/").pop();
-            outputFile = args.output?.toString() + "/" + filename;
-        }
-        const res = await packGLTF(file, outputFile, {
-            config,
-            packedFiles: set,
-            stats,
-            debug,
-            useCache: options.cache !== false,
-            logger: logger,
-            file_stats: file_stats,
-        });
-        if (res === false) {
-            process.exit(ERROR_CODES.PACKING_FAILED);
-        }
-    });
-    printStats(stats, logger, config);
-    console.log("Stats: ", options);
-    if (options.stats) {
-        const statsFile = (isDirectory ? (path.join(file, getDirName(file))) : file) + ".needle.stats.json";
-        writeFileStatsToFile(config, file_stats, statsFile);
-    }
-})
-    .command("transform", "Transform (progressive loading) and compress glTF, GLB or VRM files")
-    .help(`
-This will produce multiple versions of the input file, each with a different level of optimization.   
-Each version will be compressed and written to the output directory.
-`)
-    .argument('<input>', "The input glTF, GLB or VRM file that should be compressed OR a directory that contains files to be compressed")
-    // .argument('<output>', "The output file. If not provided, the input file will be overwritten.", { default: "" })
-    .option("--usecase <usecase>", `The usecase for the compression. This will set the compression settings. Possible options: [${UsecaseOptions.join(", ")}]`, { validator: program.STRING })
-    .option("--config <config>", "The path to a JSON file containing the compression settings. This can also be a needle.config.json file with a \"compression\" object or usecase string.", { validator: program.STRING })
-    .option("--stats", "Output a stats file next to input file (or inside the input directory). It will be named as the input file/directory \"<input>.needle.stats.json\"", { validator: program.BOOLEAN, default: false })
-    .option("--cache", "Use \"--cache False\" to disable caching.\nWhen caching is enabled then previously processed files will be detected and loaded from disc cache instead of being processed again if settings or the file contents have not changed.", { validator: program.BOOLEAN, default: true })
-    .option("--debug", "Enable for more verbose outout with \"--debug True\"", { validator: program.BOOLEAN, default: false })
-    .action(async ({ logger, args, options }) => {
-    logger.info("Transforming glTF file: " + args.input);
-    const stats = {
-        startTime: Date.now(),
-        totalGPUMemoryInMB: 0,
-        totalFilesProcessed: 0,
-        totalFileSizeInMB: 0,
-        totalFileSizeInMBBefore: 0,
-    };
-    const file = args.input.toString();
-    let config = getConfig(options.config?.toString(), file);
-    if (options.usecase) {
-        logger.info("Using usecase: " + options.usecase);
-        config = { ...createConfig(options.usecase.toString()), ...config, };
-        if (config.usecase != "default" && config.usecase != options.usecase.toString()) {
-            logger.warn(`Conflicting usecase. Your specific config at \"${options.config}\" has a different usecase than the one provided by the CLI: \"${options.usecase}\". Using the usecase from the config file.`);
-        }
-        else {
-            config.usecase = options.usecase.toString();
-        }
-    }
-    const isDirectory = statSync(file).isDirectory();
-    const outDir = isDirectory ? file : dirname(file);
-    const file_stats = [];
-    const set = new Set();
-    const useCache = options.cache !== false;
-    const debug = options.debug === true;
-    await foreachGLTF(file, async (file) => {
-        logger.info("→ Transform " + file);
-        const progressive_results = new Array();
-        await make_progressive({
-            path: file,
-            results: progressive_results,
-            config,
-            debug,
-            useCache,
-        }).catch(err => {
-            logger.error(err);
-            process.exit(ERROR_CODES.PROGRESSIVE_FAILED);
-        });
-        const opts = {
-            config,
-            stats,
-            packedFiles: set,
-            debug,
-            useCache,
-            logger: logger,
-            file_stats,
-        };
-        for (const res of progressive_results) {
-            if (await packGLTF(res, res, opts) === false) {
-                process.exit(ERROR_CODES.PACKING_FAILED);
-            }
-        }
-        if (await packGLTF(file, file, opts) === false) {
-            process.exit(ERROR_CODES.PACKING_FAILED);
-        }
-    });
-    printStats(stats, logger, config);
-    if (options.stats) {
-        const statsFile = (isDirectory ? (path.join(file, getDirName(file))) : file) + ".needle.stats.json";
-        writeFileStatsToFile(config, file_stats, statsFile);
-    }
-});
-program.run().catch(err => {
-    // Since we still invoke this package with paths when running npm scripts we need to ignore this error
-    // We might want to move this code here into an extra package.
-    if (err.message.includes("Unknown command") && !err.message.includes("Did you mean")) {
-        // ignore
-        return;
-    }
-    throw err;
-});