@needle-tools/engine 5.1.0-alpha.5 → 5.1.0-canary.02ccb45

package/plugins/types/userconfig.d.ts

@@ -82,7 +82,10 @@ export type userSettings = {
         */
         version?: string;
 
-        /** If defined the access token will be used to run compression on Needle Cloud */
+        /** If defined the access token will be used to run compression on Needle Cloud.
+         *
+         * Expected to be a Needle Cloud access token (created in the Needle Cloud UI),
+         * NOT a JWT. Do not pass a licensing JWT here. */
         accessToken?: string | undefined;
 
         /**

package/plugins/vite/build-pipeline.js

@@ -1,5 +1,6 @@
 import { ChildProcess, exec } from 'child_process';
 import { NEEDLE_CLOUD_CLI_NAME } from '../common/cloud.js';
+import { resolveLicense } from '../common/license.js';
 import { getOutputDirectory, loadConfig } from './config.js';
 import { existsSync, mkdirSync, readFileSync, readdirSync, rmSync, statSync, writeFileSync } from 'fs';
 import { relative } from 'path';
@@ -10,6 +11,8 @@ import { needleBlue, needleDim, needleLog, needleSupportsColor, setTransientLogL
 const PIPELINE_SPINNER_FRAMES = ["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"];
 const PIPELINE_STRUCTURED_LOG_PREFIX = "__needle_pipeline_log__:";
 
+// #region Validation
+
 /**
  * @param {import('../types').userSettings} config
  * @returns {boolean}
@@ -37,8 +40,11 @@ env:
     return true;
 }
 
+// #endregion
+
 // see https://linear.app/needle/issue/NE-3798
 
+// #region State
 
 /**  @type {Promise<void>|null} */
 let buildPipelineTask;
@@ -87,6 +93,10 @@ function increaseMaxWaitTime(debugLog) {
     }
 }
 
+// #endregion
+
+// #region Plugin
+
 /** Runs the needle build pipeline as part of the vite build process.
  * @param {"build" | "serve"} command
  * @param {import('../types/needleConfig').needleMeta | null | undefined} config
@@ -237,9 +247,12 @@ export async function needleBuildPipeline(command, config, userSettings) {
     }
 }
 
+// #endregion
+
+// #region Migration
 
 /**
- * Previously we did always install the build pipeline and run an extra command to invoke the build pipeline.  
+ * Previously we did always install the build pipeline and run an extra command to invoke the build pipeline.
  * This is now done automatically by the needle build pipeline plugin - so we update all legacy projects to use the new method.
  * @param {string} packageJsonPath
  */
@@ -258,6 +271,10 @@ async function fixPackageJson(packageJsonPath) {
     writeFileSync(packageJsonPath, fixed);
 }
 
+// #endregion
+
+// #region Logging
+
 /** @param {...unknown} args */
 function log(...args) {
     needleLog("needle-buildpipeline", args.join(" "));
@@ -267,11 +284,15 @@ function warn(...args) {
     needleLog("needle-buildpipeline", args.join(" "), "warn");
 }
 
+// #endregion
+
+// #region Execution
+
 /**
  * @typedef {{ event?: string, phase?: string, target?: string, message?: string, level?: string }} BuildPipelinePayload
  */
 /**
- * @param {import('../types').userSettings} opts 
+ * @param {import('../types').userSettings} opts
  * @param {{verbose?:boolean}} [options]
  * @returns {Promise<boolean>}
  */
@@ -283,12 +304,7 @@ async function invokeBuildPipeline(opts, options = {}) {
     const supportsColor = needleSupportsColor();
     const key = (/** @type {string} */ text) => supportsColor ? needleBlue(text) : text;
 
-    const installPath = "node_modules/@needle-tools/gltf-build-pipeline";
-    const fullInstallPath = process.cwd() + "/" + installPath;
-    const existsLocally = existsSync(fullInstallPath);
-    if (existsLocally) {
-        log("Found local installation at " + fullInstallPath);
-    }
+    // #region Wait for output
     await delay(500);
     const outputDirectory = getOutputDirectory() + "/assets";
     const startWaitTime = Date.now();
@@ -332,17 +348,18 @@ async function invokeBuildPipeline(opts, options = {}) {
         `${key("Files to process")}: ${files.length} in ${rel(outputDirectory)}, ${formatBytes(filesBytes)}`,
         existsSync(process.cwd() + "/node_modules/.needle/build-pipeline/output") ? needleDim("Removing temporary output directory") : undefined,
     ].filter(Boolean), "log", { dimBody: false });
+    // #endregion
+
+    // #region Setup
 
     /** @type {null | ChildProcess} */
     let proc = null;
 
-    let cloudAccessToken = opts.buildPipeline?.accessToken || opts.license?.accessToken;
-    if (!cloudAccessToken) {
-        cloudAccessToken = process.env.NEEDLE_CLOUD_TOKEN;
-    }
+    // Cloud token used by `${NEEDLE_CLOUD_CLI_NAME} optimize --token <token>`.
+    // This is a Needle Cloud access token (created in the Needle Cloud UI), NOT a JWT.
+    const cloudAccessToken = opts.buildPipeline?.accessToken;
     const runInCloud = typeof cloudAccessToken === "string" && cloudAccessToken.length > 0;
-    // if a user has defined the build pipeline settings object but not passed in a token we should print out some information 
-    // or perhaps log an error / prevent the build from running completely
+
     if (opts.buildPipeline && !runInCloud && process.env.CI) {
         warn(`No cloud access token found. Please set it via process.env.NEEDLE_CLOUD_TOKEN`);
         return false;
@@ -367,6 +384,10 @@ async function invokeBuildPipeline(opts, options = {}) {
         }
     }
 
+    // #endregion
+
+    // #region Run
+
     // allow running the build pipeline in the cloud. It requires and access token to be set in the vite.config.js
     // this can be set via e.g. process.env.NEEDLE_CLOUD_TOKEN
     const commandEnv = { ...process.env, NEEDLE_PIPELINE_STRUCTURED_LOGS: "1" };
@@ -393,11 +414,6 @@ async function invokeBuildPipeline(opts, options = {}) {
         log(`Running compression in cloud ⛅ using access token: ${obfuscatedToken}`);
         proc = exec(cmd, { env: commandEnv });
     }
-    else if (existsLocally) {
-        const cmd = `needle-gltf transform "${outputDirectory}" \"${tempOutputPath}\"`;
-        log("Running command \"" + cmd + "\" at " + process.cwd() + "...");
-        proc = exec(cmd, { cwd: installPath, env: commandEnv });
-    }
     else {
         // First check if the user passed in a specific version to use via the vite config
         let version = opts.buildPipeline?.version;
@@ -424,10 +440,21 @@ async function invokeBuildPipeline(opts, options = {}) {
         if (!version) version = "stable";
 
         const versionInfo = versionSource ? `'${version}' (${versionSource})` : `'${version}'`;
-        const cmd = `npx --yes @needle-tools/gltf-build-pipeline@${version} transform "${outputDirectory}" \"${tempOutputPath}\"`;
+        // needle-gltf 3.x requires a JWT via `--auth-token <jwt>` on every CLI invocation.
+        // The JWT comes from the needle license server — it is NOT the Needle Cloud access token.
+        const licenseResult = await resolveLicense({
+            team: opts.license?.team,
+            accessToken: opts.license?.accessToken,
+            loglevel: opts.debugLicense === true ? "verbose" : undefined,
+        });
+        const authTokenArg = licenseResult?.jwt ? ` --auth-token ${licenseResult.jwt}` : "";
+        const cmd = `npx --yes @needle-tools/gltf-build-pipeline@${version} transform "${outputDirectory}" \"${tempOutputPath}\"${authTokenArg}`;
         log(`Running compression locally using version ${versionInfo}`);
         proc = exec(cmd, { env: commandEnv });
     }
+    // #endregion
+
+    // #region Output
     let pipelineSpinnerIndex = 0;
     let pipelineSpinnerActive = false;
     let transformStepCount = 0;
@@ -550,6 +577,9 @@ async function invokeBuildPipeline(opts, options = {}) {
     }
     proc.stdout?.on('data', onLog);
     proc.stderr?.on('data', onLog);
+    // #endregion
+
+    // #region Exit
     return new Promise((resolve, reject) => {
         proc.on('exit', (code) => {
             clearPipelineProgress();
@@ -570,8 +600,13 @@ async function invokeBuildPipeline(opts, options = {}) {
             resolve(success);
         });
     });
+    // #endregion
 }
 
+// #endregion
+
+// #region Helpers
+
 /** @param {string | null | undefined} directory */
 function getDirectoryStats(directory) {
     if (!directory || !existsSync(directory)) return { fileCount: 0, totalBytes: 0 };
@@ -597,3 +632,5 @@ function getDirectoryStats(directory) {
     }
     return { fileCount, totalBytes };
 }
+
+// #endregion

package/plugins/vite/license.js

@@ -8,7 +8,8 @@ import { loadConfig } from './config.js';
  * @returns {import('vite').Plugin}
  */
 export function needleLicense(command, config, userSettings) {
-    let license = undefined;
+    /** @type {import('../common/license.js').LicenseResult | null | undefined} */
+    let licenseResult = undefined;
     let appliedLicense = false;
 
     return {
@@ -24,7 +25,7 @@ export function needleLicense(command, config, userSettings) {
                 }
             }
 
-            license = await resolveLicense({
+            licenseResult = await resolveLicense({
                 team: team,
                 accessToken: userSettings?.license?.accessToken,
                 loglevel: userSettings?.debugLicense === true ? "verbose" : undefined
@@ -32,10 +33,6 @@ export function needleLicense(command, config, userSettings) {
 
         },
         async transform(src, id) {
-            if (appliedLicense === true) {
-                return;
-            }
-
             // Vite 4 and 8 handling:
             const isNeedleEngineFile = id.includes("engine/engine_license")
                 || id.includes("needle-tools_engine")
@@ -45,22 +42,42 @@ export function needleLicense(command, config, userSettings) {
             const isViteChunkFile = id.includes("chunk") && id.includes(".vite");
             if (isNeedleEngineFile || isViteChunkFile) {
 
-                if (!license) {
+                if (!licenseResult) {
                     return;
                 }
 
-                const index = src.indexOf("NEEDLE_ENGINE_LICENSE_TYPE");
+                let modified = false;
+
+                // Replace license type
+                const index = src.indexOf("fFDtghiT");
                 if (index >= 0) {
                     const end = src.indexOf(";", index);
                     if (end >= 0) {
-                        appliedLicense = true;
                         const line = src.substring(index, end);
-                        const replaced = "NEEDLE_ENGINE_LICENSE_TYPE = \"" + license + "\"";
+                        const replaced = "fFDtghiT = \"" + licenseResult.type + "\"";
                         src = src.replace(line, replaced);
-                        return { code: src, map: null }
+                        modified = true;
+                    }
+                }
+
+                // Replace license JWT (same pattern)
+                if (licenseResult.jwt) {
+                    const jwtIndex = src.indexOf("$NAqiWhRF");
+                    if (jwtIndex >= 0) {
+                        const jwtEnd = src.indexOf(";", jwtIndex);
+                        if (jwtEnd >= 0) {
+                            const jwtLine = src.substring(jwtIndex, jwtEnd);
+                            const jwtReplaced = "$NAqiWhRF = \"" + licenseResult.jwt + "\"";
+                            src = src.replace(jwtLine, jwtReplaced);
+                            modified = true;
+                        }
                     }
                 }
-                // @TODO: detect local needle engine dev setup and log error if not found
+
+                if (modified) {
+                    appliedLicense = true;
+                    return { code: src, map: null }
+                }
             }
         },
         buildEnd() {

package/src/engine/api.ts

@@ -230,7 +230,7 @@ export * from "./engine_input.js";
 export { InstancingUtil } from "./engine_instancing.js";
 
 /** License checking utilities */
-export { hasCommercialLicense, hasIndieLicense, hasProLicense } from "./engine_license.js";
+export { _$HwXA, _$xxpfa, UsFaeEU } from "./engine_license.js";
 
 
 // ============================================================================

package/src/engine/engine_context.ts

@@ -1808,6 +1808,7 @@ export class Context implements IContext {
 					? (`${((window.performance as any).memory.usedJSHeapSize / 1024 / 1024).toFixed(2)} MB`)
 					: "n/a";
 
+				const gl = this.renderer.getContext();
 				console.log(this.renderer.info.render.calls + " DrawCalls", "\nRender:",
 					{
 						shaders: this.renderer.info.programs?.length,
@@ -1817,7 +1818,16 @@ export class Context implements IContext {
 					{
 						usedMemory: usedJSHeapSize,
 						...this.renderer.info.memory
-					}, "\nTarget Framerate: " + this.targetFrameRate);
+					},
+					"\nRenderer:",
+					{
+						dpr: this.renderer.getPixelRatio(),
+						windowDpr: window.devicePixelRatio,
+						antialias: gl.getContextAttributes()?.antialias,
+						samples: gl.getParameter(gl.SAMPLES),
+						resolution: `${this.renderer.domElement.width}x${this.renderer.domElement.height}`,
+					},
+					"\nTarget Framerate: " + this.targetFrameRate);
 			}
 		}
 

package/src/engine/engine_init.ts

@@ -8,7 +8,7 @@ import { initBuiltinTypes } from "./codegen/register_types.js";
 import { initSpatialConsole } from "./debug/debug_spatial_console.js";
 import { initAddressableSerializers } from "./engine_addressables.js";
 import { ensureAudioContextIsResumed } from "./engine_audio.js";
-import { initLicense } from "./engine_license.js";
+import { NJzpPtg } from "./engine_license.js";
 import { initNeedleLoader } from "./engine_loaders.js";
 import { initPhysics } from "./engine_physics_rapier.js";
 import { initBuiltinSerializers } from "./engine_serialization_builtin_serializer.js";
@@ -59,5 +59,5 @@ export function initEngine() {
     initPhysics();
     initXR();
     initSpatialConsole();
-    initLicense();
+    NJzpPtg();
 }