neo.mjs 10.0.0-beta.3 → 10.0.0-beta.5

package/src/core/Base.mjs

@@ -1,5 +1,10 @@
 import {buffer, debounce, intercept, resolveCallback, throttle} from '../util/Function.mjs';
-import IdGenerator                                              from './IdGenerator.mjs'
+import Compare                                                  from '../core/Compare.mjs';
+import Util                                                     from '../core/Util.mjs';
+import Config                                                   from './Config.mjs';
+import {isDescriptor}                                           from './ConfigSymbols.mjs';
+import IdGenerator                                              from './IdGenerator.mjs';
+import EffectBatchManager                                       from './EffectBatchManager.mjs';
 
 const configSymbol       = Symbol.for('configSymbol'),
       forceAssignConfigs = Symbol('forceAssignConfigs'),
@@ -94,12 +99,19 @@ class Base {
          * @protected
          */
         isConstructed: false,
+        /**
+         * This config will be set to `true` as the very first action within the `destroy()` method.
+         * Effects can observe this config to clean themselves up.
+         * @member {Boolean} isDestroying_=false
+         * @protected
+         */
+        isDestroying_: false,
         /**
          * The config will get set to `true` once the Promise of `async initAsync()` is resolved.
          * You can use `afterSetIsReady()` to get notified once the ready state is reached.
          * Since not all classes use the Observable mixin, Neo will not fire an event.
          * method body.
-         * @member {Boolean} isReady=false
+         * @member {Boolean} isReady_=false
          */
         isReady_: false,
         /**
@@ -125,6 +137,18 @@ class Base {
         remote_: null
     }
 
+    /**
+     * A private field to store the Config controller instances.
+     * @member {Object} #configs={}
+     * @private
+     */
+    #configs = {};
+    /**
+     * Internal cache for all config subscription cleanup functions.
+     * @member {Function[]} #configSubscriptionCleanups=[]
+     * @private
+     */
+    #configSubscriptionCleanups = []
     /**
      * Internal cache for all timeout ids when using this.timeout()
      * @member {Number[]} timeoutIds=[]
@@ -133,8 +157,39 @@ class Base {
     #timeoutIds = []
 
     /**
-     * Applies the observable mixin if needed, grants remote access if needed.
-     * @param {Object} config={}
+     * The main initializer for all Neo.mjs classes, invoked by `Neo.create()`.
+     * NOTE: This is not the native `constructor()`, which is called without arguments by `Neo.create()` first.
+     *
+     * This method orchestrates the entire instance initialization process, including
+     * the setup of the powerful and flexible config system.
+     *
+     * The `config` parameter is a single object that can contain different types of properties,
+     * which are processed in a specific order to ensure consistency and predictability:
+     *
+     * 1.  **Public Class Fields & Other Properties:** Any key in the `config` object that is NOT
+     *     defined in the class's `static config` hierarchy is considered a public field or a
+     *     dynamic property. These are assigned directly to the instance (`this.myField = value`)
+     *     at the very beginning. This is crucial so that subsequent config hooks (like `afterSet*`)
+     *     can access their latest values.
+     *
+     * 2.  **Reactive Configs:** A property is considered reactive if it is defined with a trailing
+     *     underscore (e.g., `myValue_`) in the `static config` of **any class in the inheritance
+     *     chain**. Subclasses can provide new default values for these configs without the
+     *     underscore, and they will still be reactive. Their values are applied via generated
+     *     setters, triggering `beforeSet*` and `afterSet*` hooks, and they are wrapped in a
+     *     `Neo.core.Config` instance to enable subscription-based reactivity.
+     *
+     * 3.  **Non-Reactive Configs:** Properties defined in `static config` without a trailing
+     *     underscore in their entire inheritance chain. Their default values are applied directly
+     *     to the class **prototype**, making them shared across all instances and allowing for
+     *     run-time modifications (prototypal inheritance). When a new value is passed to this
+     *     method, it creates an instance-specific property that shadows the prototype value.
+     *
+     * This method also initializes the observable mixin (if applicable) and schedules asynchronous
+     * logic like `initAsync()` (which handles remote method access) to run after the synchronous
+     * construction chain is complete.
+     *
+     * @param {Object} config={} The initial configuration object for the instance.
      */
     construct(config={}) {
         let me = this;
@@ -152,13 +207,9 @@ class Base {
             }
         });
 
-        me.createId(config.id || me.id);
+        me.id = config.id || IdGenerator.getId(this.getIdKey());
         delete config.id;
 
-        if (me.constructor.config) {
-            delete me.constructor.config.id
-        }
-
         me.getStaticConfig('observable') && me.initObservable(config);
 
         // assign class field values prior to configs
@@ -202,7 +253,7 @@ class Base {
         if (oldValue) {
             if (hasManager) {
                 Neo.manager.Instance.unregister(oldValue)
-            } else {
+            } else if (Neo.idMap) {
                 delete Neo.idMap[oldValue]
             }
         }
@@ -212,7 +263,7 @@ class Base {
                 Neo.manager.Instance.register(me);
             } else {
                 Neo.idMap ??= {};
-                Neo.idMap[me.id] = me
+                Neo.idMap[value] = me
             }
         }
     }
@@ -342,16 +393,6 @@ class Base {
         this.__proto__.constructor.overwrittenMethods[methodName].call(this, ...args)
     }
 
-    /**
-     * Uses the IdGenerator to create an id if a static one is not explicitly set.
-     * Registers the instance to manager.Instance if this one is already created,
-     * otherwise stores it inside a tmp map.
-     * @param {String} id
-     */
-    createId(id) {
-        this.id = id || IdGenerator.getId(this.getIdKey())
-    }
-
     /**
      * Unregisters this instance from Neo.manager.Instance
      * and removes all object entries from this instance
@@ -359,10 +400,16 @@ class Base {
     destroy() {
         let me = this;
 
+        me.isDestroying = true;
+
         me.#timeoutIds.forEach(id => {
             clearTimeout(id)
         });
 
+        me.#configSubscriptionCleanups.forEach(cleanup => {
+            cleanup()
+        });
+
         if (Base.instanceManagerAvailable === true) {
             Neo.manager.Instance.unregister(me)
         } else if (Neo.idMap) {
@@ -386,6 +433,22 @@ class Base {
         me.isDestroyed = true
     }
 
+    /**
+     * A public method to access the underlying Config controller.
+     * This enables advanced interactions like subscriptions.
+     * @param {String} key The name of the config property (e.g., 'items').
+     * @returns {Config|undefined} The Config instance, or undefined if not found.
+     */
+    getConfig(key) {
+        let me = this;
+
+        if (!me.#configs[key] && me.isConfig(key)) {
+            me.#configs[key] = new Config(me.constructor.configDescriptors?.[key])
+        }
+
+        return me.#configs[key]
+    }
+
     /**
      * Used inside createId() as the default value passed to the IdGenerator.
      * Override this method as needed.
@@ -443,8 +506,9 @@ class Base {
 
         me.isConfiguring = true;
         Object.assign(me[configSymbol], me.mergeConfig(config, preventOriginalConfig));
+        delete me[configSymbol].id;
         me.processConfigs();
-        me.isConfiguring = false;
+        me.isConfiguring = false
     }
 
     /**
@@ -475,6 +539,19 @@ class Base {
         return !this.isDestroyed
     }
 
+    /**
+     * @param {String} key
+     * @returns {Boolean}
+     */
+    isConfig(key) {
+        let me = this;
+        // If a `core.Config` controller is already created, return true (fastest possible check).
+        // If not, a config is considered "reactive" if it has a generated property setter
+        // AND it is present as a defined config in the merged static config hierarchy.
+        // Neo.setupClass() removes the underscore from the static config keys.
+        return me.#configs[key] || (Neo.hasPropertySetter(me, key) && (key in me.constructor.config))
+    }
+
     /**
      * Override this method to change the order configs are applied to this instance.
      * @param {Object} config
@@ -484,7 +561,8 @@ class Base {
      */
     mergeConfig(config, preventOriginalConfig) {
         let me   = this,
-            ctor = me.constructor;
+            ctor = me.constructor,
+            configDescriptors, staticConfig;
 
         if (!ctor.config) {
             throw new Error('Neo.applyClassConfig has not been run on ' + me.className)
@@ -494,7 +572,70 @@ class Base {
             me.originalConfig = Neo.clone(config, true, true)
         }
 
-        return {...ctor.config, ...config}
+        configDescriptors = ctor.configDescriptors;
+        staticConfig      = ctor.config;
+
+        if (configDescriptors) {
+            Object.entries(config).forEach(([key, instanceValue]) => {
+                const descriptor = configDescriptors[key];
+
+                if (descriptor?.merge) {
+                    config[key] = Neo.mergeConfig(staticConfig[key], instanceValue, descriptor.merge)
+                }
+            })
+        }
+
+        return {...staticConfig, ...config}
+    }
+
+    /**
+     * Subscribes *this* instance (the subscriber) to changes of a specific config property on another instance (the publisher).
+     * Ensures automatic cleanup when *this* instance (the subscriber) is destroyed.
+     *
+     * @param {String|Neo.core.Base} publisher  - The ID of the publisher instance or the instance reference itself.
+     * @param {String}               configName - The name of the config property on the publisher to subscribe to (e.g., 'myConfig').
+     * @param {Function}             fn         - The callback function to execute when the config changes.
+     * @returns {Function} A cleanup function to manually unsubscribe if needed before this instance's destruction.
+     *
+     * @example
+     * // Subscribing to a config on another instance
+     * this.observeConfig(someOtherInstance, 'myConfig', (newValue, oldValue) => {
+     *     console.log('myConfig changed:', newValue);
+     * });
+     *
+     * // Discouraged: Self-observation. Use afterSet<ConfigName>() hooks instead.
+     * this.observeConfig(this, 'myOwnConfig', (newValue, oldValue) => {
+     *     console.log('myOwnConfig changed:', newValue);
+     * });
+     */
+    observeConfig(publisher, configName, fn) {
+        let publisherInstance = publisher;
+
+        if (Neo.isString(publisher)) {
+            publisherInstance = Neo.get(publisher);
+            if (!publisherInstance) {
+                console.warn(`Publisher instance with ID '${publisher}' not found. Cannot subscribe.`);
+                return Neo.emptyFn
+            }
+        }
+
+        if (!(publisherInstance instanceof Neo.core.Base)) {
+            console.warn(`Invalid publisher provided. Must be a Neo.core.Base instance or its ID.`);
+            return Neo.emptyFn
+        }
+
+        const configController = publisherInstance.getConfig(configName);
+
+        if (!configController) {
+            console.warn(`Config '${configName}' not found on publisher instance ${publisherInstance.id}. Cannot subscribe.`);
+            return Neo.emptyFn
+        }
+
+        const cleanup = configController.subscribe({id: this.id, fn});
+
+        this.#configSubscriptionCleanups.push(cleanup);
+
+        return cleanup
     }
 
     /**
@@ -615,24 +756,58 @@ class Base {
     }
 
     /**
-     * Change multiple configs at once, ensuring that all afterSet methods get all new assigned values
+     * set() accepts the following input as keys:
+     * 1. Non-reactive configs
+     * 2. Reactive configs
+     * 3. Class fields defined via value
+     * 4. Class fields defined via get() & set()
+     * 5. "Anything else" will get directly get assigned to the instance
+     *
+     * The logic resolves circular dependencies as good as possible and ensures that config related hooks:
+     * - beforeGet<Config>
+     * - beforeSet<Config>
+     * - afterSet<Config>
+     * can access all new values from the batch operation.
      * @param {Object} values={}
      */
     set(values={}) {
-        let me = this;
+        let me                = this,
+            classFieldsViaSet = {};
+
+        // Start batching for effects
+        EffectBatchManager.startBatch();
 
         values = me.setFields(values);
 
         // If the initial config processing is still running,
         // finish this one first before dropping new values into the configSymbol.
-        // see: https://github.com/neomjs/neo/issues/2201
+        // See: https://github.com/neomjs/neo/issues/2201
         if (me[forceAssignConfigs] !== true && Object.keys(me[configSymbol]).length > 0) {
             me.processConfigs()
         }
 
+        // Store class fields which are defined via get() & set() and ensure they won't get added to the config symbol.
+        Object.entries(values).forEach(([key, value]) => {
+            if (!me.isConfig(key)) {
+                classFieldsViaSet[key] = value;
+                delete values[key]
+            }
+        })
+
+        // Add reactive configs to the configSymbol
         Object.assign(me[configSymbol], values);
 
-        me.processConfigs(true)
+        // Process class fields which are defined via get() & set() => now they can access the latest values
+        // for reactive and non-reactive configs, as well as class fields defined with values.
+        Object.entries(classFieldsViaSet).forEach(([key, value]) => {
+            me[key] = value
+        })
+
+        // Process reactive configs
+        me.processConfigs(true);
+
+        // End batching for effects
+        EffectBatchManager.endBatch();
     }
 
     /**
@@ -643,15 +818,14 @@ class Base {
      * @protected
      */
     setFields(config) {
-        let me          = this,
-            configNames = me.constructor.config;
+        let me = this;
 
         Object.entries(config).forEach(([key, value]) => {
-            if (!configNames.hasOwnProperty(key) && !Neo.hasPropertySetter(me, key)) {
+            if (!me.isConfig(key) && !Neo.hasPropertySetter(me, key)) {
                 me[key] = value;
                 delete config[key]
             }
-        })
+        });
 
         return config
     }
@@ -693,7 +867,7 @@ class Base {
      * @returns {String}
      */
     get [Symbol.toStringTag]() {
-        return `${this.className} (id: ${this.id})`
+        return this.className
     }
 
     /**

package/src/core/Compare.mjs

@@ -1,18 +1,7 @@
-import Base from '../core/Base.mjs';
-
 /**
  * @class Neo.core.Compare
- * @extends Neo.core.Base
  */
-class Compare extends Base {
-    static config = {
-        /**
-         * @member {String} className='Neo.core.Compare'
-         * @protected
-         */
-        className: 'Neo.core.Compare'
-    }
-
+class Compare {
     /**
      * Storing the comparison method names by data type
      * @member {Object} map
@@ -174,7 +163,8 @@ class Compare extends Base {
     }
 }
 
-Compare = Neo.setupClass(Compare);
+const ns = Neo.ns('Neo.core', true);
+ns.Compare = Compare;
 
 // alias
 Neo.isEqual = Compare.isEqual;

package/src/core/Config.mjs

@@ -0,0 +1,230 @@
+import EffectManager  from './EffectManager.mjs';
+import {isDescriptor} from './ConfigSymbols.mjs';
+
+/**
+ * Represents an observable container for a config property.
+ * This class manages the value of a config, its subscribers, and custom behaviors
+ * like merge strategies and equality checks defined via a descriptor object.
+ *
+ * The primary purpose of this class is to enable fine-grained reactivity and
+ * decoupled cross-instance state sharing within the Neo.mjs framework.
+ * @class Neo.core.Config
+ * @private
+ * @internal
+ */
+class Config {
+    /**
+     * A Set to store callback functions that subscribe to changes in this config's value.
+     * @private
+     */
+    #subscribers = {}
+    /**
+     * The internal value of the config property.
+     * @member #value
+     * @private
+     */
+    #value
+    /**
+     * The cloning strategy to use when setting a new value.
+     * Supported values: 'deep', 'shallow', 'none'.
+     * @member {String} clone='deep'
+     */
+
+    /**
+     * The cloning strategy to use when getting a value.
+     * Supported values: 'deep', 'shallow', 'none'.
+     * @member {String} cloneOnGet=null
+     */
+
+    /**
+     * The function used to compare new and old values for equality.
+     * Defaults to `Neo.isEqual`. Can be overridden via a descriptor.
+     * @member {Function} isEqual=Neo.isEqual
+     */
+
+    /**
+     * The strategy to use when merging new values into this config.
+     * Defaults to 'replace'. Can be overridden via a descriptor merge property.
+     * @member {Function|String} mergeStrategy='replace'
+     */
+
+    /**
+     * Creates an instance of Config.
+     * @param {any|Object} configObject - The initial value for the config.
+     */
+    constructor(configObject) {
+        if (Neo.isObject(configObject) && configObject[isDescriptor] === true) {
+            this.initDescriptor(configObject)
+        } else {
+            this.#value = configObject
+        }
+    }
+
+    /**
+     * Gets the current value of the config property.
+     * @returns {any} The current value.
+     */
+    get() {
+        // Registers this Config instance as a dependency with the currently active Effect,
+        // enabling automatic re-execution when this Config's value changes.
+        EffectManager.getActiveEffect()?.addDependency(this);
+        return this.#value
+    }
+
+    /**
+     * Initializes the `Config` instance using a descriptor object.
+     * Extracts `clone`, `mergeStrategy` and `isEqual` from the descriptor.
+     * The internal `#value` is NOT set by this method.
+     * @param {Object}   descriptor                       - The descriptor object for the config.
+     * @param {any}      descriptor.value                 - The default value for the config (not set by this method).
+     * @param {string}   [descriptor.clone='deep']        - The clone strategy for set.
+     * @param {string}   [descriptor.cloneOnGet]          - The clone strategy for get. Defaults to 'shallow' if clone is 'deep' or 'shallow', and 'none' if clone is 'none'.
+     * @param {string}   [descriptor.merge='deep']        - The merge strategy.
+     * @param {Function} [descriptor.isEqual=Neo.isEqual] - The equality comparison function.
+     */
+    initDescriptor({clone, cloneOnGet, isEqual, merge}) {
+        let me = this;
+
+        if (clone && clone !== me.clone) {
+            Object.defineProperty(me, 'clone', {
+                value: clone, writable: true, configurable: true, enumerable: true
+            })
+        }
+
+        if (cloneOnGet && cloneOnGet !== me.cloneOnGet) {
+            Object.defineProperty(me, 'cloneOnGet', {
+                value: cloneOnGet, writable: true, configurable: true, enumerable: true
+            })
+        }
+
+        if (isEqual && isEqual !== me.isEqual) {
+            Object.defineProperty(me, 'isEqual', {
+                value: isEqual, writable: true, configurable: true, enumerable: true
+            })
+        }
+
+        if (merge && merge !== me.mergeStrategy) {
+            Object.defineProperty(me, 'mergeStrategy', {
+                value: merge, writable: true, configurable: true, enumerable: true
+            })
+        }
+    }
+
+    /**
+     * Notifies all subscribed callbacks about a change in the config's value.
+     * @param {any} newValue - The new value of the config.
+     * @param {any} oldValue - The old value of the config.
+     */
+    notify(newValue, oldValue) {
+        for (const id in this.#subscribers) {
+            if (this.#subscribers.hasOwnProperty(id)) {
+                const subscriberSet = this.#subscribers[id];
+                for (const callback of subscriberSet) {
+                    callback(newValue, oldValue)
+                }
+            }
+        }
+    }
+
+    /**
+     * Sets a new value for the config property.
+     * This method performs an equality check using `this.isEqual` before updating the value.
+     * If the value has changed, it updates `#value` and notifies all subscribers.
+     * @param {any} newValue - The new value to set.
+     * @returns {Boolean} True if the value changed, false otherwise.
+     */
+    set(newValue) {
+        if (newValue === undefined) return false; // Preserve original behavior for undefined
+
+        const
+            me       = this,
+            oldValue = me.#value;
+
+        // The setter automatically uses the configured equality check
+        if (!me.isEqual(newValue, oldValue)) {
+            me.#value = newValue;
+            me.notify(newValue, oldValue);
+            return true
+        }
+
+        return false
+    }
+
+    /**
+     * Sets the internal value of the config property directly, without performing
+     * an equality check or notifying subscribers.
+     * This method is intended for internal framework use where direct assignment
+     * is necessary (e.g., during initial setup or specific internal optimizations).
+     * @param {any} newValue - The new value to set directly.
+     */
+    setRaw(newValue) {
+        this.#value = newValue
+    }
+
+    /**
+     * Subscribes a callback function to changes in this config's value.
+     * The callback will be invoked with `(newValue, oldValue)` whenever the config changes.
+     * @param {Object} options      - An object containing the subscription details.
+     * @param {String} options.id   - The ID of the subscription owner (e.g., a Neo.core.Base instance's id).
+     * @param {Function} options.fn - The callback function.
+     * @returns {Function} A cleanup function to unsubscribe the callback.
+     */
+    subscribe({id, fn}) {
+        if (typeof id !== 'string' || id.length === 0 || typeof fn !== 'function') {
+            throw new Error([
+                'Config.subscribe: options must be an object with a non-empty string `id` ',
+                '(the subscription owner\'s id), and a callback function `fn`.'
+            ].join(''))
+        }
+
+        const me = this;
+
+        if (!me.#subscribers[id]) {
+            me.#subscribers[id] = new Set()
+        }
+
+        me.#subscribers[id].add(fn);
+
+        return () => {
+            const subscriberSet = me.#subscribers[id];
+            if (subscriberSet) {
+                subscriberSet.delete(fn);
+                if (subscriberSet.size === 0) {
+                    delete me.#subscribers[id]
+                }
+            }
+        }
+    }
+}
+
+Object.defineProperties(Config.prototype, {
+    clone: {
+        value: 'deep',
+        writable: false,
+        configurable: true,
+        enumerable: false
+    },
+    cloneOnGet: {
+        value: null,
+        writable: false,
+        configurable: true,
+        enumerable: false
+    },
+    isEqual: {
+        value: Neo.isEqual,
+        writable: false,
+        configurable: true,
+        enumerable: false
+    },
+    mergeStrategy: {
+        value: 'replace',
+        writable: false,
+        configurable: true,
+        enumerable: false
+    }
+});
+
+const ns = Neo.ns('Neo.core', true);
+ns.Config = Config;
+
+export default Config;

package/src/core/ConfigSymbols.mjs

@@ -0,0 +1,3 @@
+
+// e.g., in a new file src/core/ConfigSymbols.mjs
+export const isDescriptor = Symbol.for('Neo.Config.isDescriptor');