@needle-tools/engine 4.6.2-next.fb486b2 → 4.7.0-alpha

package/lib/asap/needle-asap.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/lib/asap/needle-asap.js

@@ -1,96 +1,96 @@
-import { needleLogoOnlySVG } from "../engine/assets/index.js";
-import { handleSessionGrantedASAP } from "./sessiongranted.js";
-import { needleEngineHasLoaded } from "./utils.js";
-/*
-For testing run: npm run build:dev && npm run preview
-Make sure you have gzip disabled
-*/
-const params = new URLSearchParams(location.search);
-const debug = params.get("debugasap") != undefined;
-if (debug)
-    console.log("Needle asap is here!");
-let needleEngineElement = null;
-startup();
-handleSessionGrantedASAP({ debug });
-function startup(iteration = 0) {
-    needleEngineElement = document.querySelector("needle-engine");
-    if (!needleEngineElement)
-        return setTimeout(startup, 50 + iteration * 10);
-    insertTemporaryContentWhileEngineHasntLoaded(needleEngineElement);
-    return undefined;
-    // if (needleEngineHasLoaded()) {
-    //     if (debug) console.log("Skip asap, needle engine has already loaded.");
-    //     return;
-    // }
-    // if (debug) console.log("asap, needleEngineElement", needleEngineElement);
-    // handlePrefetch(needleEngineElement);
-}
-// function handlePrefetch(needleEngineElement: HTMLElement) {
-//     if (needleEngineHasLoaded()) {
-//         return;
-//     }
-//     let src = needleEngineElement?.getAttribute("src") as string | Array<string>;
-//     if (!src) {
-//         return setTimeout(() => handlePrefetch(needleEngineElement), 100);
-//     }
-//     if (typeof src == "string" && src?.startsWith("[")) {
-//         src = JSON.parse(src);
-//     }
-//     if (Array.isArray(src)) {
-//         for (const url of src) {
-//             prefetch(url);
-//         }
-//     }
-//     else {
-//         prefetch(src);
-//     }
-// 
-function insertTemporaryContentWhileEngineHasntLoaded(needleEngineElement) {
-    // if (needleEngineHasLoaded()) return;
-    const asapdiv = document.createElement("div");
-    asapdiv.style.cssText = `
-        position: absolute;
-        top: 0;
-        left: 0;
-        width: 100%;
-        height: 100%;
-        z-index: -1;
-        display: flex;
-        justify-content: center;
-        align-items: center;
-        pointer-events: none;
-    `;
-    const img = document.createElement("img");
-    // if a custom logo is assigned we should use this here
-    // technically we should check if the user has a license
-    const customLogoUrl = needleEngineElement?.getAttribute("loading-logo-src");
-    if (customLogoUrl && customLogoUrl?.length > 0)
-        img.src = customLogoUrl;
-    else
-        img.src = needleLogoOnlySVG;
-    img.style.zIndex = "-10";
-    img.style.width = "140px";
-    img.style.height = "auto";
-    img.style.opacity = "1";
-    img.style.textShadow = "0 0 10px 0px rgba(0,0,0,.5)";
-    asapdiv.appendChild(img);
-    needleEngineElement.appendChild(asapdiv);
-    // animation to pulsate
-    // don't animate to opacity 0 because for LCP we need to keep the element in the DOM and visible to the user
-    // see https://web.dev/articles/lcp#what-elements-are-considered
-    img.animate([
-        { opacity: .2 },
-        { opacity: .7 },
-        { opacity: .2 }
-    ], {
-        duration: 3000,
-        iterations: Infinity
-    });
-    const i = setInterval(() => {
-        if (needleEngineHasLoaded()) {
-            clearInterval(i);
-            img.remove();
-        }
-    }, 10);
-}
+import { needleLogoOnlySVG } from "../engine/assets/index.js";
+import { handleSessionGrantedASAP } from "./sessiongranted.js";
+import { needleEngineHasLoaded } from "./utils.js";
+/*
+For testing run: npm run build:dev && npm run preview
+Make sure you have gzip disabled
+*/
+const params = new URLSearchParams(location.search);
+const debug = params.get("debugasap") != undefined;
+if (debug)
+    console.log("Needle asap is here!");
+let needleEngineElement = null;
+startup();
+handleSessionGrantedASAP({ debug });
+function startup(iteration = 0) {
+    needleEngineElement = document.querySelector("needle-engine");
+    if (!needleEngineElement)
+        return setTimeout(startup, 50 + iteration * 10);
+    insertTemporaryContentWhileEngineHasntLoaded(needleEngineElement);
+    return undefined;
+    // if (needleEngineHasLoaded()) {
+    //     if (debug) console.log("Skip asap, needle engine has already loaded.");
+    //     return;
+    // }
+    // if (debug) console.log("asap, needleEngineElement", needleEngineElement);
+    // handlePrefetch(needleEngineElement);
+}
+// function handlePrefetch(needleEngineElement: HTMLElement) {
+//     if (needleEngineHasLoaded()) {
+//         return;
+//     }
+//     let src = needleEngineElement?.getAttribute("src") as string | Array<string>;
+//     if (!src) {
+//         return setTimeout(() => handlePrefetch(needleEngineElement), 100);
+//     }
+//     if (typeof src == "string" && src?.startsWith("[")) {
+//         src = JSON.parse(src);
+//     }
+//     if (Array.isArray(src)) {
+//         for (const url of src) {
+//             prefetch(url);
+//         }
+//     }
+//     else {
+//         prefetch(src);
+//     }
+// 
+function insertTemporaryContentWhileEngineHasntLoaded(needleEngineElement) {
+    // if (needleEngineHasLoaded()) return;
+    const asapdiv = document.createElement("div");
+    asapdiv.style.cssText = `
+        position: absolute;
+        top: 0;
+        left: 0;
+        width: 100%;
+        height: 100%;
+        z-index: -1;
+        display: flex;
+        justify-content: center;
+        align-items: center;
+        pointer-events: none;
+    `;
+    const img = document.createElement("img");
+    // if a custom logo is assigned we should use this here
+    // technically we should check if the user has a license
+    const customLogoUrl = needleEngineElement?.getAttribute("loading-logo-src");
+    if (customLogoUrl && customLogoUrl?.length > 0)
+        img.src = customLogoUrl;
+    else
+        img.src = needleLogoOnlySVG;
+    img.style.zIndex = "-10";
+    img.style.width = "140px";
+    img.style.height = "auto";
+    img.style.opacity = "1";
+    img.style.textShadow = "0 0 10px 0px rgba(0,0,0,.5)";
+    asapdiv.appendChild(img);
+    needleEngineElement.appendChild(asapdiv);
+    // animation to pulsate
+    // don't animate to opacity 0 because for LCP we need to keep the element in the DOM and visible to the user
+    // see https://web.dev/articles/lcp#what-elements-are-considered
+    img.animate([
+        { opacity: .2 },
+        { opacity: .7 },
+        { opacity: .2 }
+    ], {
+        duration: 3000,
+        iterations: Infinity
+    });
+    const i = setInterval(() => {
+        if (needleEngineHasLoaded()) {
+            clearInterval(i);
+            img.remove();
+        }
+    }, 10);
+}
 //# sourceMappingURL=needle-asap.js.map

package/lib/asap/sessiongranted.d.ts

@@ -1,3 +1,3 @@
-export declare function handleSessionGrantedASAP(opts: {
-    debug: boolean;
-}): void;
+export declare function handleSessionGrantedASAP(opts: {
+    debug: boolean;
+}): void;

package/lib/asap/sessiongranted.js

@@ -1,66 +1,66 @@
-import { needleEngineHasLoaded } from "./utils.js";
-/** @returns a new XRSession init object with defaults */
-function getDefaultSessionInit(mode) {
-    switch (mode) {
-        case "immersive-ar":
-            return {
-                optionalFeatures: ['anchors', 'local-floor', 'hand-tracking', 'layers', 'dom-overlay', 'hit-test'],
-            };
-        case "immersive-vr":
-            return {
-                optionalFeatures: ['local-floor', 'bounded-floor', 'hand-tracking', 'high-fixed-foveation-level', 'layers'],
-            };
-        default:
-            console.warn("No default session init for mode", mode);
-            return {};
-    }
-}
-let sessionGrantedHandled = false;
-export function handleSessionGrantedASAP(opts) {
-    if (sessionGrantedHandled)
-        return;
-    sessionGrantedHandled = true;
-    if (!opts.debug)
-        return;
-    const debugContainer = document.createElement("div");
-    debugContainer.style.position = "fixed";
-    debugContainer.style.top = "0";
-    debugContainer.style.left = "0";
-    debugContainer.style.zIndex = "1000";
-    debugContainer.style.gap = "10px";
-    debugContainer.style.display = "flex";
-    if (opts.debug)
-        document.body.appendChild(debugContainer);
-    if ('xr' in navigator) {
-        debugContainer.appendChild(document.createTextNode("needle asap: handleSessionGranted"));
-        // WebXRViewer (based on Firefox) has a bug where addEventListener
-        // throws a silent exception and aborts execution entirely.
-        if (/WebXRViewer\//i.test(navigator.userAgent)) {
-            console.warn('WebXRViewer does not support addEventListener');
-            return;
-        }
-        const sessionGranted = async function () {
-            navigator.xr?.removeEventListener('sessiongranted', sessionGranted);
-            if (needleEngineHasLoaded()) {
-                debugContainer.appendChild(document.createTextNode("needle asap: Engine has already loaded"));
-                return;
-            }
-            if (globalThis["needle:XRSession"] != undefined) {
-                debugContainer.appendChild(document.createTextNode("needle asap: Session already requested"));
-                return;
-            }
-            console.log('needle asap: Session granted');
-            debugContainer.appendChild(document.createTextNode("Session granted"));
-            // request immersive VR session and store it in a global variable
-            const init = getDefaultSessionInit("immersive-vr");
-            const request = navigator.xr?.requestSession('immersive-vr', init);
-            globalThis["needle:XRSession"] = request?.catch((err) => {
-                console.error('needle asap: Session request failed', err);
-                debugContainer.appendChild(document.createTextNode("Session request failed: " + err.message));
-                return null;
-            });
-        };
-        navigator.xr?.addEventListener('sessiongranted', sessionGranted, { once: true });
-    }
-}
+import { needleEngineHasLoaded } from "./utils.js";
+/** @returns a new XRSession init object with defaults */
+function getDefaultSessionInit(mode) {
+    switch (mode) {
+        case "immersive-ar":
+            return {
+                optionalFeatures: ['anchors', 'local-floor', 'hand-tracking', 'layers', 'dom-overlay', 'hit-test'],
+            };
+        case "immersive-vr":
+            return {
+                optionalFeatures: ['local-floor', 'bounded-floor', 'hand-tracking', 'high-fixed-foveation-level', 'layers'],
+            };
+        default:
+            console.warn("No default session init for mode", mode);
+            return {};
+    }
+}
+let sessionGrantedHandled = false;
+export function handleSessionGrantedASAP(opts) {
+    if (sessionGrantedHandled)
+        return;
+    sessionGrantedHandled = true;
+    if (!opts.debug)
+        return;
+    const debugContainer = document.createElement("div");
+    debugContainer.style.position = "fixed";
+    debugContainer.style.top = "0";
+    debugContainer.style.left = "0";
+    debugContainer.style.zIndex = "1000";
+    debugContainer.style.gap = "10px";
+    debugContainer.style.display = "flex";
+    if (opts.debug)
+        document.body.appendChild(debugContainer);
+    if ('xr' in navigator) {
+        debugContainer.appendChild(document.createTextNode("needle asap: handleSessionGranted"));
+        // WebXRViewer (based on Firefox) has a bug where addEventListener
+        // throws a silent exception and aborts execution entirely.
+        if (/WebXRViewer\//i.test(navigator.userAgent)) {
+            console.warn('WebXRViewer does not support addEventListener');
+            return;
+        }
+        const sessionGranted = async function () {
+            navigator.xr?.removeEventListener('sessiongranted', sessionGranted);
+            if (needleEngineHasLoaded()) {
+                debugContainer.appendChild(document.createTextNode("needle asap: Engine has already loaded"));
+                return;
+            }
+            if (globalThis["needle:XRSession"] != undefined) {
+                debugContainer.appendChild(document.createTextNode("needle asap: Session already requested"));
+                return;
+            }
+            console.log('needle asap: Session granted');
+            debugContainer.appendChild(document.createTextNode("Session granted"));
+            // request immersive VR session and store it in a global variable
+            const init = getDefaultSessionInit("immersive-vr");
+            const request = navigator.xr?.requestSession('immersive-vr', init);
+            globalThis["needle:XRSession"] = request?.catch((err) => {
+                console.error('needle asap: Session request failed', err);
+                debugContainer.appendChild(document.createTextNode("Session request failed: " + err.message));
+                return null;
+            });
+        };
+        navigator.xr?.addEventListener('sessiongranted', sessionGranted, { once: true });
+    }
+}
 //# sourceMappingURL=sessiongranted.js.map

package/lib/asap/utils.d.ts

@@ -1 +1 @@
-export declare function needleEngineHasLoaded(): boolean;
+export declare function needleEngineHasLoaded(): boolean;

package/lib/asap/utils.js

@@ -1,4 +1,4 @@
-export function needleEngineHasLoaded() {
-    return typeof globalThis["Needle"] == "object";
-}
+export function needleEngineHasLoaded() {
+    return typeof globalThis["Needle"] == "object";
+}
 //# sourceMappingURL=utils.js.map

package/lib/engine/analytics/index.d.ts

@@ -1,6 +1,6 @@
-/**
- * @param args - The arguments to initialize the performance analytics with.
- */
-export declare module NeedleEnginePerformanceAnalytics {
-    function init(...args: Array<"lcp">): void;
-}
+/**
+ * @param args - The arguments to initialize the performance analytics with.
+ */
+export declare module NeedleEnginePerformanceAnalytics {
+    function init(...args: Array<"lcp">): void;
+}

package/lib/engine/analytics/index.js

@@ -1,13 +1,13 @@
-import { LCP } from "./lcp.js";
-/**
- * @param args - The arguments to initialize the performance analytics with.
- */
-export var NeedleEnginePerformanceAnalytics;
-(function (NeedleEnginePerformanceAnalytics) {
-    function init(...args) {
-        if (args.includes("lcp"))
-            LCP.observe();
-    }
-    NeedleEnginePerformanceAnalytics.init = init;
-})(NeedleEnginePerformanceAnalytics || (NeedleEnginePerformanceAnalytics = {}));
+import { LCP } from "./lcp.js";
+/**
+ * @param args - The arguments to initialize the performance analytics with.
+ */
+export var NeedleEnginePerformanceAnalytics;
+(function (NeedleEnginePerformanceAnalytics) {
+    function init(...args) {
+        if (args.includes("lcp"))
+            LCP.observe();
+    }
+    NeedleEnginePerformanceAnalytics.init = init;
+})(NeedleEnginePerformanceAnalytics || (NeedleEnginePerformanceAnalytics = {}));
 //# sourceMappingURL=index.js.map

package/lib/engine/analytics/lcp.d.ts

@@ -1,3 +1,3 @@
-export declare namespace LCP {
-    function observe(): void;
-}
+export declare namespace LCP {
+    function observe(): void;
+}

package/lib/engine/analytics/lcp.js

@@ -1,35 +1,35 @@
-// https://web.dev/articles/lcp
-export var LCP;
-(function (LCP) {
-    function observe() {
-        const observer = new PerformanceObserver((list) => {
-            const perfEntries = list.getEntries();
-            const lastEntry = perfEntries[perfEntries.length - 1];
-            // Process the latest candidate for largest contentful paint
-            console.log('LCP candidate:', lastEntry);
-            const el = createElementFromUrl(lastEntry.url);
-            if (el)
-                document.body.appendChild(el);
-        });
-        observer.observe({ entryTypes: ['largest-contentful-paint'] });
-    }
-    LCP.observe = observe;
-    function createElementFromUrl(str) {
-        if (!str)
-            return null;
-        if (!str.startsWith('data:image/')) {
-            return null;
-        }
-        else if (!str.includes("base64")) {
-            return null;
-        }
-        const img = document.createElement('img');
-        img.src = str;
-        img.onerror = err => {
-            console.error(err);
-            img.remove();
-        };
-        return img;
-    }
-})(LCP || (LCP = {}));
+// https://web.dev/articles/lcp
+export var LCP;
+(function (LCP) {
+    function observe() {
+        const observer = new PerformanceObserver((list) => {
+            const perfEntries = list.getEntries();
+            const lastEntry = perfEntries[perfEntries.length - 1];
+            // Process the latest candidate for largest contentful paint
+            console.log('LCP candidate:', lastEntry);
+            const el = createElementFromUrl(lastEntry.url);
+            if (el)
+                document.body.appendChild(el);
+        });
+        observer.observe({ entryTypes: ['largest-contentful-paint'] });
+    }
+    LCP.observe = observe;
+    function createElementFromUrl(str) {
+        if (!str)
+            return null;
+        if (!str.startsWith('data:image/')) {
+            return null;
+        }
+        else if (!str.includes("base64")) {
+            return null;
+        }
+        const img = document.createElement('img');
+        img.src = str;
+        img.onerror = err => {
+            console.error(err);
+            img.remove();
+        };
+        return img;
+    }
+})(LCP || (LCP = {}));
 //# sourceMappingURL=lcp.js.map

package/lib/engine/api.d.ts

@@ -1,82 +1,82 @@
-/**
- * Contains core functionality for Needle Engine.
- * This includes
- * - Context Management
- * - Asset Loading
- * - Component Lifecycle
- * - Time Handling
- * - XR support
- * - Unified Input Handling
- * - Needle Menu
- * - Networking
- * - Physics, Collisions, Raycasting
- * - Math and Filtering Helpers
- * - Rendering Utilities
- * - Debugging Utilities, Gizmos
- * - User agent detection
- * - and more.
- *
- * @module Engine Core
- */
-export * from "./debug/index.js";
-export * from "./engine_addressables.js";
-export { AnimationUtils } from "./engine_animation.js";
-export { Application } from "./engine_application.js";
-export * from "./engine_assetdatabase.js";
-export { getCameraController, setAutoFitEnabled, setCameraController, useForAutoFit } from "./engine_camera.js";
-export * from "./engine_components.js";
-export * from "./engine_components_internal.js";
-export * from "./engine_components_internal.js";
-export * from "./engine_constants.js";
-export * from "./engine_context.js";
-export * from "./engine_context_registry.js";
-export * from "./engine_coroutine.js";
-export * from "./engine_create_objects.js";
-export * from "./engine_gameobject.js";
-export { Gizmos } from "./engine_gizmos.js";
-export * from "./engine_gltf.js";
-export * from "./engine_hot_reload.js";
-export * from "./engine_input.js";
-export { InstancingUtil } from "./engine_instancing.js";
-export { hasCommercialLicense, hasIndieLicense, hasProLicense } from "./engine_license.js";
-export * from "./engine_lifecycle_api.js";
-export { NeedleEngineModelLoader } from "./engine_loaders.callbacks.js";
-export { loadAsset, loadSync, parseSync } from "./engine_loaders.js";
-export * from "./engine_math.js";
-export { MODULES as NEEDLE_ENGINE_MODULES } from "./engine_modules.js";
-export * from "./engine_networking.js";
-export { syncField } from "./engine_networking_auto.js";
-export * from "./engine_networking_blob.js";
-export * from "./engine_networking_files.js";
-export * from "./engine_networking_instantiate.js";
-export * from "./engine_networking_peer.js";
-export * from "./engine_networking_streams.js";
-export * from "./engine_networking_types.js";
-export * from "./engine_networking_utils.js";
-export * from "./engine_patcher.js";
-export * from "./engine_physics.js";
-export * from "./engine_physics.types.js";
-export * from "./engine_physics_rapier.js";
-export * from "./engine_playerview.js";
-export * from "./engine_scenelighting.js";
-export * from "./engine_serialization.js";
-export { type ISerializable } from "./engine_serialization_core.js";
-export * from "./engine_test_utils.js";
-export * from "./engine_texture.js";
-export * from "./engine_three_utils.js";
-export * from "./engine_time.js";
-export * from "./engine_time_utils.js";
-export * from "./engine_types.js";
-export { registerType, TypeStore } from "./engine_typestore.js";
-export { prefix, validate } from "./engine_util_decorator.js";
-export * from "./engine_utils.js";
-export * from "./engine_utils_format.js";
-export * from "./engine_utils_screenshot.js";
-export * from "./export/index.js";
-export * from "./extensions/index.js";
-export * from "./js-extensions/index.js";
-export * from "./webcomponents/api.js";
-export * from "./webcomponents/needle-engine.attributes.js";
-export * from "./webcomponents/needle-engine.js";
-export * from "./webcomponents/needle-engine.loading.js";
-export * from "./xr/api.js";
+/**
+ * Contains core functionality for Needle Engine.
+ * This includes
+ * - Context Management
+ * - Asset Loading
+ * - Component Lifecycle
+ * - Time Handling
+ * - XR support
+ * - Unified Input Handling
+ * - Needle Menu
+ * - Networking
+ * - Physics, Collisions, Raycasting
+ * - Math and Filtering Helpers
+ * - Rendering Utilities
+ * - Debugging Utilities, Gizmos
+ * - User agent detection
+ * - and more.
+ *
+ * @module Engine Core
+ */
+export * from "./debug/index.js";
+export * from "./engine_addressables.js";
+export { AnimationUtils } from "./engine_animation.js";
+export { Application } from "./engine_application.js";
+export * from "./engine_assetdatabase.js";
+export { getCameraController, setAutoFitEnabled, setCameraController, useForAutoFit } from "./engine_camera.js";
+export * from "./engine_components.js";
+export * from "./engine_components_internal.js";
+export * from "./engine_components_internal.js";
+export * from "./engine_constants.js";
+export * from "./engine_context.js";
+export * from "./engine_context_registry.js";
+export * from "./engine_coroutine.js";
+export * from "./engine_create_objects.js";
+export * from "./engine_gameobject.js";
+export { Gizmos } from "./engine_gizmos.js";
+export * from "./engine_gltf.js";
+export * from "./engine_hot_reload.js";
+export * from "./engine_input.js";
+export { InstancingUtil } from "./engine_instancing.js";
+export { hasCommercialLicense, hasIndieLicense, hasProLicense } from "./engine_license.js";
+export * from "./engine_lifecycle_api.js";
+export { NeedleEngineModelLoader } from "./engine_loaders.callbacks.js";
+export { loadAsset, loadSync, parseSync } from "./engine_loaders.js";
+export * from "./engine_math.js";
+export { MODULES as NEEDLE_ENGINE_MODULES } from "./engine_modules.js";
+export * from "./engine_networking.js";
+export { syncField } from "./engine_networking_auto.js";
+export * from "./engine_networking_blob.js";
+export * from "./engine_networking_files.js";
+export * from "./engine_networking_instantiate.js";
+export * from "./engine_networking_peer.js";
+export * from "./engine_networking_streams.js";
+export * from "./engine_networking_types.js";
+export * from "./engine_networking_utils.js";
+export * from "./engine_patcher.js";
+export * from "./engine_physics.js";
+export * from "./engine_physics.types.js";
+export * from "./engine_physics_rapier.js";
+export * from "./engine_playerview.js";
+export * from "./engine_scenelighting.js";
+export * from "./engine_serialization.js";
+export { type ISerializable } from "./engine_serialization_core.js";
+export * from "./engine_test_utils.js";
+export * from "./engine_texture.js";
+export * from "./engine_three_utils.js";
+export * from "./engine_time.js";
+export * from "./engine_time_utils.js";
+export * from "./engine_types.js";
+export { registerType, TypeStore } from "./engine_typestore.js";
+export { prefix, validate } from "./engine_util_decorator.js";
+export * from "./engine_utils.js";
+export * from "./engine_utils_format.js";
+export * from "./engine_utils_screenshot.js";
+export * from "./export/index.js";
+export * from "./extensions/index.js";
+export * from "./js-extensions/index.js";
+export * from "./webcomponents/api.js";
+export * from "./webcomponents/needle-engine.attributes.js";
+export * from "./webcomponents/needle-engine.js";
+export * from "./webcomponents/needle-engine.loading.js";
+export * from "./xr/api.js";