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

package/dist/transforms/toktx_types.d.ts

@@ -1,78 +1,78 @@
-import { vec2 } from "@gltf-transform/core";
-import { TextureResizeFilter } from "@gltf-transform/functions";
-/**********************************************************************************************
- * Interfaces.
- */
-export declare const Mode: {
-    ETC1S: string;
-    UASTC: string;
-};
-export declare const Filter: {
-    BOX: string;
-    TENT: string;
-    BELL: string;
-    BSPLINE: string;
-    MITCHELL: string;
-    LANCZOS3: string;
-    LANCZOS4: string;
-    LANCZOS6: string;
-    LANCZOS12: string;
-    BLACKMAN: string;
-    KAISER: string;
-    GAUSSIAN: string;
-    CATMULLROM: string;
-    QUADRATIC_INTERP: string;
-    QUADRATIC_APPROX: string;
-    QUADRATIC_MIX: string;
-};
-interface GlobalOptions {
-    /** Instance of the Sharp encoder, required if resizing textures. */
-    encoder: unknown;
-    mode: string;
-    /** Pattern identifying textures to compress, matched to name or URI. */
-    pattern?: RegExp | null;
-    /**
-     * Pattern matching the material texture slot(s) to be compressed or converted.
-     * Passing a string (glob) is deprecated; use a RegExp instead.
-     */
-    slots?: RegExp | null;
-    /** Interpolation used for generating mipmaps. Default: 'lanczos4'. */
-    filter?: string;
-    filterScale?: number;
-    resize?: vec2 | 'nearest-pot' | 'ceil-pot' | 'floor-pot';
-    /** Interpolation used if resizing. Default: TextureResizeFilter.LANCZOS3. */
-    resizeFilter?: TextureResizeFilter;
-    jobs?: number;
-    /**
-     * Whether to clean up temporary files created during texture compression. See
-     * verbose log output for temporary file paths. Default: true.
-     */
-    cleanup?: boolean;
-    /**
-     * Attempts to avoid processing images that could exceed memory or other other
-     * limits, throwing an error instead. Default: true.
-     * @experimental
-     */
-    limitInputPixels?: boolean;
-}
-export interface ETC1SOptions extends GlobalOptions {
-    quality?: number;
-    compression?: number;
-    maxEndpoints?: number;
-    maxSelectors?: number;
-    rdo?: boolean;
-    rdoThreshold?: number;
-}
-export interface UASTCOptions extends GlobalOptions {
-    level?: number;
-    rdo?: boolean;
-    rdoLambda?: number;
-    rdoDictionarySize?: number;
-    rdoBlockScale?: number;
-    rdoStdDev?: number;
-    rdoMultithreading?: boolean;
-    zstd?: number;
-}
-export declare const ETC1S_DEFAULTS: Omit<ETC1SOptions, 'encoder' | 'mode'>;
-export declare const UASTC_DEFAULTS: Omit<UASTCOptions, 'encoder' | 'mode'>;
-export {};
+import { vec2 } from "@gltf-transform/core";
+import { TextureResizeFilter } from "@gltf-transform/functions";
+/**********************************************************************************************
+ * Interfaces.
+ */
+export declare const Mode: {
+    ETC1S: string;
+    UASTC: string;
+};
+export declare const Filter: {
+    BOX: string;
+    TENT: string;
+    BELL: string;
+    BSPLINE: string;
+    MITCHELL: string;
+    LANCZOS3: string;
+    LANCZOS4: string;
+    LANCZOS6: string;
+    LANCZOS12: string;
+    BLACKMAN: string;
+    KAISER: string;
+    GAUSSIAN: string;
+    CATMULLROM: string;
+    QUADRATIC_INTERP: string;
+    QUADRATIC_APPROX: string;
+    QUADRATIC_MIX: string;
+};
+interface GlobalOptions {
+    /** Instance of the Sharp encoder, required if resizing textures. */
+    encoder: unknown;
+    mode: string;
+    /** Pattern identifying textures to compress, matched to name or URI. */
+    pattern?: RegExp | null;
+    /**
+     * Pattern matching the material texture slot(s) to be compressed or converted.
+     * Passing a string (glob) is deprecated; use a RegExp instead.
+     */
+    slots?: RegExp | null;
+    /** Interpolation used for generating mipmaps. Default: 'lanczos4'. */
+    filter?: string;
+    filterScale?: number;
+    resize?: vec2 | 'nearest-pot' | 'ceil-pot' | 'floor-pot';
+    /** Interpolation used if resizing. Default: TextureResizeFilter.LANCZOS3. */
+    resizeFilter?: TextureResizeFilter;
+    jobs?: number;
+    /**
+     * Whether to clean up temporary files created during texture compression. See
+     * verbose log output for temporary file paths. Default: true.
+     */
+    cleanup?: boolean;
+    /**
+     * Attempts to avoid processing images that could exceed memory or other other
+     * limits, throwing an error instead. Default: true.
+     * @experimental
+     */
+    limitInputPixels?: boolean;
+}
+export interface ETC1SOptions extends GlobalOptions {
+    quality?: number;
+    compression?: number;
+    maxEndpoints?: number;
+    maxSelectors?: number;
+    rdo?: boolean;
+    rdoThreshold?: number;
+}
+export interface UASTCOptions extends GlobalOptions {
+    level?: number;
+    rdo?: boolean;
+    rdoLambda?: number;
+    rdoDictionarySize?: number;
+    rdoBlockScale?: number;
+    rdoStdDev?: number;
+    rdoMultithreading?: boolean;
+    zstd?: number;
+}
+export declare const ETC1S_DEFAULTS: Omit<ETC1SOptions, 'encoder' | 'mode'>;
+export declare const UASTC_DEFAULTS: Omit<UASTCOptions, 'encoder' | 'mode'>;
+export {};

package/dist/transforms/toktx_types.js

@@ -1,62 +1,62 @@
-import os from 'os';
-import { TextureChannel } from "@gltf-transform/core";
-import { TextureResizeFilter } from "@gltf-transform/functions";
-const NUM_CPUS = os.cpus().length || 1; // microsoft/vscode#112122
-const KTX_SOFTWARE_VERSION_MIN = '4.3.0';
-const { R, G, A } = TextureChannel;
-/**********************************************************************************************
- * Interfaces.
- */
-export const Mode = {
-    ETC1S: 'etc1s',
-    UASTC: 'uastc',
-};
-export const Filter = {
-    BOX: 'box',
-    TENT: 'tent',
-    BELL: 'bell',
-    BSPLINE: 'b-spline',
-    MITCHELL: 'mitchell',
-    LANCZOS3: 'lanczos3',
-    LANCZOS4: 'lanczos4',
-    LANCZOS6: 'lanczos6',
-    LANCZOS12: 'lanczos12',
-    BLACKMAN: 'blackman',
-    KAISER: 'kaiser',
-    GAUSSIAN: 'gaussian',
-    CATMULLROM: 'catmullrom',
-    QUADRATIC_INTERP: 'quadratic_interp',
-    QUADRATIC_APPROX: 'quadratic_approx',
-    QUADRATIC_MIX: 'quadratic_mix',
-};
-const GLOBAL_DEFAULTS = {
-    resizeFilter: TextureResizeFilter.LANCZOS3,
-    filter: Filter.LANCZOS4,
-    filterScale: 1,
-    pattern: null,
-    slots: null,
-    // See: https://github.com/donmccurdy/glTF-Transform/pull/389#issuecomment-1089842185
-    jobs: 2 * NUM_CPUS,
-    cleanup: true,
-    limitInputPixels: true,
-};
-export const ETC1S_DEFAULTS = {
-    quality: 128,
-    compression: 1,
-    rdo: true,
-    rdoThreshold: 1.25,
-    maxSelectors: 0,
-    maxEndpoints: 0,
-    ...GLOBAL_DEFAULTS,
-};
-export const UASTC_DEFAULTS = {
-    level: 2,
-    rdo: false,
-    rdoLambda: 1.0,
-    rdoDictionarySize: 32768,
-    rdoBlockScale: 10.0,
-    rdoStdDev: 18.0,
-    rdoMultithreading: true,
-    zstd: 18,
-    ...GLOBAL_DEFAULTS,
-};
+import os from 'os';
+import { TextureChannel } from "@gltf-transform/core";
+import { TextureResizeFilter } from "@gltf-transform/functions";
+const NUM_CPUS = os.cpus().length || 1; // microsoft/vscode#112122
+const KTX_SOFTWARE_VERSION_MIN = '4.3.0';
+const { R, G, A } = TextureChannel;
+/**********************************************************************************************
+ * Interfaces.
+ */
+export const Mode = {
+    ETC1S: 'etc1s',
+    UASTC: 'uastc',
+};
+export const Filter = {
+    BOX: 'box',
+    TENT: 'tent',
+    BELL: 'bell',
+    BSPLINE: 'b-spline',
+    MITCHELL: 'mitchell',
+    LANCZOS3: 'lanczos3',
+    LANCZOS4: 'lanczos4',
+    LANCZOS6: 'lanczos6',
+    LANCZOS12: 'lanczos12',
+    BLACKMAN: 'blackman',
+    KAISER: 'kaiser',
+    GAUSSIAN: 'gaussian',
+    CATMULLROM: 'catmullrom',
+    QUADRATIC_INTERP: 'quadratic_interp',
+    QUADRATIC_APPROX: 'quadratic_approx',
+    QUADRATIC_MIX: 'quadratic_mix',
+};
+const GLOBAL_DEFAULTS = {
+    resizeFilter: TextureResizeFilter.LANCZOS3,
+    filter: Filter.LANCZOS4,
+    filterScale: 1,
+    pattern: null,
+    slots: null,
+    // See: https://github.com/donmccurdy/glTF-Transform/pull/389#issuecomment-1089842185
+    jobs: 2 * NUM_CPUS,
+    cleanup: true,
+    limitInputPixels: true,
+};
+export const ETC1S_DEFAULTS = {
+    quality: 128,
+    compression: 1,
+    rdo: true,
+    rdoThreshold: 1.25,
+    maxSelectors: 0,
+    maxEndpoints: 0,
+    ...GLOBAL_DEFAULTS,
+};
+export const UASTC_DEFAULTS = {
+    level: 2,
+    rdo: false,
+    rdoLambda: 1.0,
+    rdoDictionarySize: 32768,
+    rdoBlockScale: 10.0,
+    rdoStdDev: 18.0,
+    rdoMultithreading: true,
+    zstd: 18,
+    ...GLOBAL_DEFAULTS,
+};

package/dist/transforms/util.d.ts

@@ -1,21 +1,21 @@
-/// <reference types="node" resolution-mode="require"/>
-import { spawn as _spawn } from 'child_process';
-import type { ChildProcess } from 'child_process';
-export declare const XMPContext: Record<string, string>;
-export declare const MICROMATCH_OPTIONS: {
-    nocase: boolean;
-    contains: boolean;
-};
-export declare let spawn: typeof _spawn;
-export declare let commandExists: (cmd: string) => any;
-export declare let waitExit: typeof _waitExit;
-export declare function mockSpawn(_spawn: unknown): void;
-export declare function mockCommandExists(_commandExists: (n: string) => Promise<boolean>): void;
-export declare function mockWaitExit(_waitExit: (process: ChildProcess) => Promise<[unknown, string, string]>): void;
-export declare function _waitExit(process: ChildProcess): Promise<[unknown, string, string]>;
-export declare function formatLong(x: number): string;
-export declare function formatBytes(bytes: number, decimals?: number): string;
-export declare function formatParagraph(str: string): string;
-export declare function formatHeader(title: string): string;
-export declare function formatXMP(value: string | number | boolean | Record<string, unknown> | null): string;
-export declare function underline(str: string): string;
+/// <reference types="node" resolution-mode="require"/>
+import { spawn as _spawn } from 'child_process';
+import type { ChildProcess } from 'child_process';
+export declare const XMPContext: Record<string, string>;
+export declare const MICROMATCH_OPTIONS: {
+    nocase: boolean;
+    contains: boolean;
+};
+export declare let spawn: typeof _spawn;
+export declare let commandExists: (cmd: string) => any;
+export declare let waitExit: typeof _waitExit;
+export declare function mockSpawn(_spawn: unknown): void;
+export declare function mockCommandExists(_commandExists: (n: string) => Promise<boolean>): void;
+export declare function mockWaitExit(_waitExit: (process: ChildProcess) => Promise<[unknown, string, string]>): void;
+export declare function _waitExit(process: ChildProcess): Promise<[unknown, string, string]>;
+export declare function formatLong(x: number): string;
+export declare function formatBytes(bytes: number, decimals?: number): string;
+export declare function formatParagraph(str: string): string;
+export declare function formatHeader(title: string): string;
+export declare function formatXMP(value: string | number | boolean | Record<string, unknown> | null): string;
+export declare function underline(str: string): string;

package/dist/transforms/util.js

@@ -1,90 +1,90 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
-import { spawn as _spawn } from 'child_process';
-import _commandExists from 'command-exists';
-// Constants.
-export const XMPContext = {
-    dc: 'http://purl.org/dc/elements/1.1/',
-    model3d: 'https://schema.khronos.org/model3d/xsd/1.0/',
-    rdf: 'http://www.w3.org/1999/02/22-rdf-syntax-ns#',
-    xmp: 'http://ns.adobe.com/xap/1.0/',
-    xmpRights: 'http://ns.adobe.com/xap/1.0/rights/',
-};
-// Using 'micromatch' because 'contains: true' did not work as expected with
-// minimatch. Need to ensure that '*' matches patterns like 'image/png'.
-export const MICROMATCH_OPTIONS = { nocase: true, contains: true };
-// Mocks for tests.
-export let spawn = _spawn;
-// See https://github.com/mathisonian/command-exists/issues/22
-export let commandExists = (cmd) => _commandExists(cmd)?.catch(() => false) ?? false;
-export let waitExit = _waitExit;
-export function mockSpawn(_spawn) {
-    //@ts-ignore
-    spawn = _spawn;
-}
-export function mockCommandExists(_commandExists) {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    commandExists = _commandExists;
-}
-export function mockWaitExit(_waitExit) {
-    waitExit = _waitExit;
-}
-export async function _waitExit(process) {
-    let stdout = '';
-    if (process.stdout) {
-        for await (const chunk of process.stdout) {
-            stdout += chunk;
-        }
-    }
-    let stderr = '';
-    if (process.stderr) {
-        for await (const chunk of process.stderr) {
-            stderr += chunk;
-        }
-    }
-    const status = await new Promise((resolve, _) => {
-        process.on('close', resolve);
-    });
-    return [status, stdout, stderr];
-}
-// Formatting.
-export function formatLong(x) {
-    return x.toString().replace(/\B(?=(\d{3})+(?!\d))/g, ',');
-}
-export function formatBytes(bytes, decimals = 2) {
-    if (bytes === 0)
-        return '0 Bytes';
-    const k = 1000;
-    const dm = decimals < 0 ? 0 : decimals;
-    const sizes = ['Bytes', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'];
-    const i = Math.floor(Math.log(bytes) / Math.log(k));
-    return parseFloat((bytes / Math.pow(k, i)).toFixed(dm)) + ' ' + sizes[i];
-}
-export function formatParagraph(str) {
-    return str
-        .match(/.{1,80}(\s|$)/g)
-        .map((line) => line.trim())
-        .join('\n');
-}
-export function formatHeader(title) {
-    return '' + '\n ' + title.toUpperCase() + '\n ────────────────────────────────────────────';
-}
-export function formatXMP(value) {
-    if (!value) {
-        return '';
-    }
-    if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
-        return value.toString();
-    }
-    if (value['@list']) {
-        const list = value['@list'];
-        const hasCommas = list.some((value) => value.indexOf(',') > 0);
-        return list.join(hasCommas ? '; ' : ', ');
-    }
-    if (value['@type'] === 'rdf:Alt') {
-        return value['rdf:_1']['@value'];
-    }
-    return JSON.stringify(value);
-}
-export function underline(str) {
-    return `\x1b[4m${str}\x1b[0m`;
-}
+/* eslint-disable @typescript-eslint/no-var-requires */
+import { spawn as _spawn } from 'child_process';
+import _commandExists from 'command-exists';
+// Constants.
+export const XMPContext = {
+    dc: 'http://purl.org/dc/elements/1.1/',
+    model3d: 'https://schema.khronos.org/model3d/xsd/1.0/',
+    rdf: 'http://www.w3.org/1999/02/22-rdf-syntax-ns#',
+    xmp: 'http://ns.adobe.com/xap/1.0/',
+    xmpRights: 'http://ns.adobe.com/xap/1.0/rights/',
+};
+// Using 'micromatch' because 'contains: true' did not work as expected with
+// minimatch. Need to ensure that '*' matches patterns like 'image/png'.
+export const MICROMATCH_OPTIONS = { nocase: true, contains: true };
+// Mocks for tests.
+export let spawn = _spawn;
+// See https://github.com/mathisonian/command-exists/issues/22
+export let commandExists = (cmd) => _commandExists(cmd)?.catch(() => false) ?? false;
+export let waitExit = _waitExit;
+export function mockSpawn(_spawn) {
+    //@ts-ignore
+    spawn = _spawn;
+}
+export function mockCommandExists(_commandExists) {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    commandExists = _commandExists;
+}
+export function mockWaitExit(_waitExit) {
+    waitExit = _waitExit;
+}
+export async function _waitExit(process) {
+    let stdout = '';
+    if (process.stdout) {
+        for await (const chunk of process.stdout) {
+            stdout += chunk;
+        }
+    }
+    let stderr = '';
+    if (process.stderr) {
+        for await (const chunk of process.stderr) {
+            stderr += chunk;
+        }
+    }
+    const status = await new Promise((resolve, _) => {
+        process.on('close', resolve);
+    });
+    return [status, stdout, stderr];
+}
+// Formatting.
+export function formatLong(x) {
+    return x.toString().replace(/\B(?=(\d{3})+(?!\d))/g, ',');
+}
+export function formatBytes(bytes, decimals = 2) {
+    if (bytes === 0)
+        return '0 Bytes';
+    const k = 1000;
+    const dm = decimals < 0 ? 0 : decimals;
+    const sizes = ['Bytes', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'];
+    const i = Math.floor(Math.log(bytes) / Math.log(k));
+    return parseFloat((bytes / Math.pow(k, i)).toFixed(dm)) + ' ' + sizes[i];
+}
+export function formatParagraph(str) {
+    return str
+        .match(/.{1,80}(\s|$)/g)
+        .map((line) => line.trim())
+        .join('\n');
+}
+export function formatHeader(title) {
+    return '' + '\n ' + title.toUpperCase() + '\n ────────────────────────────────────────────';
+}
+export function formatXMP(value) {
+    if (!value) {
+        return '';
+    }
+    if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
+        return value.toString();
+    }
+    if (value['@list']) {
+        const list = value['@list'];
+        const hasCommas = list.some((value) => value.indexOf(',') > 0);
+        return list.join(hasCommas ? '; ' : ', ');
+    }
+    if (value['@type'] === 'rdf:Alt') {
+        return value['rdf:_1']['@value'];
+    }
+    return JSON.stringify(value);
+}
+export function underline(str) {
+    return `\x1b[4m${str}\x1b[0m`;
+}

package/dist/utils/compression_utils.d.ts

@@ -1,2 +1,2 @@
-export declare type TextureCompressionMode = "webp" | "ETC1S" | "UASTC";
-export declare function detectTextureCompressionMode(slots: string[]): "UASTC" | "ETC1S";
+export declare type TextureCompressionMode = "webp" | "ETC1S" | "UASTC";
+export declare function detectTextureCompressionMode(slots: string[]): "UASTC" | "ETC1S";

package/dist/utils/compression_utils.js

@@ -1,6 +1,6 @@
-export function detectTextureCompressionMode(slots) {
-    if (slots.includes("normalTexture") || slots.includes("metallicRoughnessTexture")) {
-        return "UASTC";
-    }
-    return "ETC1S";
-}
+export function detectTextureCompressionMode(slots) {
+    if (slots.includes("normalTexture") || slots.includes("metallicRoughnessTexture")) {
+        return "UASTC";
+    }
+    return "ETC1S";
+}

package/dist/utils/fileutils.d.ts

@@ -1,19 +1,19 @@
-/**
- * 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 declare function getOutputPath(filepath: string, outDirOrFile: string | undefined | null, opts?: {
-    create?: boolean;
-}): string;
-export declare function getFileName(filepath: string): string;
-export declare function getDirName(filepath: string): string;
-export declare type GLTFFileCallback = (file: string) => void | Promise<void>;
-export declare function foreachGLTF(args: string | string[], callback: GLTFFileCallback): Promise<void>;
-export declare function replaceExtension(filepath: string, newExtension: string): string;
-export declare function isDirectory(path: string): boolean;
-/**
- * Ensure that a path is a directory.
- * If the directory does not exist, it will be created.
- */
-export declare function ensureIsDirectory(path: string): string;
+/**
+ * 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 declare function getOutputPath(filepath: string, outDirOrFile: string | undefined | null, opts?: {
+    create?: boolean;
+}): string;
+export declare function getFileName(filepath: string): string;
+export declare function getDirName(filepath: string): string;
+export declare type GLTFFileCallback = (file: string) => void | Promise<void>;
+export declare function foreachGLTF(args: string | string[], callback: GLTFFileCallback): Promise<void>;
+export declare function replaceExtension(filepath: string, newExtension: string): string;
+export declare function isDirectory(path: string): boolean;
+/**
+ * Ensure that a path is a directory.
+ * If the directory does not exist, it will be created.
+ */
+export declare function ensureIsDirectory(path: string): string;