@needle-tools/engine 3.28.6-beta → 3.28.7-beta.1

package/src/engine/engine_utils.ts

@@ -1,606 +1,606 @@
-// use for typesafe interface method calls
-import { Quaternion, type Vector, Vector2, Vector3, Vector4 } from "three";
-import { type SourceIdentifier } from "./engine_types.js";
-
-// https://schneidenbach.gitbooks.io/typescript-cookbook/content/nameof-operator.html
-export const nameofFactory = <T>() => (name: keyof T) => name;
-export function nameof<T>(name: keyof T) {
-    return nameofFactory<T>()(name);
-}
-
-
-export function isDebugMode(): boolean {
-    return getParam("debug") ? true : false;
-}
-
-
-
-export class CircularBuffer<T> {
-    private _factory: () => T;
-    private _cache: T[] = [];
-    private _maxSize: number;
-    private _index: number = 0;
-
-    constructor(factory: () => T, maxSize: number) {
-        this._factory = factory;
-        this._maxSize = maxSize;
-    }
-
-    get(): T {
-        const i = this._index % this._maxSize;
-        this._index++;
-        if (this._cache.length <= i) {
-            this._cache[i] = this._factory();
-        }
-        return this._cache[i];
-    }
-}
-
-
-
-let saveParams: boolean = false;
-const requestedParams: Array<string> = [];
-setTimeout(() => {
-    if (saveParams) {
-        console.log(requestedParams.sort());
-    }
-}, 100);
-
-export function getUrlParams() {
-    // "window" may not exist in node.js
-    return new URLSearchParams(globalThis.location?.search);
-}
-
-// bit strange that we have to pass T in here as well but otherwise the type parameter is stripped it seems
-type Param<T extends string> = string | boolean | number | T;
-
-/** Checks if a url parameter exists.
- * Returns true if it exists but has no value (e.g. ?help)
- * Returns false if it does not exist
- * Returns false if it's set to 0 e.g. ?debug=0
- * Returns the value if it exists e.g. ?message=hello
- */
-export function getParam<T extends string>(paramName: T): Param<T> {
-    if (saveParams && !requestedParams.includes(paramName))
-        requestedParams.push(paramName);
-    const urlParams = getUrlParams();
-    if (urlParams.has(paramName)) {
-        const val = urlParams.get(paramName);
-        if (val) {
-            const num = Number(val);
-            if (!isNaN(num)) return num;
-            return val;
-        }
-        else return true;
-    }
-    return false;
-}
-saveParams = getParam("help") === true;
-
-export function setParam(paramName: string, paramValue: string): void {
-    const urlParams = getUrlParams();
-    if (urlParams.has(paramName)) {
-        urlParams.set(paramName, paramValue);
-    }
-    else
-        urlParams.append(paramName, paramValue);
-    document.location.search = urlParams.toString();
-}
-
-export function setParamWithoutReload(paramName: string, paramValue: string | null, appendHistory = true): void {
-    const urlParams = getUrlParams();
-    if (urlParams.has(paramName)) {
-        if (paramValue === null) urlParams.delete(paramName);
-        else urlParams.set(paramName, paramValue);
-    }
-    else if (paramValue !== null)
-        urlParams.append(paramName, paramValue);
-    if (appendHistory) pushState(paramName, urlParams);
-    else setState(paramName, urlParams);
-}
-
-export function setOrAddParamsToUrl(url: URLSearchParams, paramName: string, paramValue: string | number): void {
-    if (url.has(paramName)) {
-        url.set(paramName, paramValue.toString());
-    }
-    else
-        url.append(paramName, paramValue.toString());
-}
-
-export function pushState(title: string, urlParams: URLSearchParams, state?: any) {
-    window.history.pushState(state, title, "?" + urlParams.toString());
-}
-
-export function setState(title: string, urlParams: URLSearchParams, state?: any) {
-    window.history.replaceState(state, title, "?" + urlParams.toString());
-}
-
-// for room id
-export function makeId(length): string {
-    var result = '';
-    var characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
-    var charactersLength = characters.length;
-    for (var i = 0; i < length; i++) {
-        result += characters.charAt(Math.floor(Math.random() *
-            charactersLength));
-    }
-    return result;
-}
-
-export function randomNumber(min, max) {
-    return Math.floor(Math.random() * (max - min + 1)) + min;
-}
-
-const adjectives = ["smol", "tiny", "giant", "interesting", "smart", "bright", "dull", "extreme", "beautiful", "pretty", "dark", "epic", "salty", "silly", "funny", "lame", "lazy", "loud", "lucky", "mad", "mean", "mighty", "mysterious", "nasty", "odd", "old", "powerful", "quiet", "rapid", "scary", "shiny", "shy", "silly", "smooth", "sour", "spicy", "stupid", "sweet", "tasty", "terrible", "ugly", "unusual", "vast", "wet", "wild", "witty", "wrong", "zany", "zealous", "zippy", "zombie", "zorro"];
-const nouns = ["cat", "dog", "mouse", "pig", "cow", "horse", "sheep", "chicken", "duck", "goat", "panda", "tiger", "lion", "elephant", "monkey", "bird", "fish", "snake", "frog", "turtle", "hamster", "penguin", "kangaroo", "whale", "dolphin", "crocodile", "snail", "ant", "bee", "beetle", "butterfly", "dragon", "eagle", "fish", "giraffe", "lizard", "panda", "penguin", "rabbit", "snake", "spider", "tiger", "zebra"]
-export function makeIdFromRandomWords(): string {
-    const randomAdjective = adjectives[Math.floor(Math.random() * adjectives.length)];
-    const randomNoun = nouns[Math.floor(Math.random() * nouns.length)];
-    return randomAdjective + "_" + randomNoun;
-}
-
-// for url parameters
-export function sanitizeString(str): string {
-    str = str.replace(/[^a-z0-9áéíóúñü \.,_-]/gim, "");
-    return str.trim();
-}
-
-
-// TODO: taken from scene utils
-export function tryFindObject(globalObjectIdentifier: string, obj, recursive: boolean = true, searchComponents: boolean = false) {
-    if (obj === undefined || obj === null) return null;
-
-    if (obj.userData && obj.userData.guid === globalObjectIdentifier) return obj;
-    else if (obj.guid == globalObjectIdentifier) return obj;
-
-    if (searchComponents) {
-        if (obj.userData?.components) {
-            for (const comp of obj.userData.components) {
-                if (comp.guid === globalObjectIdentifier) return comp;
-            }
-        }
-    }
-
-    if (recursive) {
-
-        if (obj.scenes) {
-            for (const i in obj.scenes) {
-                const scene = obj.scenes[i];
-                const found = tryFindObject(globalObjectIdentifier, scene, recursive, searchComponents);
-                if (found) return found;
-            }
-        }
-
-        if (obj.children) {
-            for (const i in obj.children) {
-                const child = obj.children[i];
-                const found = tryFindObject(globalObjectIdentifier, child, recursive, searchComponents);
-                if (found) return found;
-            }
-        }
-    }
-}
-
-declare type deepClonePredicate = (owner: any, propertyName: string, current: any) => boolean;
-
-export function deepClone(obj: any, predicate?: deepClonePredicate): any {
-    if (obj !== null && obj !== undefined && typeof obj === "object") {
-        let clone;
-        if (Array.isArray(obj)) clone = [];
-        else {
-            clone = Object.create(obj);
-            Object.assign(clone, obj);
-        }
-        for (const key of Object.keys(obj)) {
-            const val = obj[key];
-            if (predicate && !predicate(obj, key, val)) {
-                // console.log("SKIP", val);
-                clone[key] = val;
-            }
-            else if (val?.clone !== undefined && typeof val.clone === "function")
-                clone[key] = val.clone();
-            else
-                clone[key] = deepClone(val, predicate);
-        }
-        return clone;
-    }
-    return obj;
-}
-
-export function delay(milliseconds: number): Promise<void> {
-    return new Promise((res, _) => {
-        setTimeout(res, milliseconds);
-    });
-}
-
-// 1) if a timeline is exported via menu item the audio clip path is relative to the glb (same folder)
-// we need to detect that here and build the new audio source path relative to the new glb location
-// the same is/might be true for any file that is/will be exported via menu item
-// 2) if the needle.config assetDirectory is modified (from e.g. /assets to /needle/assets) when building a distributable our vite transform and copy plugin will move the files to dist/assets hence we cannot use project-relative paths (because the path changes). What we do instead if make all paths serialized in a glb relative to the glb. The rel: prefix is used to detect urls that need to be resolved.
-const debugGetPath = getParam("debugresolveurl");
-
-export const relativePathPrefix = "rel:";
-
-/** @deprecated use resolveUrl instead */
-export function getPath(source: SourceIdentifier | undefined, uri: string): string {
-    return resolveUrl(source, uri);
-}
-/**
- * Use to resolve a url serialized in a glTF file
- * @param source The uri of the loading file
- * @param uri The uri of the file to resolve, can be absolute or relative
- * @returns The resolved uri
- */
-export function resolveUrl(source: SourceIdentifier | undefined, uri: string): string {
-    if (uri === undefined) {
-        if (debugGetPath) console.warn("getPath: uri is undefined, returning uri", uri);
-        return uri;
-    }
-    if (uri.startsWith("./")) {
-        return uri;
-    }
-    if (uri.startsWith("http")) {
-        if (debugGetPath) console.warn("getPath: uri is absolute, returning uri", uri);
-        return uri;
-    }
-    if (source === undefined) {
-        if (debugGetPath) console.warn("getPath: source is undefined, returning uri", uri);
-        return uri;
-    }
-    if (uri.startsWith(relativePathPrefix)) {
-        uri = uri.substring(4);
-    }
-    const pathIndex = source.lastIndexOf("/");
-    if (pathIndex >= 0) {
-        // Take the source uri as the base path
-        const basePath = source.substring(0, pathIndex + 1);
-        // Append the relative uri
-        const newUri = basePath + uri;
-        // newUri = new URL(newUri, globalThis.location.href).href;
-        if (debugGetPath) console.log("source:", source, "- changed uri \nfrom", uri, "\n→ ", newUri, "\n" + basePath);
-        return newUri;
-    }
-    return uri;
-}
-// export function getPath(glbLocation: SourceIdentifier | undefined, path: string) {
-//     if (path && glbLocation && !path.includes("/")) {
-//         // get directory of glb and prepend it to the audio file path
-//         const pathIndex = glbLocation.lastIndexOf("/");
-//         if (pathIndex >= 0) {
-//             const newPath = glbLocation.substring(0, pathIndex + 1) + path;
-//             return newPath;
-//         }
-//     }
-//     return path;
-// }
-
-
-export type WriteCallback = (data: any, prop: string) => void;
-
-export interface IWatch {
-    subscribeWrite(callback: WriteCallback);
-    unsubscribeWrite(callback: WriteCallback);
-    apply();
-    revoke();
-    dispose();
-}
-
-
-// TODO: make it possible to add multiple watches to the same object property
-class WatchImpl implements IWatch {
-    subscribeWrite(callback: WriteCallback) {
-        this.writeCallbacks.push(callback);
-    }
-    unsubscribeWrite(callback: WriteCallback) {
-        const i = this.writeCallbacks.indexOf(callback);
-        if (i === -1) return;
-        this.writeCallbacks.splice(i, 1);
-    }
-    private writeCallbacks: (WriteCallback)[] = [];
-
-    constructor(object: object, prop: string) {
-        this._object = object;
-        this._prop = prop;
-        this._wrapperProp = Symbol("$" + prop);
-        this.apply();
-    }
-
-    private _applied: boolean = false;
-    private _object: any;
-    private _prop: string;
-    private _wrapperProp: symbol;
-
-    apply() {
-        if (this._applied) return;
-        if (!this._object) return;
-        const object = this._object;
-        const prop = this._prop;
-        if (object[prop] === undefined) return;
-        this._applied = true;
-
-        if (object[this._wrapperProp] !== undefined) {
-            console.warn("Watcher is being applied to an object that already has a wrapper property. This is not (yet) supported");
-        }
-
-        // create a wrapper property
-        const current = object[prop];
-        object[this._wrapperProp] = current;
-        // create wrapper methods
-        const getter = () => {
-            return object[this._wrapperProp];
-        }
-        const setter = (value) => {
-            object[this._wrapperProp] = value;
-            for (const write of this.writeCallbacks) {
-                write(value, this._prop);
-            }
-        }
-        // add the wrapper to the object
-        Object.defineProperty(object, prop, {
-            get: getter,
-            set: setter
-        });
-    }
-
-    revoke() {
-        if (!this._applied) return;
-        if (!this._object) return;
-        this._applied = false;
-        const object = this._object;
-        const prop = this._prop;
-        Reflect.deleteProperty(object, prop);
-        const current = object[this._wrapperProp];
-        object[prop] = current;
-        Reflect.deleteProperty(object, this._wrapperProp);
-    }
-
-    dispose() {
-        this.revoke();
-        this.writeCallbacks.length = 0;
-        this._object = null;
-    }
-}
-
-export class Watch implements IWatch {
-
-    private readonly _watches: IWatch[] = [];
-
-    constructor(object: object, str: string[] | string) {
-        if (Array.isArray(str)) {
-            for (const s of str) {
-                this._watches.push(new Watch(object, s));
-            }
-        }
-        else {
-            this._watches.push(new WatchImpl(object, str));
-        }
-    }
-
-    subscribeWrite(callback: WriteCallback) {
-        for (const w of this._watches) {
-            w.subscribeWrite(callback);
-        }
-    }
-    unsubscribeWrite(callback: WriteCallback) {
-        for (const w of this._watches) {
-            w.unsubscribeWrite(callback);
-        }
-    }
-
-    apply() {
-        for (const w of this._watches) {
-            w.apply();
-        }
-    }
-
-    revoke() {
-        for (const w of this._watches) {
-            w.revoke();
-        }
-    }
-
-    dispose() {
-        for (const w of this._watches) {
-            w.dispose();
-        }
-        this._watches.length = 0;
-    }
-}
-
-const watchesKey = Symbol("needle:watches");
-/** Subscribe to an object being written to
- * Currently supporting Vector3
- */
-export function watchWrite(vec: Vector, cb: Function) {
-    if (!vec[watchesKey]) {
-        if (vec instanceof Vector2) {
-            vec[watchesKey] = new Watch(vec, ["x", "y"]);
-        }
-        else if (vec instanceof Vector3) {
-            vec[watchesKey] = new Watch(vec, ["x", "y", "z"]);
-        }
-        else if (vec instanceof Vector4 || vec instanceof Quaternion) {
-            vec[watchesKey] = new Watch(vec, ["x", "y", "z", "w"]);
-        }
-        else {
-            return false;
-        }
-    }
-    vec[watchesKey].subscribeWrite(cb);
-    return true;
-}
-export function unwatchWrite(vec: Vector, cb: Function) {
-    if (!vec) return;
-    const watch = vec[watchesKey];
-    if (!watch) return;
-    watch.unsubscribeWrite(cb);
-};
-
-
-export function isMobileDevice() {
-    return (typeof window.orientation !== "undefined") || (navigator.userAgent.indexOf('IEMobile') !== -1);
-}
-
-export function isMozillaXR() {
-    return /WebXRViewer\//i.test(navigator.userAgent);
-}
-
-const iosDevices = ['iPad Simulator', 'iPhone Simulator', 'iPod Simulator', 'iPad', 'iPhone', 'iPod'];
-export function isiOS() {
-    return iosDevices.includes(navigator.platform)
-        // iPad on iOS 13 detection
-        || (navigator.userAgent.includes("Mac") && "ontouchend" in document)
-}
-
-export function isSafari() {
-    return /^((?!chrome|android).)*safari/i.test(navigator.userAgent);
-}
-
-export function isQuest() {
-    return navigator.userAgent.includes("OculusBrowser");
-}
-
-export async function microphonePermissionsGranted() {
-    try {
-        //@ts-ignore
-        const res = await navigator.permissions.query({ name: 'microphone' });
-        if (res.state === "denied") {
-            return false;
-        }
-        return true;
-    }
-    catch (err) {
-        console.error("Error querying `microphone` permissions.", err);
-        return false;
-    }
-}
-
-
-const cloudflareIPRegex = /ip=(?<ip>.+?)\n/s;
-export async function getIpCloudflare() {
-    const data = await fetch('https://www.cloudflare.com/cdn-cgi/trace');
-    const body = await data.text();
-    // we are only interested in the ip= part:
-    const match = cloudflareIPRegex.exec(body);
-    if (match)
-        return match[1];
-    return null;
-}
-
-export async function getIp() {
-    const res = await fetch("https://api.db-ip.com/v2/free/self");
-    const json = await res.json();
-    return json.ipAddress;
-}
-
-export type IpAndLocation = {
-    ipAddress: string;
-    continentCode: string;
-    continentName: string;
-    countryCode: string;
-    countryName: string;
-    stateProv: string;
-    city: string;
-}
-export async function getIpAndLocation(): Promise<IpAndLocation> {
-    const res = (await fetch("https://api.db-ip.com/v2/free/self").catch(() => null))!;
-    const json = await res.json() as IpAndLocation;
-    return json;
-}
-
-
-
-
-
-declare type AttributeChangeCallback = (value: string | null) => void;
-declare type HtmlElementExtra = {
-    observer: MutationObserver,
-    attributeChangedListeners: Map<string, Array<AttributeChangeCallback>>,
-}
-const mutationObserverMap = new WeakMap<HTMLElement, HtmlElementExtra>();
-
-/** Register a callback when a attribute changes */
-export function addAttributeChangeCallback(domElement: HTMLElement, name: string, callback: AttributeChangeCallback) {
-    if (!mutationObserverMap.get(domElement)) {
-        const observer = new MutationObserver((mutations) => {
-            handleMutations(domElement, mutations);
-        });
-        mutationObserverMap.set(domElement, {
-            observer,
-            attributeChangedListeners: new Map<string, Array<AttributeChangeCallback>>(),
-        });
-        observer.observe(domElement, { attributes: true });
-    }
-
-    const listeners = mutationObserverMap.get(domElement)!.attributeChangedListeners;
-    if (!listeners.has(name)) {
-        listeners.set(name, []);
-    }
-    listeners.get(name)!.push(callback);
-};
-export function removeAttributeChangeCallback(domElement: HTMLElement, name: string, callback: AttributeChangeCallback) {
-    if (!mutationObserverMap.get(domElement)) return;
-    const listeners = mutationObserverMap.get(domElement)!.attributeChangedListeners;
-    if (!listeners.has(name)) return;
-    const arr = listeners.get(name);
-    const index = arr!.indexOf(callback);
-    if (index === -1) return;
-    arr!.splice(index, 1);
-    if (arr!.length <= 0) {
-        listeners.delete(name);
-        const entry = mutationObserverMap.get(domElement);
-        entry?.observer.disconnect();
-        mutationObserverMap.delete(domElement);
-    }
-}
-
-function handleMutations(domElement: HTMLElement, mutations: Array<MutationRecord>) {
-    const listeners = mutationObserverMap.get(domElement)!.attributeChangedListeners;
-    for (const mut of mutations) {
-        if (mut.type === "attributes") {
-            const name = mut.attributeName!;
-            const value = domElement.getAttribute(name);
-            if (listeners.has(name)) {
-                for (const listener of listeners.get(name)!) {
-                    listener(value);
-                }
-            }
-        }
-    }
-
-}
-
-
-export class PromiseErrorResult {
-    readonly reason: string;
-    constructor(reason: string) {
-        this.reason = reason;
-    }
-}
-
-/** Can be used to simplify Promise error handling and if errors are acceptable. 
- * Promise.all will just fail if any of the provided promises fails and not return or cancel pending promises or partial results
- * Using Promise.allSettled (or this method) instead will return a result for each promise and not automatically fail if any of the promises fails.
- * Instead it will return a promise containing information if any of the promises failed
- * and the actual results will be available as `results` array
- **/
-export async function PromiseAllWithErrors<T>(promise: Promise<T>[]): Promise<{
-    anyFailed: boolean,
-    results: Array<T | PromiseErrorResult>
-}> {
-    const results = await Promise.allSettled(promise).catch(err => {
-        return [
-            new PromiseErrorResult(err.message)
-        ];
-    })
-    let anyFailed: boolean = false;
-    const res = results.map(x => {
-        if ("value" in x) return x.value;
-        anyFailed = true;
-        return new PromiseErrorResult(x.reason);
-    });
-    return {
-        anyFailed: anyFailed,
-        results: res,
-    };
+// use for typesafe interface method calls
+import { Quaternion, type Vector, Vector2, Vector3, Vector4 } from "three";
+import { type SourceIdentifier } from "./engine_types.js";
+
+// https://schneidenbach.gitbooks.io/typescript-cookbook/content/nameof-operator.html
+export const nameofFactory = <T>() => (name: keyof T) => name;
+export function nameof<T>(name: keyof T) {
+    return nameofFactory<T>()(name);
+}
+
+
+export function isDebugMode(): boolean {
+    return getParam("debug") ? true : false;
+}
+
+
+
+export class CircularBuffer<T> {
+    private _factory: () => T;
+    private _cache: T[] = [];
+    private _maxSize: number;
+    private _index: number = 0;
+
+    constructor(factory: () => T, maxSize: number) {
+        this._factory = factory;
+        this._maxSize = maxSize;
+    }
+
+    get(): T {
+        const i = this._index % this._maxSize;
+        this._index++;
+        if (this._cache.length <= i) {
+            this._cache[i] = this._factory();
+        }
+        return this._cache[i];
+    }
+}
+
+
+
+let saveParams: boolean = false;
+const requestedParams: Array<string> = [];
+setTimeout(() => {
+    if (saveParams) {
+        console.log(requestedParams.sort());
+    }
+}, 100);
+
+export function getUrlParams() {
+    // "window" may not exist in node.js
+    return new URLSearchParams(globalThis.location?.search);
+}
+
+// bit strange that we have to pass T in here as well but otherwise the type parameter is stripped it seems
+type Param<T extends string> = string | boolean | number | T;
+
+/** Checks if a url parameter exists.
+ * Returns true if it exists but has no value (e.g. ?help)
+ * Returns false if it does not exist
+ * Returns false if it's set to 0 e.g. ?debug=0
+ * Returns the value if it exists e.g. ?message=hello
+ */
+export function getParam<T extends string>(paramName: T): Param<T> {
+    if (saveParams && !requestedParams.includes(paramName))
+        requestedParams.push(paramName);
+    const urlParams = getUrlParams();
+    if (urlParams.has(paramName)) {
+        const val = urlParams.get(paramName);
+        if (val) {
+            const num = Number(val);
+            if (!isNaN(num)) return num;
+            return val;
+        }
+        else return true;
+    }
+    return false;
+}
+saveParams = getParam("help") === true;
+
+export function setParam(paramName: string, paramValue: string): void {
+    const urlParams = getUrlParams();
+    if (urlParams.has(paramName)) {
+        urlParams.set(paramName, paramValue);
+    }
+    else
+        urlParams.append(paramName, paramValue);
+    document.location.search = urlParams.toString();
+}
+
+export function setParamWithoutReload(paramName: string, paramValue: string | null, appendHistory = true): void {
+    const urlParams = getUrlParams();
+    if (urlParams.has(paramName)) {
+        if (paramValue === null) urlParams.delete(paramName);
+        else urlParams.set(paramName, paramValue);
+    }
+    else if (paramValue !== null)
+        urlParams.append(paramName, paramValue);
+    if (appendHistory) pushState(paramName, urlParams);
+    else setState(paramName, urlParams);
+}
+
+export function setOrAddParamsToUrl(url: URLSearchParams, paramName: string, paramValue: string | number): void {
+    if (url.has(paramName)) {
+        url.set(paramName, paramValue.toString());
+    }
+    else
+        url.append(paramName, paramValue.toString());
+}
+
+export function pushState(title: string, urlParams: URLSearchParams, state?: any) {
+    window.history.pushState(state, title, "?" + urlParams.toString());
+}
+
+export function setState(title: string, urlParams: URLSearchParams, state?: any) {
+    window.history.replaceState(state, title, "?" + urlParams.toString());
+}
+
+// for room id
+export function makeId(length): string {
+    var result = '';
+    var characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
+    var charactersLength = characters.length;
+    for (var i = 0; i < length; i++) {
+        result += characters.charAt(Math.floor(Math.random() *
+            charactersLength));
+    }
+    return result;
+}
+
+export function randomNumber(min, max) {
+    return Math.floor(Math.random() * (max - min + 1)) + min;
+}
+
+const adjectives = ["smol", "tiny", "giant", "interesting", "smart", "bright", "dull", "extreme", "beautiful", "pretty", "dark", "epic", "salty", "silly", "funny", "lame", "lazy", "loud", "lucky", "mad", "mean", "mighty", "mysterious", "nasty", "odd", "old", "powerful", "quiet", "rapid", "scary", "shiny", "shy", "silly", "smooth", "sour", "spicy", "stupid", "sweet", "tasty", "terrible", "ugly", "unusual", "vast", "wet", "wild", "witty", "wrong", "zany", "zealous", "zippy", "zombie", "zorro"];
+const nouns = ["cat", "dog", "mouse", "pig", "cow", "horse", "sheep", "chicken", "duck", "goat", "panda", "tiger", "lion", "elephant", "monkey", "bird", "fish", "snake", "frog", "turtle", "hamster", "penguin", "kangaroo", "whale", "dolphin", "crocodile", "snail", "ant", "bee", "beetle", "butterfly", "dragon", "eagle", "fish", "giraffe", "lizard", "panda", "penguin", "rabbit", "snake", "spider", "tiger", "zebra"]
+export function makeIdFromRandomWords(): string {
+    const randomAdjective = adjectives[Math.floor(Math.random() * adjectives.length)];
+    const randomNoun = nouns[Math.floor(Math.random() * nouns.length)];
+    return randomAdjective + "_" + randomNoun;
+}
+
+// for url parameters
+export function sanitizeString(str): string {
+    str = str.replace(/[^a-z0-9áéíóúñü \.,_-]/gim, "");
+    return str.trim();
+}
+
+
+// TODO: taken from scene utils
+export function tryFindObject(globalObjectIdentifier: string, obj, recursive: boolean = true, searchComponents: boolean = false) {
+    if (obj === undefined || obj === null) return null;
+
+    if (obj.userData && obj.userData.guid === globalObjectIdentifier) return obj;
+    else if (obj.guid == globalObjectIdentifier) return obj;
+
+    if (searchComponents) {
+        if (obj.userData?.components) {
+            for (const comp of obj.userData.components) {
+                if (comp.guid === globalObjectIdentifier) return comp;
+            }
+        }
+    }
+
+    if (recursive) {
+
+        if (obj.scenes) {
+            for (const i in obj.scenes) {
+                const scene = obj.scenes[i];
+                const found = tryFindObject(globalObjectIdentifier, scene, recursive, searchComponents);
+                if (found) return found;
+            }
+        }
+
+        if (obj.children) {
+            for (const i in obj.children) {
+                const child = obj.children[i];
+                const found = tryFindObject(globalObjectIdentifier, child, recursive, searchComponents);
+                if (found) return found;
+            }
+        }
+    }
+}
+
+declare type deepClonePredicate = (owner: any, propertyName: string, current: any) => boolean;
+
+export function deepClone(obj: any, predicate?: deepClonePredicate): any {
+    if (obj !== null && obj !== undefined && typeof obj === "object") {
+        let clone;
+        if (Array.isArray(obj)) clone = [];
+        else {
+            clone = Object.create(obj);
+            Object.assign(clone, obj);
+        }
+        for (const key of Object.keys(obj)) {
+            const val = obj[key];
+            if (predicate && !predicate(obj, key, val)) {
+                // console.log("SKIP", val);
+                clone[key] = val;
+            }
+            else if (val?.clone !== undefined && typeof val.clone === "function")
+                clone[key] = val.clone();
+            else
+                clone[key] = deepClone(val, predicate);
+        }
+        return clone;
+    }
+    return obj;
+}
+
+export function delay(milliseconds: number): Promise<void> {
+    return new Promise((res, _) => {
+        setTimeout(res, milliseconds);
+    });
+}
+
+// 1) if a timeline is exported via menu item the audio clip path is relative to the glb (same folder)
+// we need to detect that here and build the new audio source path relative to the new glb location
+// the same is/might be true for any file that is/will be exported via menu item
+// 2) if the needle.config assetDirectory is modified (from e.g. /assets to /needle/assets) when building a distributable our vite transform and copy plugin will move the files to dist/assets hence we cannot use project-relative paths (because the path changes). What we do instead if make all paths serialized in a glb relative to the glb. The rel: prefix is used to detect urls that need to be resolved.
+const debugGetPath = getParam("debugresolveurl");
+
+export const relativePathPrefix = "rel:";
+
+/** @deprecated use resolveUrl instead */
+export function getPath(source: SourceIdentifier | undefined, uri: string): string {
+    return resolveUrl(source, uri);
+}
+/**
+ * Use to resolve a url serialized in a glTF file
+ * @param source The uri of the loading file
+ * @param uri The uri of the file to resolve, can be absolute or relative
+ * @returns The resolved uri
+ */
+export function resolveUrl(source: SourceIdentifier | undefined, uri: string): string {
+    if (uri === undefined) {
+        if (debugGetPath) console.warn("getPath: uri is undefined, returning uri", uri);
+        return uri;
+    }
+    if (uri.startsWith("./")) {
+        return uri;
+    }
+    if (uri.startsWith("http")) {
+        if (debugGetPath) console.warn("getPath: uri is absolute, returning uri", uri);
+        return uri;
+    }
+    if (source === undefined) {
+        if (debugGetPath) console.warn("getPath: source is undefined, returning uri", uri);
+        return uri;
+    }
+    if (uri.startsWith(relativePathPrefix)) {
+        uri = uri.substring(4);
+    }
+    const pathIndex = source.lastIndexOf("/");
+    if (pathIndex >= 0) {
+        // Take the source uri as the base path
+        const basePath = source.substring(0, pathIndex + 1);
+        // Append the relative uri
+        const newUri = basePath + uri;
+        // newUri = new URL(newUri, globalThis.location.href).href;
+        if (debugGetPath) console.log("source:", source, "- changed uri \nfrom", uri, "\n→ ", newUri, "\n" + basePath);
+        return newUri;
+    }
+    return uri;
+}
+// export function getPath(glbLocation: SourceIdentifier | undefined, path: string) {
+//     if (path && glbLocation && !path.includes("/")) {
+//         // get directory of glb and prepend it to the audio file path
+//         const pathIndex = glbLocation.lastIndexOf("/");
+//         if (pathIndex >= 0) {
+//             const newPath = glbLocation.substring(0, pathIndex + 1) + path;
+//             return newPath;
+//         }
+//     }
+//     return path;
+// }
+
+
+export type WriteCallback = (data: any, prop: string) => void;
+
+export interface IWatch {
+    subscribeWrite(callback: WriteCallback);
+    unsubscribeWrite(callback: WriteCallback);
+    apply();
+    revoke();
+    dispose();
+}
+
+
+// TODO: make it possible to add multiple watches to the same object property
+class WatchImpl implements IWatch {
+    subscribeWrite(callback: WriteCallback) {
+        this.writeCallbacks.push(callback);
+    }
+    unsubscribeWrite(callback: WriteCallback) {
+        const i = this.writeCallbacks.indexOf(callback);
+        if (i === -1) return;
+        this.writeCallbacks.splice(i, 1);
+    }
+    private writeCallbacks: (WriteCallback)[] = [];
+
+    constructor(object: object, prop: string) {
+        this._object = object;
+        this._prop = prop;
+        this._wrapperProp = Symbol("$" + prop);
+        this.apply();
+    }
+
+    private _applied: boolean = false;
+    private _object: any;
+    private _prop: string;
+    private _wrapperProp: symbol;
+
+    apply() {
+        if (this._applied) return;
+        if (!this._object) return;
+        const object = this._object;
+        const prop = this._prop;
+        if (object[prop] === undefined) return;
+        this._applied = true;
+
+        if (object[this._wrapperProp] !== undefined) {
+            console.warn("Watcher is being applied to an object that already has a wrapper property. This is not (yet) supported");
+        }
+
+        // create a wrapper property
+        const current = object[prop];
+        object[this._wrapperProp] = current;
+        // create wrapper methods
+        const getter = () => {
+            return object[this._wrapperProp];
+        }
+        const setter = (value) => {
+            object[this._wrapperProp] = value;
+            for (const write of this.writeCallbacks) {
+                write(value, this._prop);
+            }
+        }
+        // add the wrapper to the object
+        Object.defineProperty(object, prop, {
+            get: getter,
+            set: setter
+        });
+    }
+
+    revoke() {
+        if (!this._applied) return;
+        if (!this._object) return;
+        this._applied = false;
+        const object = this._object;
+        const prop = this._prop;
+        Reflect.deleteProperty(object, prop);
+        const current = object[this._wrapperProp];
+        object[prop] = current;
+        Reflect.deleteProperty(object, this._wrapperProp);
+    }
+
+    dispose() {
+        this.revoke();
+        this.writeCallbacks.length = 0;
+        this._object = null;
+    }
+}
+
+export class Watch implements IWatch {
+
+    private readonly _watches: IWatch[] = [];
+
+    constructor(object: object, str: string[] | string) {
+        if (Array.isArray(str)) {
+            for (const s of str) {
+                this._watches.push(new Watch(object, s));
+            }
+        }
+        else {
+            this._watches.push(new WatchImpl(object, str));
+        }
+    }
+
+    subscribeWrite(callback: WriteCallback) {
+        for (const w of this._watches) {
+            w.subscribeWrite(callback);
+        }
+    }
+    unsubscribeWrite(callback: WriteCallback) {
+        for (const w of this._watches) {
+            w.unsubscribeWrite(callback);
+        }
+    }
+
+    apply() {
+        for (const w of this._watches) {
+            w.apply();
+        }
+    }
+
+    revoke() {
+        for (const w of this._watches) {
+            w.revoke();
+        }
+    }
+
+    dispose() {
+        for (const w of this._watches) {
+            w.dispose();
+        }
+        this._watches.length = 0;
+    }
+}
+
+const watchesKey = Symbol("needle:watches");
+/** Subscribe to an object being written to
+ * Currently supporting Vector3
+ */
+export function watchWrite(vec: Vector, cb: Function) {
+    if (!vec[watchesKey]) {
+        if (vec instanceof Vector2) {
+            vec[watchesKey] = new Watch(vec, ["x", "y"]);
+        }
+        else if (vec instanceof Vector3) {
+            vec[watchesKey] = new Watch(vec, ["x", "y", "z"]);
+        }
+        else if (vec instanceof Vector4 || vec instanceof Quaternion) {
+            vec[watchesKey] = new Watch(vec, ["x", "y", "z", "w"]);
+        }
+        else {
+            return false;
+        }
+    }
+    vec[watchesKey].subscribeWrite(cb);
+    return true;
+}
+export function unwatchWrite(vec: Vector, cb: Function) {
+    if (!vec) return;
+    const watch = vec[watchesKey];
+    if (!watch) return;
+    watch.unsubscribeWrite(cb);
+};
+
+
+export function isMobileDevice() {
+    return (typeof window.orientation !== "undefined") || (navigator.userAgent.indexOf('IEMobile') !== -1);
+}
+
+export function isMozillaXR() {
+    return /WebXRViewer\//i.test(navigator.userAgent);
+}
+
+const iosDevices = ['iPad Simulator', 'iPhone Simulator', 'iPod Simulator', 'iPad', 'iPhone', 'iPod'];
+export function isiOS() {
+    return iosDevices.includes(navigator.platform)
+        // iPad on iOS 13 detection
+        || (navigator.userAgent.includes("Mac") && "ontouchend" in document)
+}
+
+export function isSafari() {
+    return /^((?!chrome|android).)*safari/i.test(navigator.userAgent);
+}
+
+export function isQuest() {
+    return navigator.userAgent.includes("OculusBrowser");
+}
+
+export async function microphonePermissionsGranted() {
+    try {
+        //@ts-ignore
+        const res = await navigator.permissions.query({ name: 'microphone' });
+        if (res.state === "denied") {
+            return false;
+        }
+        return true;
+    }
+    catch (err) {
+        console.error("Error querying `microphone` permissions.", err);
+        return false;
+    }
+}
+
+
+const cloudflareIPRegex = /ip=(?<ip>.+?)\n/s;
+export async function getIpCloudflare() {
+    const data = await fetch('https://www.cloudflare.com/cdn-cgi/trace');
+    const body = await data.text();
+    // we are only interested in the ip= part:
+    const match = cloudflareIPRegex.exec(body);
+    if (match)
+        return match[1];
+    return null;
+}
+
+export async function getIp() {
+    const res = await fetch("https://api.db-ip.com/v2/free/self");
+    const json = await res.json();
+    return json.ipAddress;
+}
+
+export type IpAndLocation = {
+    ipAddress: string;
+    continentCode: string;
+    continentName: string;
+    countryCode: string;
+    countryName: string;
+    stateProv: string;
+    city: string;
+}
+export async function getIpAndLocation(): Promise<IpAndLocation> {
+    const res = (await fetch("https://api.db-ip.com/v2/free/self").catch(() => null))!;
+    const json = await res.json() as IpAndLocation;
+    return json;
+}
+
+
+
+
+
+declare type AttributeChangeCallback = (value: string | null) => void;
+declare type HtmlElementExtra = {
+    observer: MutationObserver,
+    attributeChangedListeners: Map<string, Array<AttributeChangeCallback>>,
+}
+const mutationObserverMap = new WeakMap<HTMLElement, HtmlElementExtra>();
+
+/** Register a callback when a attribute changes */
+export function addAttributeChangeCallback(domElement: HTMLElement, name: string, callback: AttributeChangeCallback) {
+    if (!mutationObserverMap.get(domElement)) {
+        const observer = new MutationObserver((mutations) => {
+            handleMutations(domElement, mutations);
+        });
+        mutationObserverMap.set(domElement, {
+            observer,
+            attributeChangedListeners: new Map<string, Array<AttributeChangeCallback>>(),
+        });
+        observer.observe(domElement, { attributes: true });
+    }
+
+    const listeners = mutationObserverMap.get(domElement)!.attributeChangedListeners;
+    if (!listeners.has(name)) {
+        listeners.set(name, []);
+    }
+    listeners.get(name)!.push(callback);
+};
+export function removeAttributeChangeCallback(domElement: HTMLElement, name: string, callback: AttributeChangeCallback) {
+    if (!mutationObserverMap.get(domElement)) return;
+    const listeners = mutationObserverMap.get(domElement)!.attributeChangedListeners;
+    if (!listeners.has(name)) return;
+    const arr = listeners.get(name);
+    const index = arr!.indexOf(callback);
+    if (index === -1) return;
+    arr!.splice(index, 1);
+    if (arr!.length <= 0) {
+        listeners.delete(name);
+        const entry = mutationObserverMap.get(domElement);
+        entry?.observer.disconnect();
+        mutationObserverMap.delete(domElement);
+    }
+}
+
+function handleMutations(domElement: HTMLElement, mutations: Array<MutationRecord>) {
+    const listeners = mutationObserverMap.get(domElement)!.attributeChangedListeners;
+    for (const mut of mutations) {
+        if (mut.type === "attributes") {
+            const name = mut.attributeName!;
+            const value = domElement.getAttribute(name);
+            if (listeners.has(name)) {
+                for (const listener of listeners.get(name)!) {
+                    listener(value);
+                }
+            }
+        }
+    }
+
+}
+
+
+export class PromiseErrorResult {
+    readonly reason: string;
+    constructor(reason: string) {
+        this.reason = reason;
+    }
+}
+
+/** Can be used to simplify Promise error handling and if errors are acceptable. 
+ * Promise.all will just fail if any of the provided promises fails and not return or cancel pending promises or partial results
+ * Using Promise.allSettled (or this method) instead will return a result for each promise and not automatically fail if any of the promises fails.
+ * Instead it will return a promise containing information if any of the promises failed
+ * and the actual results will be available as `results` array
+ **/
+export async function PromiseAllWithErrors<T>(promise: Promise<T>[]): Promise<{
+    anyFailed: boolean,
+    results: Array<T | PromiseErrorResult>
+}> {
+    const results = await Promise.allSettled(promise).catch(err => {
+        return [
+            new PromiseErrorResult(err.message)
+        ];
+    })
+    let anyFailed: boolean = false;
+    const res = results.map(x => {
+        if ("value" in x) return x.value;
+        anyFailed = true;
+        return new PromiseErrorResult(x.reason);
+    });
+    return {
+        anyFailed: anyFailed,
+        results: res,
+    };
 }