@needle-tools/engine 4.7.0-alpha → 4.7.0-next.da47826

package/lib/engine/engine_serialization_core.js

@@ -1,608 +1,608 @@
-import { AnimationClip, BufferGeometry, Material, Mesh, Texture } from "three";
-import { debugExtension } from "../engine/engine_default_parameters.js";
-import { addLog, LogType } from "./debug/debug_overlay.js";
-import { isLocalNetwork } from "./engine_networking_utils.js";
-import { $BuiltInTypeFlag, TypeStore } from "./engine_typestore.js";
-import { getParam } from "./engine_utils.js";
-import { isPersistentAsset } from "./extensions/NEEDLE_persistent_assets.js";
-const debug = getParam("debugserializer");
-// internal helper class that we can ask for registered type serializers
-// register your own type by deriving from ITypeSerializer and calling helper.register
-class SerializationHelper {
-    register(type, ser) {
-        if (this.typeMap.has(type)) {
-            const existing = this.typeMap.get(type);
-            if (existing === ser)
-                return;
-            if (debug)
-                console.warn("Type: " + type + " is already registered", ser, existing);
-        }
-        if (debug)
-            console.log("Register type serializer", ser.name, ser, type);
-        this.typeMap.set(type, ser);
-    }
-    /** type > serializer map */
-    typeMap = new Map();
-    getSerializer(type) {
-        if (!type)
-            return undefined;
-        return this.typeMap.get(type);
-    }
-    getSerializerForConstructor(type, level = 0) {
-        if (level > 20)
-            return undefined;
-        if (!type || !type.constructor) {
-            if (debug)
-                console.log("invalid type");
-            return undefined;
-        }
-        const name = type.name;
-        const res = this.getSerializer(type);
-        if (res !== undefined) {
-            if (debug)
-                console.log("FOUND SERIALIZER", res?.name, type.name, type.constructor.name, "for type: " + name, res, type, this.typeMap);
-            return res;
-        }
-        const parent = Object.getPrototypeOf(type);
-        if (parent && parent !== type) {
-            const resultFromChildren = this.getSerializerForConstructor(parent, ++level);
-            if (resultFromChildren) {
-                const prot = parent.constructor || parent.prototype;
-                if (debug)
-                    console.log("FOUND SERIALIZER(in constructor) " + prot.constructor.name, prot.name, prot, resultFromChildren);
-                // register sub type
-                this.register(prot, resultFromChildren);
-            }
-            return resultFromChildren;
-        }
-        if (debug)
-            console.warn("No serializer found for " + name, type, type.name, type.constructor.name);
-        return undefined;
-    }
-}
-export const helper = new SerializationHelper();
-/**
- * implement and call super(<type string or array>) with the type names this serializer can handle
- * for example:
- * class ColorSerializer extends TypeSerializer {
- *  constructor() {
- *      super("Color")
- *  }
- * }
-*/
-export class TypeSerializer {
-    name;
-    // register<T>(c: Constructor<T> | Constructor<T>[])
-    // {
-    //     if (Array.isArray(c)) {
-    //         for (const t of c) {
-    //             helper.register(t.name, this);
-    //         }
-    //     }
-    //     else {
-    //         helper.register(c.name, this);
-    //     }
-    // }
-    constructor(type, name) {
-        this.name = name;
-        if (Array.isArray(type)) {
-            for (const key of type) {
-                helper.register(key, this);
-            }
-        }
-        else
-            helper.register(type, this);
-    }
-}
-/** holds information if a field was undefined before serialization. This gives us info if we might want to warn the user about missing attributes */
-export class ImplementationInformation {
-    isDevMode = isLocalNetwork();
-    cache = {};
-    /** only call when assigning values for the very first time */
-    registerDefinedKeys(typeName, type) {
-        if (!this.isDevMode)
-            return;
-        if (this.cache[typeName] === undefined) {
-            this.cache[typeName] = Object.keys(type);
-            const serializable = type;
-            // also register all fields that are annotated with @serializable
-            if (serializable.$serializedTypes) {
-                const keys = Object.keys(serializable.$serializedTypes);
-                if (keys)
-                    this.cache[typeName].push(...Object.keys(serializable.$serializedTypes));
-            }
-            if (debug)
-                console.log("registerDefinedKeys for " + typeName, this.cache[typeName], type);
-        }
-    }
-    getDefinedKey(typeName, key) {
-        if (this.cache[typeName] === undefined)
-            return false;
-        const keys = this.cache[typeName];
-        const res = keys.includes(key);
-        return res;
-    }
-}
-// passed to serializers
-export class SerializationContext {
-    root;
-    gltf;
-    /** the url of the glb that is currently being loaded */
-    gltfId;
-    object;
-    target;
-    nodeId;
-    nodeToObject;
-    objectToNode;
-    context;
-    path;
-    type;
-    /** the serializable attribute for this field (target.path) */
-    serializable;
-    /** holds information if a field was undefined before serialization. This gives us info if we might want to warn the user about missing attributes */
-    implementationInformation;
-    constructor(root) {
-        this.root = root;
-    }
-}
-;
-export function serializeObject(obj, context) {
-    const types = obj.$serializedTypes;
-    if (types === undefined)
-        return null;
-    const res = {};
-    for (const key in types) {
-        const val = obj[key];
-        // if the object bein serialized is some type of object check if we have special handling registered for it
-        if (val !== undefined && val !== null && typeof val === "object") {
-            // get type name
-            // get registered serialization handler
-            const ser = helper.getSerializerForConstructor(val);
-            if (ser) {
-                // serialize data using that handler
-                res[key] = ser.onSerialize(val, context);
-                continue;
-            }
-        }
-        res[key] = val;
-    }
-    // TODO move this to a helper function and do a reverse lookup once
-    // instead of doing it for each object
-    function getComponentName(component) {
-        const typeNames = TypeStore["_types"];
-        for (const [typeName, typeVal] of typeNames) {
-            if (typeVal === obj.constructor) {
-                return typeName;
-            }
-        }
-        return component.__name || component.constructor.name;
-    }
-    // name is the component type
-    res["name"] = getComponentName(obj);
-    // serialize guid
-    if (typeof obj["guid"] === "string")
-        res["guid"] = obj["guid"];
-    return res;
-}
-const buffer = [];
-function collectSerializedTypesInBaseTypes(obj, typeInfoObject) {
-    if (!obj)
-        return typeInfoObject;
-    if (typeof obj.$serializedTypes === "object") {
-        if (!typeInfoObject)
-            typeInfoObject = {};
-        Object.assign(typeInfoObject, obj.$serializedTypes);
-    }
-    const parentTarget = Object.getPrototypeOf(obj);
-    return collectSerializedTypesInBaseTypes(parentTarget, typeInfoObject);
-}
-export function deserializeObject(obj, serializedData, context) {
-    if (!obj)
-        return false;
-    context.target = obj;
-    if (obj.onBeforeDeserialize !== undefined) {
-        const res = obj.onBeforeDeserialize(serializedData, context);
-        if (typeof res === "boolean")
-            return res;
-    }
-    // const typeInfo = obj.$serializedTypes;
-    const typeInfo = collectSerializedTypesInBaseTypes(obj);
-    if (serializedData) {
-        // restore guid (see serializeObject)
-        if (typeof serializedData["guid"] === "string")
-            obj["guid"] = serializedData["guid"];
-        if (typeInfo) {
-            for (const key in typeInfo) {
-                const serializedEntryInfo = typeInfo[key];
-                const data = serializedData[key];
-                if (debug)
-                    console.log(key, data, obj, serializedEntryInfo);
-                if (obj[key] !== undefined && data === undefined) {
-                    // if a field is marked as serialized and has some default value
-                    // but no data was serialized do not override the default value with undefined
-                    continue;
-                }
-                context.type = undefined;
-                context.path = key;
-                context.serializable = serializedEntryInfo;
-                if (obj.onBeforeDeserializeMember !== undefined) {
-                    // callback to the instance, if it returns true assume it's done all the things itself
-                    if (obj.onBeforeDeserializeMember(key, data, context) === true)
-                        continue;
-                }
-                if (serializedEntryInfo === null) {
-                    obj[key] = data;
-                    // if(typeof data === "string"){
-                    //     const serializer = helper.getSerializerForConstructor(String);
-                    //     const res = serializer?.onDeserialize(data, context);
-                    //     if(res !== undefined) obj[key] = res;
-                    // }
-                }
-                else {
-                    if (Array.isArray(serializedEntryInfo)) {
-                        for (let i = 0; i < serializedEntryInfo.length; i++) {
-                            const typeInfoOrConstructor = serializedEntryInfo[i];
-                            const res = tryResolve(typeInfoOrConstructor);
-                            if (res !== undefined || i === serializedEntryInfo.length - 1) {
-                                obj[key] = res;
-                                break;
-                            }
-                        }
-                    }
-                    else {
-                        obj[key] = tryResolve(serializedEntryInfo);
-                    }
-                    buffer.length = 0;
-                }
-                if (obj.onAfterDeserializeMember !== undefined) {
-                    obj.onAfterDeserializeMember(key, data, context);
-                }
-                function tryResolve(typeInfoOrConstructor) {
-                    const typeInformationOrConstructor = typeInfoOrConstructor;
-                    // if the entry does specify an object of type ITypeInformation and has the type field set
-                    const type = typeInformationOrConstructor.type;
-                    if (type) {
-                        return deserializeObjectWithType(data, type, context, undefined, obj[key]);
-                    }
-                    // it can also just contain a constructor
-                    else {
-                        const constructor = typeInfoOrConstructor;
-                        return deserializeObjectWithType(data, constructor, context, undefined, obj[key]);
-                    }
-                }
-            }
-        }
-        // ***
-        // the code below could be used to implictly assign serialized data if they are primitive types
-        // if we decide not to do this we always have to write out all the $serializedTypes
-        // *** 
-        implictlyAssignPrimitiveTypes(obj, serializedData);
-    }
-    checkObjectAssignments(obj, serializedData, context.implementationInformation);
-    if (obj.onAfterDeserialize !== undefined) {
-        obj.onAfterDeserialize(serializedData, context);
-    }
-    return true;
-}
-const blockChecks = getParam("noerrors");
-function checkObjectAssignments(obj, serializedData, implementationInformation) {
-    if (blockChecks)
-        return;
-    if (!serializedData)
-        return;
-    if (!isLocalNetwork())
-        return;
-    if (!obj)
-        return;
-    // ignore builtin components that we dont want to check
-    if (obj.constructor && obj.constructor[$BuiltInTypeFlag] === true)
-        return;
-    const typeName = obj.constructor?.name;
-    // test if any object reference is missing serializable
-    const ownKeys = Object.getOwnPropertyNames(serializedData);
-    for (const key of ownKeys) {
-        if (key === "sourceId")
-            continue;
-        const value = obj[key];
-        if (value == null)
-            continue;
-        const serialized = serializedData[key];
-        // check if the field is defined in the class
-        if (implementationInformation?.getDefinedKey(typeName, key) === false) {
-            // if the field is defined but the defined key is uppercase we need to show a warning
-            // because all fields are serialized in lowercase
-            const firstCharUppercase = key.charAt(0).toUpperCase() + key.slice(1);
-            if (implementationInformation.getDefinedKey(typeName, firstCharUppercase)) {
-                addLog(LogType.Warn, "<strong>Please rename</strong> \"" + firstCharUppercase + "\" to \"" + key + "\" in " + typeName);
-                console.warn("Please use lowercase for field: \"" + firstCharUppercase + "\" in " + typeName, serialized, obj);
-            }
-            continue;
-        }
-        if (serialized === undefined || serialized === null)
-            continue;
-        if (typeof serialized === "object") {
-            if (value === undefined || !value.isObject3D) {
-                if (typeof serialized["node"] === "number" || typeof serialized["guid"] === "string") {
-                    if (serialized["could_not_resolve"]) {
-                        continue;
-                    }
-                    const hasOtherKeys = value !== undefined && Object.keys(value).length > 1;
-                    if (!hasOtherKeys) {
-                        addLog(LogType.Warn, `<strong>Missing serialization for object reference!</strong>\n\nPlease change to: \n@serializable(Object3D)\n${key}? : Object3D;\n\nin ${typeName}.ts\n<a href="https://docs.needle.tools/serializable" target="_blank">See documentation</a>`);
-                        console.warn(typeName, key, obj[key], obj);
-                        continue;
-                    }
-                }
-                else if (!Array.isArray(value)) {
-                    // we can check the constructor name because this is dev only
-                    const valueName = value.constructor?.name;
-                    if (valueName === "Object") {
-                        if (!value.constructor["did_warn:missing_serializable"]) {
-                            value.constructor["did_warn:missing_serializable"] = true;
-                            const warning = "You might be missing a @serializable(Type) decorator for field \"" + key + "\" in " + typeName + ".ts";
-                            console.warn(warning + `\n${key}:`, serialized, valueName);
-                            addLog(LogType.Warn, "Dev Warning: Are you missing a type in @serializable? Please check the browser console for details");
-                        }
-                    }
-                }
-            }
-        }
-        if (typeof value === "string") {
-            if (typeof serialized === "string" && (serialized.endsWith(".gltf") || serialized.endsWith(".glb"))) {
-                addLog(LogType.Warn, `<strong>Missing serialization for object reference!</strong>\n\nPlease change to: \n@serializable(AssetReference)\n${key}? : AssetReference;\n\nin script ${typeName}.ts\n<a href="https://docs.needle.tools/serializable" target="_blank">documentation</a>`);
-                console.warn(typeName, key, obj[key], obj);
-                continue;
-            }
-        }
-    }
-}
-function implictlyAssignPrimitiveTypes(obj, serializedData) {
-    // implictly assign serialized primitive fields
-    for (const key of Object.keys(serializedData)) {
-        const data = serializedData[key];
-        if (typeof data === "object" && data !== null && data !== undefined) {
-            const member = obj[key];
-            if (!member) {
-                if (debug)
-                    console.log(key, "is undefined on", obj);
-                continue;
-            }
-            for (const key of Object.keys(data)) {
-                const targetMember = member[key];
-                // implictly assign number, string, boolean if they are undefined
-                if (targetMember !== undefined)
-                    continue;
-                // resolve serialized primitive types
-                if (isPrimitiveType(data[key]) && !isPrimitiveType(member)) {
-                    const prop = tryFindPropertyDescriptor(member, key);
-                    if (prop && (prop?.writable === undefined || prop?.writable === false) && (prop.set === undefined)) {
-                        if (debug)
-                            console.warn("Property is not writable \"" + key + "\"", member, prop, data[key], member[key]);
-                        continue;
-                    }
-                    // console.log("ASSIGN", key, member, member[key], targetMember, data[key], prop);
-                    member[key] = data[key];
-                }
-            }
-        }
-    }
-}
-function tryFindPropertyDescriptor(obj, key) {
-    while (obj) {
-        const desc = Object.getOwnPropertyDescriptor(obj, key);
-        if (desc)
-            return desc;
-        obj = Object.getPrototypeOf(obj);
-    }
-    return undefined;
-}
-function isPrimitiveType(val) {
-    switch (typeof val) {
-        case "number":
-        case "string":
-        case "boolean":
-            return true;
-    }
-    return false;
-}
-function deserializeObjectWithType(data, typeOrConstructor, context, typeContext, currentValue) {
-    // e.g. @serializable((data) => { })
-    let typeIsFunction = typeof typeOrConstructor === "function" && (typeOrConstructor.prototype === undefined);
-    let type = typeOrConstructor;
-    if (typeIsFunction) {
-        // it's possible to assign a function to serializable to dynamically say which type we expect
-        // e.g. if you have an array of types and you want the array to be resolved with different class instances
-        try {
-            const resolvedType = typeOrConstructor?.call(typeOrConstructor, currentValue);
-            type = resolvedType;
-            typeIsFunction = false;
-            if (type === null || type === undefined)
-                return;
-        }
-        catch (err) {
-            console.error("Error in callback", err, data);
-        }
-    }
-    context.type = type;
-    // e.g. when @serializable(Texture) and the texture is already resolved via json pointer from gltf
-    // then we dont need to do anything else
-    if (!typeIsFunction && currentValue) {
-        if (currentValue instanceof Material)
-            return currentValue;
-        if (currentValue instanceof Mesh)
-            return currentValue;
-        if (currentValue instanceof BufferGeometry)
-            return currentValue;
-        if (currentValue instanceof AnimationClip)
-            return currentValue;
-        // We need to call the RenderTexture deserializer so we can not just return here:
-        // if (currentValue instanceof Texture) return currentValue;
-        // So this has now been moved down below the deserializer code
-    }
-    // Removed this line because it prevents assigning serialized values to existing instances for e.g. EventList
-    // https://linear.app/needle/issue/NE-5350
-    // if (!typeIsFunction && currentValue instanceof type) return currentValue;
-    // try to resolve the serializer for a type only once
-    if (!typeContext) {
-        typeContext = {
-            serializer: helper.getSerializerForConstructor(type)
-        };
-    }
-    // if the value was already resolved via the persistent asset extension dont try to override that again
-    if (currentValue && typeof currentValue === "object" && isPersistentAsset(currentValue)) {
-        // if the persistent asset was already resolved to a concrete instance we dont need to do anything anymore
-        if (currentValue["__concreteInstance"]) {
-            return currentValue["__concreteInstance"];
-        }
-        const serializableInstance = currentValue;
-        if (!serializableInstance.$serializedTypes && type.prototype.$serializedTypes)
-            serializableInstance.$serializedTypes = type.prototype.$serializedTypes;
-        if (serializableInstance.$serializedTypes) {
-            deserializeObject(serializableInstance, data, context);
-        }
-        if (currentValue && type !== undefined) {
-            try {
-                let instance = null;
-                // It's still possible that the type has an explicit serializer
-                // e.g. AnimatorController (or if a user registers a serializer for an arbitrary type and then marks a persistent asset with @serializable)
-                // we have this for @serializable(AnimatorController)
-                if (typeContext.serializer) {
-                    instance = typeContext.serializer.onDeserialize(data, context);
-                }
-                if (!instance) {
-                    // we create a concrete instance for a persistent asset here
-                    // hence we want to have the same instance across all usages of this asset
-                    instance = new type();
-                    if (debugExtension)
-                        console.log("Create concrete instance for persistent asset", currentValue, "instance:", instance);
-                    assign(instance, currentValue);
-                }
-                // save it so if another component references the same persistent asset it will automatically use the concrete instance
-                currentValue["__concreteInstance"] = instance;
-                currentValue = instance;
-            }
-            catch (err) {
-                console.error("Error creating instance or creating values on instance", err, currentValue, type);
-            }
-        }
-        return currentValue;
-    }
-    // if the type is an array resolve each entries recursively
-    if (Array.isArray(data)) {
-        const newArr = [];
-        for (let i = 0; i < data.length; i++) {
-            const obj = data[i];
-            // debugger;
-            const res = deserializeObjectWithType(obj, typeOrConstructor, context, typeContext, obj);
-            newArr.push(res);
-        }
-        // return value;
-        return newArr;
-    }
-    const ser = typeContext?.serializer;
-    if (ser) {
-        return ser.onDeserialize(data, context);
-    }
-    // console.log(type.prototype.get("$serializedTypes"));
-    // We check textures AFTER running deserializers because some textures might need to be converted to a RenderTexture
-    if (currentValue instanceof Texture)
-        return currentValue;
-    let instance = undefined;
-    if (data && (data.isMaterial || data.isTexture || data.isObject3D || data instanceof AnimationClip)) {
-        // if the data is already a threejs object we dont want to create a new instance
-        // e.g. if we have a serialized class with a serializable(Material)
-        instance = data;
-    }
-    else {
-        // happens when exporting e.g. Animation component with only clip assigned (clips array is marked as serialized but it might be undefined if no clips are assigned in e.g. blender)
-        if (data === undefined)
-            return undefined;
-        if (data === null) {
-            // Dont implictly create instances for three types that are not assigned
-            // see: https://github.com/needle-tools/needle-tiny/issues/637
-            if (type === Material || type === Texture || type === Mesh || type === AnimationClip) {
-                return null;
-            }
-        }
-        try {
-            // the fallback - this assumes that the type has a constructor that accepts the serialized arguments
-            // made originally with Vector3 in mind but SHOULD actually not be used/called anymore
-            instance = new type(...setBuffer(data));
-        }
-        catch (err) {
-            console.error("Error creating " + context.path, context.target, err);
-            return;
-        }
-    }
-    // recurse if the deserialized member also implements Iserializable
-    const serializableInstance = instance;
-    if (serializableInstance.$serializedTypes) {
-        deserializeObject(serializableInstance, data, context);
-    }
-    return instance;
-}
-function setBuffer(value) {
-    buffer.length = 0;
-    if (typeof value === "object" && value !== null && value !== undefined) {
-        for (const key of Object.keys(value)) {
-            buffer.push(value[key]);
-        }
-    }
-    return buffer;
-}
-/** set to true while assigning properties during instantiation.
- * Used for validate decorator to not invoke callbacks on components that are currently in the process of being built */
-export const $isAssigningProperties = Symbol("assigned component properties");
-/** Object.assign behaviour but check if property is writeable (e.g. getter only properties are skipped) */
-export function assign(target, source, info, opts) {
-    if (source === undefined || source === null)
-        return;
-    if (target === undefined || target === null)
-        return;
-    const onlyDeclared = false;
-    // if (onlyDeclared === true && target.constructor) {
-    //     if (target.constructor[ALL_PROPERTIES_MARKER] === true)
-    //         onlyDeclared = false;
-    // }
-    // if (onlyDeclared !== true && target.constructor) {
-    //     if (target.constructor[STRICT_MARKER] === true)
-    //         onlyDeclared = true;
-    // }
-    // if (onlyDeclared === undefined)
-    //     onlyDeclared = true;
-    // if (developmentMode)
-    //     onlyDeclared = false;
-    target[$isAssigningProperties] = true;
-    const typeName = target.constructor?.name ?? "unknown";
-    // register the keys that the actual type has defined
-    // this will be used later when checking if deserialization has assigned all properties
-    // or if anything could not be deserialized to warn the user
-    info?.registerDefinedKeys(typeName, target);
-    for (const key of Object.keys(source)) {
-        const desc = getPropertyDescriptor(target, key);
-        if (onlyDeclared && desc === undefined)
-            continue;
-        if (typeof desc?.value == "function") {
-            // arrow functions are defined as properties on the object
-            continue;
-        }
-        if (!desc || desc.writable === true) {
-            const value = opts?.onAssign ? opts.onAssign(source, key, source[key]) : source[key];
-            target[key] = value;
-        }
-        else if (desc?.set !== undefined) {
-            const value = opts?.onAssign ? opts.onAssign(source, key, source[key]) : source[key];
-            target[key] = value;
-        }
-    }
-    delete target[$isAssigningProperties];
-}
-// we need to recurse because the property might be defined in a base class
-function getPropertyDescriptor(obj, prop) {
-    let desc;
-    do {
-        desc = Object.getOwnPropertyDescriptor(obj, prop);
-    } while (!desc && (obj = Object.getPrototypeOf(obj)));
-    return desc;
-}
+import { AnimationClip, BufferGeometry, Material, Mesh, Texture } from "three";
+import { debugExtension } from "../engine/engine_default_parameters.js";
+import { addLog, LogType } from "./debug/debug_overlay.js";
+import { isLocalNetwork } from "./engine_networking_utils.js";
+import { $BuiltInTypeFlag, TypeStore } from "./engine_typestore.js";
+import { getParam } from "./engine_utils.js";
+import { isPersistentAsset } from "./extensions/NEEDLE_persistent_assets.js";
+const debug = getParam("debugserializer");
+// internal helper class that we can ask for registered type serializers
+// register your own type by deriving from ITypeSerializer and calling helper.register
+class SerializationHelper {
+    register(type, ser) {
+        if (this.typeMap.has(type)) {
+            const existing = this.typeMap.get(type);
+            if (existing === ser)
+                return;
+            if (debug)
+                console.warn("Type: " + type + " is already registered", ser, existing);
+        }
+        if (debug)
+            console.log("Register type serializer", ser.name, ser, type);
+        this.typeMap.set(type, ser);
+    }
+    /** type > serializer map */
+    typeMap = new Map();
+    getSerializer(type) {
+        if (!type)
+            return undefined;
+        return this.typeMap.get(type);
+    }
+    getSerializerForConstructor(type, level = 0) {
+        if (level > 20)
+            return undefined;
+        if (!type || !type.constructor) {
+            if (debug)
+                console.log("invalid type");
+            return undefined;
+        }
+        const name = type.name;
+        const res = this.getSerializer(type);
+        if (res !== undefined) {
+            if (debug)
+                console.log("FOUND SERIALIZER", res?.name, type.name, type.constructor.name, "for type: " + name, res, type, this.typeMap);
+            return res;
+        }
+        const parent = Object.getPrototypeOf(type);
+        if (parent && parent !== type) {
+            const resultFromChildren = this.getSerializerForConstructor(parent, ++level);
+            if (resultFromChildren) {
+                const prot = parent.constructor || parent.prototype;
+                if (debug)
+                    console.log("FOUND SERIALIZER(in constructor) " + prot.constructor.name, prot.name, prot, resultFromChildren);
+                // register sub type
+                this.register(prot, resultFromChildren);
+            }
+            return resultFromChildren;
+        }
+        if (debug)
+            console.warn("No serializer found for " + name, type, type.name, type.constructor.name);
+        return undefined;
+    }
+}
+export const helper = new SerializationHelper();
+/**
+ * implement and call super(<type string or array>) with the type names this serializer can handle
+ * for example:
+ * class ColorSerializer extends TypeSerializer {
+ *  constructor() {
+ *      super("Color")
+ *  }
+ * }
+*/
+export class TypeSerializer {
+    name;
+    // register<T>(c: Constructor<T> | Constructor<T>[])
+    // {
+    //     if (Array.isArray(c)) {
+    //         for (const t of c) {
+    //             helper.register(t.name, this);
+    //         }
+    //     }
+    //     else {
+    //         helper.register(c.name, this);
+    //     }
+    // }
+    constructor(type, name) {
+        this.name = name;
+        if (Array.isArray(type)) {
+            for (const key of type) {
+                helper.register(key, this);
+            }
+        }
+        else
+            helper.register(type, this);
+    }
+}
+/** holds information if a field was undefined before serialization. This gives us info if we might want to warn the user about missing attributes */
+export class ImplementationInformation {
+    isDevMode = isLocalNetwork();
+    cache = {};
+    /** only call when assigning values for the very first time */
+    registerDefinedKeys(typeName, type) {
+        if (!this.isDevMode)
+            return;
+        if (this.cache[typeName] === undefined) {
+            this.cache[typeName] = Object.keys(type);
+            const serializable = type;
+            // also register all fields that are annotated with @serializable
+            if (serializable.$serializedTypes) {
+                const keys = Object.keys(serializable.$serializedTypes);
+                if (keys)
+                    this.cache[typeName].push(...Object.keys(serializable.$serializedTypes));
+            }
+            if (debug)
+                console.log("registerDefinedKeys for " + typeName, this.cache[typeName], type);
+        }
+    }
+    getDefinedKey(typeName, key) {
+        if (this.cache[typeName] === undefined)
+            return false;
+        const keys = this.cache[typeName];
+        const res = keys.includes(key);
+        return res;
+    }
+}
+// passed to serializers
+export class SerializationContext {
+    root;
+    gltf;
+    /** the url of the glb that is currently being loaded */
+    gltfId;
+    object;
+    target;
+    nodeId;
+    nodeToObject;
+    objectToNode;
+    context;
+    path;
+    type;
+    /** the serializable attribute for this field (target.path) */
+    serializable;
+    /** holds information if a field was undefined before serialization. This gives us info if we might want to warn the user about missing attributes */
+    implementationInformation;
+    constructor(root) {
+        this.root = root;
+    }
+}
+;
+export function serializeObject(obj, context) {
+    const types = obj.$serializedTypes;
+    if (types === undefined)
+        return null;
+    const res = {};
+    for (const key in types) {
+        const val = obj[key];
+        // if the object bein serialized is some type of object check if we have special handling registered for it
+        if (val !== undefined && val !== null && typeof val === "object") {
+            // get type name
+            // get registered serialization handler
+            const ser = helper.getSerializerForConstructor(val);
+            if (ser) {
+                // serialize data using that handler
+                res[key] = ser.onSerialize(val, context);
+                continue;
+            }
+        }
+        res[key] = val;
+    }
+    // TODO move this to a helper function and do a reverse lookup once
+    // instead of doing it for each object
+    function getComponentName(component) {
+        const typeNames = TypeStore["_types"];
+        for (const [typeName, typeVal] of typeNames) {
+            if (typeVal === obj.constructor) {
+                return typeName;
+            }
+        }
+        return component.__name || component.constructor.name;
+    }
+    // name is the component type
+    res["name"] = getComponentName(obj);
+    // serialize guid
+    if (typeof obj["guid"] === "string")
+        res["guid"] = obj["guid"];
+    return res;
+}
+const buffer = [];
+function collectSerializedTypesInBaseTypes(obj, typeInfoObject) {
+    if (!obj)
+        return typeInfoObject;
+    if (typeof obj.$serializedTypes === "object") {
+        if (!typeInfoObject)
+            typeInfoObject = {};
+        Object.assign(typeInfoObject, obj.$serializedTypes);
+    }
+    const parentTarget = Object.getPrototypeOf(obj);
+    return collectSerializedTypesInBaseTypes(parentTarget, typeInfoObject);
+}
+export function deserializeObject(obj, serializedData, context) {
+    if (!obj)
+        return false;
+    context.target = obj;
+    if (obj.onBeforeDeserialize !== undefined) {
+        const res = obj.onBeforeDeserialize(serializedData, context);
+        if (typeof res === "boolean")
+            return res;
+    }
+    // const typeInfo = obj.$serializedTypes;
+    const typeInfo = collectSerializedTypesInBaseTypes(obj);
+    if (serializedData) {
+        // restore guid (see serializeObject)
+        if (typeof serializedData["guid"] === "string")
+            obj["guid"] = serializedData["guid"];
+        if (typeInfo) {
+            for (const key in typeInfo) {
+                const serializedEntryInfo = typeInfo[key];
+                const data = serializedData[key];
+                if (debug)
+                    console.log(key, data, obj, serializedEntryInfo);
+                if (obj[key] !== undefined && data === undefined) {
+                    // if a field is marked as serialized and has some default value
+                    // but no data was serialized do not override the default value with undefined
+                    continue;
+                }
+                context.type = undefined;
+                context.path = key;
+                context.serializable = serializedEntryInfo;
+                if (obj.onBeforeDeserializeMember !== undefined) {
+                    // callback to the instance, if it returns true assume it's done all the things itself
+                    if (obj.onBeforeDeserializeMember(key, data, context) === true)
+                        continue;
+                }
+                if (serializedEntryInfo === null) {
+                    obj[key] = data;
+                    // if(typeof data === "string"){
+                    //     const serializer = helper.getSerializerForConstructor(String);
+                    //     const res = serializer?.onDeserialize(data, context);
+                    //     if(res !== undefined) obj[key] = res;
+                    // }
+                }
+                else {
+                    if (Array.isArray(serializedEntryInfo)) {
+                        for (let i = 0; i < serializedEntryInfo.length; i++) {
+                            const typeInfoOrConstructor = serializedEntryInfo[i];
+                            const res = tryResolve(typeInfoOrConstructor);
+                            if (res !== undefined || i === serializedEntryInfo.length - 1) {
+                                obj[key] = res;
+                                break;
+                            }
+                        }
+                    }
+                    else {
+                        obj[key] = tryResolve(serializedEntryInfo);
+                    }
+                    buffer.length = 0;
+                }
+                if (obj.onAfterDeserializeMember !== undefined) {
+                    obj.onAfterDeserializeMember(key, data, context);
+                }
+                function tryResolve(typeInfoOrConstructor) {
+                    const typeInformationOrConstructor = typeInfoOrConstructor;
+                    // if the entry does specify an object of type ITypeInformation and has the type field set
+                    const type = typeInformationOrConstructor.type;
+                    if (type) {
+                        return deserializeObjectWithType(data, type, context, undefined, obj[key]);
+                    }
+                    // it can also just contain a constructor
+                    else {
+                        const constructor = typeInfoOrConstructor;
+                        return deserializeObjectWithType(data, constructor, context, undefined, obj[key]);
+                    }
+                }
+            }
+        }
+        // ***
+        // the code below could be used to implictly assign serialized data if they are primitive types
+        // if we decide not to do this we always have to write out all the $serializedTypes
+        // *** 
+        implictlyAssignPrimitiveTypes(obj, serializedData);
+    }
+    checkObjectAssignments(obj, serializedData, context.implementationInformation);
+    if (obj.onAfterDeserialize !== undefined) {
+        obj.onAfterDeserialize(serializedData, context);
+    }
+    return true;
+}
+const blockChecks = getParam("noerrors");
+function checkObjectAssignments(obj, serializedData, implementationInformation) {
+    if (blockChecks)
+        return;
+    if (!serializedData)
+        return;
+    if (!isLocalNetwork())
+        return;
+    if (!obj)
+        return;
+    // ignore builtin components that we dont want to check
+    if (obj.constructor && obj.constructor[$BuiltInTypeFlag] === true)
+        return;
+    const typeName = obj.constructor?.name;
+    // test if any object reference is missing serializable
+    const ownKeys = Object.getOwnPropertyNames(serializedData);
+    for (const key of ownKeys) {
+        if (key === "sourceId")
+            continue;
+        const value = obj[key];
+        if (value == null)
+            continue;
+        const serialized = serializedData[key];
+        // check if the field is defined in the class
+        if (implementationInformation?.getDefinedKey(typeName, key) === false) {
+            // if the field is defined but the defined key is uppercase we need to show a warning
+            // because all fields are serialized in lowercase
+            const firstCharUppercase = key.charAt(0).toUpperCase() + key.slice(1);
+            if (implementationInformation.getDefinedKey(typeName, firstCharUppercase)) {
+                addLog(LogType.Warn, "<strong>Please rename</strong> \"" + firstCharUppercase + "\" to \"" + key + "\" in " + typeName);
+                console.warn("Please use lowercase for field: \"" + firstCharUppercase + "\" in " + typeName, serialized, obj);
+            }
+            continue;
+        }
+        if (serialized === undefined || serialized === null)
+            continue;
+        if (typeof serialized === "object") {
+            if (value === undefined || !value.isObject3D) {
+                if (typeof serialized["node"] === "number" || typeof serialized["guid"] === "string") {
+                    if (serialized["could_not_resolve"]) {
+                        continue;
+                    }
+                    const hasOtherKeys = value !== undefined && Object.keys(value).length > 1;
+                    if (!hasOtherKeys) {
+                        addLog(LogType.Warn, `<strong>Missing serialization for object reference!</strong>\n\nPlease change to: \n@serializable(Object3D)\n${key}? : Object3D;\n\nin ${typeName}.ts\n<a href="https://docs.needle.tools/serializable" target="_blank">See documentation</a>`);
+                        console.warn(typeName, key, obj[key], obj);
+                        continue;
+                    }
+                }
+                else if (!Array.isArray(value)) {
+                    // we can check the constructor name because this is dev only
+                    const valueName = value.constructor?.name;
+                    if (valueName === "Object") {
+                        if (!value.constructor["did_warn:missing_serializable"]) {
+                            value.constructor["did_warn:missing_serializable"] = true;
+                            const warning = "You might be missing a @serializable(Type) decorator for field \"" + key + "\" in " + typeName + ".ts";
+                            console.warn(warning + `\n${key}:`, serialized, valueName);
+                            addLog(LogType.Warn, "Dev Warning: Are you missing a type in @serializable? Please check the browser console for details");
+                        }
+                    }
+                }
+            }
+        }
+        if (typeof value === "string") {
+            if (typeof serialized === "string" && (serialized.endsWith(".gltf") || serialized.endsWith(".glb"))) {
+                addLog(LogType.Warn, `<strong>Missing serialization for object reference!</strong>\n\nPlease change to: \n@serializable(AssetReference)\n${key}? : AssetReference;\n\nin script ${typeName}.ts\n<a href="https://docs.needle.tools/serializable" target="_blank">documentation</a>`);
+                console.warn(typeName, key, obj[key], obj);
+                continue;
+            }
+        }
+    }
+}
+function implictlyAssignPrimitiveTypes(obj, serializedData) {
+    // implictly assign serialized primitive fields
+    for (const key of Object.keys(serializedData)) {
+        const data = serializedData[key];
+        if (typeof data === "object" && data !== null && data !== undefined) {
+            const member = obj[key];
+            if (!member) {
+                if (debug)
+                    console.log(key, "is undefined on", obj);
+                continue;
+            }
+            for (const key of Object.keys(data)) {
+                const targetMember = member[key];
+                // implictly assign number, string, boolean if they are undefined
+                if (targetMember !== undefined)
+                    continue;
+                // resolve serialized primitive types
+                if (isPrimitiveType(data[key]) && !isPrimitiveType(member)) {
+                    const prop = tryFindPropertyDescriptor(member, key);
+                    if (prop && (prop?.writable === undefined || prop?.writable === false) && (prop.set === undefined)) {
+                        if (debug)
+                            console.warn("Property is not writable \"" + key + "\"", member, prop, data[key], member[key]);
+                        continue;
+                    }
+                    // console.log("ASSIGN", key, member, member[key], targetMember, data[key], prop);
+                    member[key] = data[key];
+                }
+            }
+        }
+    }
+}
+function tryFindPropertyDescriptor(obj, key) {
+    while (obj) {
+        const desc = Object.getOwnPropertyDescriptor(obj, key);
+        if (desc)
+            return desc;
+        obj = Object.getPrototypeOf(obj);
+    }
+    return undefined;
+}
+function isPrimitiveType(val) {
+    switch (typeof val) {
+        case "number":
+        case "string":
+        case "boolean":
+            return true;
+    }
+    return false;
+}
+function deserializeObjectWithType(data, typeOrConstructor, context, typeContext, currentValue) {
+    // e.g. @serializable((data) => { })
+    let typeIsFunction = typeof typeOrConstructor === "function" && (typeOrConstructor.prototype === undefined);
+    let type = typeOrConstructor;
+    if (typeIsFunction) {
+        // it's possible to assign a function to serializable to dynamically say which type we expect
+        // e.g. if you have an array of types and you want the array to be resolved with different class instances
+        try {
+            const resolvedType = typeOrConstructor?.call(typeOrConstructor, currentValue);
+            type = resolvedType;
+            typeIsFunction = false;
+            if (type === null || type === undefined)
+                return;
+        }
+        catch (err) {
+            console.error("Error in callback", err, data);
+        }
+    }
+    context.type = type;
+    // e.g. when @serializable(Texture) and the texture is already resolved via json pointer from gltf
+    // then we dont need to do anything else
+    if (!typeIsFunction && currentValue) {
+        if (currentValue instanceof Material)
+            return currentValue;
+        if (currentValue instanceof Mesh)
+            return currentValue;
+        if (currentValue instanceof BufferGeometry)
+            return currentValue;
+        if (currentValue instanceof AnimationClip)
+            return currentValue;
+        // We need to call the RenderTexture deserializer so we can not just return here:
+        // if (currentValue instanceof Texture) return currentValue;
+        // So this has now been moved down below the deserializer code
+    }
+    // Removed this line because it prevents assigning serialized values to existing instances for e.g. EventList
+    // https://linear.app/needle/issue/NE-5350
+    // if (!typeIsFunction && currentValue instanceof type) return currentValue;
+    // try to resolve the serializer for a type only once
+    if (!typeContext) {
+        typeContext = {
+            serializer: helper.getSerializerForConstructor(type)
+        };
+    }
+    // if the value was already resolved via the persistent asset extension dont try to override that again
+    if (currentValue && typeof currentValue === "object" && isPersistentAsset(currentValue)) {
+        // if the persistent asset was already resolved to a concrete instance we dont need to do anything anymore
+        if (currentValue["__concreteInstance"]) {
+            return currentValue["__concreteInstance"];
+        }
+        const serializableInstance = currentValue;
+        if (!serializableInstance.$serializedTypes && type.prototype.$serializedTypes)
+            serializableInstance.$serializedTypes = type.prototype.$serializedTypes;
+        if (serializableInstance.$serializedTypes) {
+            deserializeObject(serializableInstance, data, context);
+        }
+        if (currentValue && type !== undefined) {
+            try {
+                let instance = null;
+                // It's still possible that the type has an explicit serializer
+                // e.g. AnimatorController (or if a user registers a serializer for an arbitrary type and then marks a persistent asset with @serializable)
+                // we have this for @serializable(AnimatorController)
+                if (typeContext.serializer) {
+                    instance = typeContext.serializer.onDeserialize(data, context);
+                }
+                if (!instance) {
+                    // we create a concrete instance for a persistent asset here
+                    // hence we want to have the same instance across all usages of this asset
+                    instance = new type();
+                    if (debugExtension)
+                        console.log("Create concrete instance for persistent asset", currentValue, "instance:", instance);
+                    assign(instance, currentValue);
+                }
+                // save it so if another component references the same persistent asset it will automatically use the concrete instance
+                currentValue["__concreteInstance"] = instance;
+                currentValue = instance;
+            }
+            catch (err) {
+                console.error("Error creating instance or creating values on instance", err, currentValue, type);
+            }
+        }
+        return currentValue;
+    }
+    // if the type is an array resolve each entries recursively
+    if (Array.isArray(data)) {
+        const newArr = [];
+        for (let i = 0; i < data.length; i++) {
+            const obj = data[i];
+            // debugger;
+            const res = deserializeObjectWithType(obj, typeOrConstructor, context, typeContext, obj);
+            newArr.push(res);
+        }
+        // return value;
+        return newArr;
+    }
+    const ser = typeContext?.serializer;
+    if (ser) {
+        return ser.onDeserialize(data, context);
+    }
+    // console.log(type.prototype.get("$serializedTypes"));
+    // We check textures AFTER running deserializers because some textures might need to be converted to a RenderTexture
+    if (currentValue instanceof Texture)
+        return currentValue;
+    let instance = undefined;
+    if (data && (data.isMaterial || data.isTexture || data.isObject3D || data instanceof AnimationClip)) {
+        // if the data is already a threejs object we dont want to create a new instance
+        // e.g. if we have a serialized class with a serializable(Material)
+        instance = data;
+    }
+    else {
+        // happens when exporting e.g. Animation component with only clip assigned (clips array is marked as serialized but it might be undefined if no clips are assigned in e.g. blender)
+        if (data === undefined)
+            return undefined;
+        if (data === null) {
+            // Dont implictly create instances for three types that are not assigned
+            // see: https://github.com/needle-tools/needle-tiny/issues/637
+            if (type === Material || type === Texture || type === Mesh || type === AnimationClip) {
+                return null;
+            }
+        }
+        try {
+            // the fallback - this assumes that the type has a constructor that accepts the serialized arguments
+            // made originally with Vector3 in mind but SHOULD actually not be used/called anymore
+            instance = new type(...setBuffer(data));
+        }
+        catch (err) {
+            console.error("Error creating " + context.path, context.target, err);
+            return;
+        }
+    }
+    // recurse if the deserialized member also implements Iserializable
+    const serializableInstance = instance;
+    if (serializableInstance.$serializedTypes) {
+        deserializeObject(serializableInstance, data, context);
+    }
+    return instance;
+}
+function setBuffer(value) {
+    buffer.length = 0;
+    if (typeof value === "object" && value !== null && value !== undefined) {
+        for (const key of Object.keys(value)) {
+            buffer.push(value[key]);
+        }
+    }
+    return buffer;
+}
+/** set to true while assigning properties during instantiation.
+ * Used for validate decorator to not invoke callbacks on components that are currently in the process of being built */
+export const $isAssigningProperties = Symbol("assigned component properties");
+/** Object.assign behaviour but check if property is writeable (e.g. getter only properties are skipped) */
+export function assign(target, source, info, opts) {
+    if (source === undefined || source === null)
+        return;
+    if (target === undefined || target === null)
+        return;
+    const onlyDeclared = false;
+    // if (onlyDeclared === true && target.constructor) {
+    //     if (target.constructor[ALL_PROPERTIES_MARKER] === true)
+    //         onlyDeclared = false;
+    // }
+    // if (onlyDeclared !== true && target.constructor) {
+    //     if (target.constructor[STRICT_MARKER] === true)
+    //         onlyDeclared = true;
+    // }
+    // if (onlyDeclared === undefined)
+    //     onlyDeclared = true;
+    // if (developmentMode)
+    //     onlyDeclared = false;
+    target[$isAssigningProperties] = true;
+    const typeName = target.constructor?.name ?? "unknown";
+    // register the keys that the actual type has defined
+    // this will be used later when checking if deserialization has assigned all properties
+    // or if anything could not be deserialized to warn the user
+    info?.registerDefinedKeys(typeName, target);
+    for (const key of Object.keys(source)) {
+        const desc = getPropertyDescriptor(target, key);
+        if (onlyDeclared && desc === undefined)
+            continue;
+        if (typeof desc?.value == "function") {
+            // arrow functions are defined as properties on the object
+            continue;
+        }
+        if (!desc || desc.writable === true) {
+            const value = opts?.onAssign ? opts.onAssign(source, key, source[key]) : source[key];
+            target[key] = value;
+        }
+        else if (desc?.set !== undefined) {
+            const value = opts?.onAssign ? opts.onAssign(source, key, source[key]) : source[key];
+            target[key] = value;
+        }
+    }
+    delete target[$isAssigningProperties];
+}
+// we need to recurse because the property might be defined in a base class
+function getPropertyDescriptor(obj, prop) {
+    let desc;
+    do {
+        desc = Object.getOwnPropertyDescriptor(obj, prop);
+    } while (!desc && (obj = Object.getPrototypeOf(obj)));
+    return desc;
+}
 //# sourceMappingURL=engine_serialization_core.js.map