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

package/dist/utils/fileutils.js

@@ -1,177 +1,177 @@
-import { existsSync, statSync, readdirSync, readFileSync, mkdirSync } from 'fs';
-import { dirname, isAbsolute, join } from 'path';
-/**
- * Get the output path for a file based on the output directory or file.
- * If outDirOrFile is a filepath, it will be returned as is.
- * If outDirOrFile is a directory, the file will be placed in that directory.
- */
-export function getOutputPath(filepath, outDirOrFile, opts) {
-    if (!outDirOrFile) {
-        return filepath;
-    }
-    if (!isDirectory(outDirOrFile)) {
-        return outDirOrFile;
-    }
-    const filename = getFileName(filepath);
-    // create the directory if it doesn't exist (default behavior)
-    if (opts?.create != false && !existsSync(outDirOrFile)) {
-        mkdirSync(outDirOrFile, { recursive: true });
-    }
-    const outpath = join(outDirOrFile, filename);
-    return outpath;
-}
-export function getFileName(filepath) {
-    const parts = filepath.replaceAll("\\", "/").split("/");
-    return parts[parts.length - 1];
-}
-export function getDirName(filepath) {
-    // should work for paths that end with "/" or not
-    const parts = filepath.replaceAll("\\", "/").split("/");
-    let res = parts.pop();
-    if (res === "") {
-        res = parts.pop();
-    }
-    return res;
-}
-export async function foreachGLTF(args, callback) {
-    // get original directory this run was invoked from
-    const initDir = process.env.INIT_CWD;
-    const context = {
-        baseDirectory: initDir,
-        files: [],
-    };
-    // traverse recursively through all files and directories
-    if (Array.isArray(args)) {
-        for (const arg of args) {
-            await testEntry(arg, context);
-        }
-    }
-    else if (typeof args === "string") {
-        await testEntry(args, context);
-    }
-    // try to run with needle config
-    if (context.files?.length <= 0 && context.baseDirectory) {
-        const needleConfigPath = context.baseDirectory + "/needle.config.json";
-        if (existsSync(needleConfigPath)) {
-            const config = JSON.parse(readFileSync(needleConfigPath, "utf8"));
-            const buildDirectory = config.buildDirectory;
-            if (buildDirectory?.length) {
-                // If it's an absolute path
-                if (existsSync(buildDirectory)) {
-                    console.log("INFO: Using build directory from needle.config.json: " + buildDirectory);
-                    await testEntry(buildDirectory, context);
-                }
-                else { // if its a relative path
-                    const newPath = context.baseDirectory + "/" + buildDirectory;
-                    if (existsSync(newPath)) {
-                        console.log("INFO: Using build directory from needle.config.json: " + newPath);
-                        await testEntry(newPath, context);
-                    }
-                }
-            }
-        }
-        else {
-            // if no file was found, we don't have a needle.config in the directory
-            // and we don't have any arguments, try to find it in the default dist directory
-            // await testEntry(context.baseDirectory + "/dist", callback, context);
-        }
-    }
-    if (context.files.length <= 0) {
-        console.log(`WARN: No glTF files found. Make sure to invoke with a valid path to a glTF file or directory.\nBase Directory: ${context.baseDirectory}\nPaths can be relative to \"${initDir}\"`);
-    }
-    else {
-        for (const file of context.files) {
-            await callback(file);
-        }
-    }
-}
-async function testEntry(entry, context) {
-    // ignore argument names (e.g. --debug)
-    if (entry.startsWith("--")) {
-        return false;
-    }
-    if (entry === "." || entry === "./") {
-        if (context.baseDirectory) {
-            entry = context.baseDirectory;
-        }
-    }
-    if (existsSync(entry) === false) {
-        // If no base directory is defined we cannot try to resolve the path
-        if (context.baseDirectory === undefined) {
-            console.log("WARN: Path does not exist: " + entry);
-            return false;
-        }
-        // Try resolve potential relative path
-        const newPath = context.baseDirectory + "/" + entry;
-        if (existsSync(newPath) === false) {
-            console.log(`INFO: Resolved path failed: \"${entry}\" -> ${newPath} (doesnt exist or is locked by another process)`);
-            return false;
-        }
-        else {
-            console.log(`INFO: Resolved path: ${entry} -> ${newPath}`);
-            entry = newPath;
-        }
-    }
-    else {
-        // When passing in a relative path (e.g. `dist`) we dont want to accidentally traverse this package's directory
-        // So in that case make sure we resolve to an absolute path relative to the calling directory
-        const isAbs = isAbsolute(entry);
-        if (!isAbs) {
-            if (context.baseDirectory) {
-                const newPath = context.baseDirectory + "/" + entry;
-                console.log(`INFO: Resolved path: ${entry} -> ${newPath}`);
-                entry = newPath;
-                if (!existsSync(entry)) {
-                    return false;
-                }
-            }
-        }
-    }
-    if (entry.endsWith(".glb") || entry.endsWith(".gltf") || entry.endsWith(".vrm")) {
-        context.files.push(entry);
-    }
-    else {
-        const stat = statSync(entry);
-        if (stat.isDirectory()) {
-            // Don't traverse node_modules
-            if (entry.endsWith("node_modules")) {
-                return false;
-            }
-            const files = readdirSync(entry);
-            for (const file of files) {
-                await testEntry(entry + "/" + file, context);
-            }
-        }
-        else {
-            // console.log("WARN: Ignoring file: " + entry);
-        }
-    }
-}
-export function replaceExtension(filepath, newExtension) {
-    const parts = filepath.split(".");
-    parts.pop();
-    return parts.join(".") + "." + newExtension;
-}
-export function isDirectory(path) {
-    if (!path) {
-        return false;
-    }
-    if (existsSync(path)) {
-        return statSync(path).isDirectory();
-    }
-    const hasExt = path.replaceAll("\\", "/").split("/").pop()?.includes(".");
-    return !hasExt;
-}
-/**
- * Ensure that a path is a directory.
- * If the directory does not exist, it will be created.
- */
-export function ensureIsDirectory(path) {
-    if (!isDirectory(path)) {
-        path = dirname(path);
-    }
-    if (!existsSync(path)) {
-        mkdirSync(path, { recursive: true });
-    }
-    return path;
-}
+import { existsSync, statSync, readdirSync, readFileSync, mkdirSync } from 'fs';
+import { dirname, isAbsolute, join } from 'path';
+/**
+ * Get the output path for a file based on the output directory or file.
+ * If outDirOrFile is a filepath, it will be returned as is.
+ * If outDirOrFile is a directory, the file will be placed in that directory.
+ */
+export function getOutputPath(filepath, outDirOrFile, opts) {
+    if (!outDirOrFile) {
+        return filepath;
+    }
+    if (!isDirectory(outDirOrFile)) {
+        return outDirOrFile;
+    }
+    const filename = getFileName(filepath);
+    // create the directory if it doesn't exist (default behavior)
+    if (opts?.create != false && !existsSync(outDirOrFile)) {
+        mkdirSync(outDirOrFile, { recursive: true });
+    }
+    const outpath = join(outDirOrFile, filename);
+    return outpath;
+}
+export function getFileName(filepath) {
+    const parts = filepath.replaceAll("\\", "/").split("/");
+    return parts[parts.length - 1];
+}
+export function getDirName(filepath) {
+    // should work for paths that end with "/" or not
+    const parts = filepath.replaceAll("\\", "/").split("/");
+    let res = parts.pop();
+    if (res === "") {
+        res = parts.pop();
+    }
+    return res;
+}
+export async function foreachGLTF(args, callback) {
+    // get original directory this run was invoked from
+    const initDir = process.env.INIT_CWD;
+    const context = {
+        baseDirectory: initDir,
+        files: [],
+    };
+    // traverse recursively through all files and directories
+    if (Array.isArray(args)) {
+        for (const arg of args) {
+            await testEntry(arg, context);
+        }
+    }
+    else if (typeof args === "string") {
+        await testEntry(args, context);
+    }
+    // try to run with needle config
+    if (context.files?.length <= 0 && context.baseDirectory) {
+        const needleConfigPath = context.baseDirectory + "/needle.config.json";
+        if (existsSync(needleConfigPath)) {
+            const config = JSON.parse(readFileSync(needleConfigPath, "utf8"));
+            const buildDirectory = config.buildDirectory;
+            if (buildDirectory?.length) {
+                // If it's an absolute path
+                if (existsSync(buildDirectory)) {
+                    console.log("INFO: Using build directory from needle.config.json: " + buildDirectory);
+                    await testEntry(buildDirectory, context);
+                }
+                else { // if its a relative path
+                    const newPath = context.baseDirectory + "/" + buildDirectory;
+                    if (existsSync(newPath)) {
+                        console.log("INFO: Using build directory from needle.config.json: " + newPath);
+                        await testEntry(newPath, context);
+                    }
+                }
+            }
+        }
+        else {
+            // if no file was found, we don't have a needle.config in the directory
+            // and we don't have any arguments, try to find it in the default dist directory
+            // await testEntry(context.baseDirectory + "/dist", callback, context);
+        }
+    }
+    if (context.files.length <= 0) {
+        console.log(`WARN: No glTF files found. Make sure to invoke with a valid path to a glTF file or directory.\nBase Directory: ${context.baseDirectory}\nPaths can be relative to \"${initDir}\"`);
+    }
+    else {
+        for (const file of context.files) {
+            await callback(file);
+        }
+    }
+}
+async function testEntry(entry, context) {
+    // ignore argument names (e.g. --debug)
+    if (entry.startsWith("--")) {
+        return false;
+    }
+    if (entry === "." || entry === "./") {
+        if (context.baseDirectory) {
+            entry = context.baseDirectory;
+        }
+    }
+    if (existsSync(entry) === false) {
+        // If no base directory is defined we cannot try to resolve the path
+        if (context.baseDirectory === undefined) {
+            console.log("WARN: Path does not exist: " + entry);
+            return false;
+        }
+        // Try resolve potential relative path
+        const newPath = context.baseDirectory + "/" + entry;
+        if (existsSync(newPath) === false) {
+            console.log(`INFO: Resolved path failed: \"${entry}\" -> ${newPath} (doesnt exist or is locked by another process)`);
+            return false;
+        }
+        else {
+            console.log(`INFO: Resolved path: ${entry} -> ${newPath}`);
+            entry = newPath;
+        }
+    }
+    else {
+        // When passing in a relative path (e.g. `dist`) we dont want to accidentally traverse this package's directory
+        // So in that case make sure we resolve to an absolute path relative to the calling directory
+        const isAbs = isAbsolute(entry);
+        if (!isAbs) {
+            if (context.baseDirectory) {
+                const newPath = context.baseDirectory + "/" + entry;
+                console.log(`INFO: Resolved path: ${entry} -> ${newPath}`);
+                entry = newPath;
+                if (!existsSync(entry)) {
+                    return false;
+                }
+            }
+        }
+    }
+    if (entry.endsWith(".glb") || entry.endsWith(".gltf") || entry.endsWith(".vrm")) {
+        context.files.push(entry);
+    }
+    else {
+        const stat = statSync(entry);
+        if (stat.isDirectory()) {
+            // Don't traverse node_modules
+            if (entry.endsWith("node_modules")) {
+                return false;
+            }
+            const files = readdirSync(entry);
+            for (const file of files) {
+                await testEntry(entry + "/" + file, context);
+            }
+        }
+        else {
+            // console.log("WARN: Ignoring file: " + entry);
+        }
+    }
+}
+export function replaceExtension(filepath, newExtension) {
+    const parts = filepath.split(".");
+    parts.pop();
+    return parts.join(".") + "." + newExtension;
+}
+export function isDirectory(path) {
+    if (!path) {
+        return false;
+    }
+    if (existsSync(path)) {
+        return statSync(path).isDirectory();
+    }
+    const hasExt = path.replaceAll("\\", "/").split("/").pop()?.includes(".");
+    return !hasExt;
+}
+/**
+ * Ensure that a path is a directory.
+ * If the directory does not exist, it will be created.
+ */
+export function ensureIsDirectory(path) {
+    if (!isDirectory(path)) {
+        path = dirname(path);
+    }
+    if (!existsSync(path)) {
+        mkdirSync(path, { recursive: true });
+    }
+    return path;
+}

package/dist/utils/guid.d.ts

@@ -1 +1 @@
-export declare function generateGuid(key: string): any;
+export declare function generateGuid(key: string): any;

package/dist/utils/guid.js

@@ -1,5 +1,5 @@
-import { v5 as uuidv5 } from 'uuid';
-const NEEDLE_BUILD_PIPELINE_NAMESPACE = '208dcaa6-1398-4d42-a625-8f5fc1cc1ccf';
-export function generateGuid(key) {
-    return uuidv5(key, NEEDLE_BUILD_PIPELINE_NAMESPACE);
-}
+import { v5 as uuidv5 } from 'uuid';
+const NEEDLE_BUILD_PIPELINE_NAMESPACE = '208dcaa6-1398-4d42-a625-8f5fc1cc1ccf';
+export function generateGuid(key) {
+    return uuidv5(key, NEEDLE_BUILD_PIPELINE_NAMESPACE);
+}

package/dist/utils/index.d.ts

@@ -1,10 +1,10 @@
-export * from "./compression_utils.js";
-export * from "./fileutils.js";
-export * from "./version.js";
-export * from "./mesh.js";
-export * from "./texture.js";
-export * from "./guid.js";
-export * from "./nodeio.js";
-export * from "./stats.js";
-export * from "./merge.js";
-export * from "./validate.js";
+export * from "./compression_utils.js";
+export * from "./fileutils.js";
+export * from "./version.js";
+export * from "./mesh.js";
+export * from "./texture.js";
+export * from "./guid.js";
+export * from "./nodeio.js";
+export * from "./stats.js";
+export * from "./merge.js";
+export * from "./validate.js";

package/dist/utils/index.js

@@ -1,10 +1,10 @@
-export * from "./compression_utils.js";
-export * from "./fileutils.js";
-export * from "./version.js";
-export * from "./mesh.js";
-export * from "./texture.js";
-export * from "./guid.js";
-export * from "./nodeio.js";
-export * from "./stats.js";
-export * from "./merge.js";
-export * from "./validate.js";
+export * from "./compression_utils.js";
+export * from "./fileutils.js";
+export * from "./version.js";
+export * from "./mesh.js";
+export * from "./texture.js";
+export * from "./guid.js";
+export * from "./nodeio.js";
+export * from "./stats.js";
+export * from "./merge.js";
+export * from "./validate.js";

package/dist/utils/merge.d.ts

@@ -1,12 +1,12 @@
-/**
- * Simple object check.
- * @param item
- * @returns {boolean}
- */
-export declare function isObject(item: object): boolean;
-/**
- * Deep merge two objects.
- * @param target
- * @param ...sources
- */
-export declare function mergeDeep(target: any, ...sources: any[]): any;
+/**
+ * Simple object check.
+ * @param item
+ * @returns {boolean}
+ */
+export declare function isObject(item: object): boolean;
+/**
+ * Deep merge two objects.
+ * @param target
+ * @param ...sources
+ */
+export declare function mergeDeep(target: any, ...sources: any[]): any;

package/dist/utils/merge.js

@@ -1,31 +1,31 @@
-/**
- * Simple object check.
- * @param item
- * @returns {boolean}
- */
-export function isObject(item) {
-    return (item && typeof item === 'object' && !Array.isArray(item));
-}
-/**
- * Deep merge two objects.
- * @param target
- * @param ...sources
- */
-export function mergeDeep(target, ...sources) {
-    if (!sources.length)
-        return target;
-    const source = sources.shift();
-    if (isObject(target) && isObject(source)) {
-        for (const key in source) {
-            if (isObject(source[key])) {
-                if (!target[key])
-                    Object.assign(target, { [key]: {} });
-                mergeDeep(target[key], source[key]);
-            }
-            else {
-                Object.assign(target, { [key]: source[key] });
-            }
-        }
-    }
-    return mergeDeep(target, ...sources);
-}
+/**
+ * Simple object check.
+ * @param item
+ * @returns {boolean}
+ */
+export function isObject(item) {
+    return (item && typeof item === 'object' && !Array.isArray(item));
+}
+/**
+ * Deep merge two objects.
+ * @param target
+ * @param ...sources
+ */
+export function mergeDeep(target, ...sources) {
+    if (!sources.length)
+        return target;
+    const source = sources.shift();
+    if (isObject(target) && isObject(source)) {
+        for (const key in source) {
+            if (isObject(source[key])) {
+                if (!target[key])
+                    Object.assign(target, { [key]: {} });
+                mergeDeep(target[key], source[key]);
+            }
+            else {
+                Object.assign(target, { [key]: source[key] });
+            }
+        }
+    }
+    return mergeDeep(target, ...sources);
+}

package/dist/utils/mesh.d.ts

@@ -1,13 +1,13 @@
-import { Document, Mesh, Primitive } from "@gltf-transform/core";
-export declare type MeshInformation = {
-    readonly maxVertexCount: number;
-    readonly totalVertexCount: number;
-    readonly totalIndexCount: number;
-};
-export declare function getMeshInformation(mesh: Mesh | Document): MeshInformation;
-/**
- * Calculate the density of a mesh.
- * @param prim - The primitive to calculate the density for.
- * @returns The density of the mesh or -1 if the mesh is not indexed.
- */
-export declare function calculateMeshDensity(prim: Primitive): number | -1;
+import { Document, Mesh, Primitive } from "@gltf-transform/core";
+export declare type MeshInformation = {
+    readonly maxVertexCount: number;
+    readonly totalVertexCount: number;
+    readonly totalIndexCount: number;
+};
+export declare function getMeshInformation(mesh: Mesh | Document): MeshInformation;
+/**
+ * Calculate the density of a mesh.
+ * @param prim - The primitive to calculate the density for.
+ * @returns The density of the mesh or -1 if the mesh is not indexed.
+ */
+export declare function calculateMeshDensity(prim: Primitive): number | -1;