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

package/src/container/Base.mjs

@@ -1,12 +1,13 @@
-import Component  from '../component/Base.mjs';
-import LayoutBase from '../layout/Base.mjs';
-import LayoutCard from '../layout/Card.mjs';
-import LayoutFit  from '../layout/Fit.mjs';
-import LayoutGrid from '../layout/Grid.mjs';
-import LayoutHbox from '../layout/HBox.mjs';
-import LayoutVBox from '../layout/VBox.mjs';
-import Logger     from '../util/Logger.mjs';
-import NeoArray   from '../util/Array.mjs';
+import Component      from '../component/Base.mjs';
+import LayoutBase     from '../layout/Base.mjs';
+import LayoutCard     from '../layout/Card.mjs';
+import LayoutFit      from '../layout/Fit.mjs';
+import LayoutGrid     from '../layout/Grid.mjs';
+import LayoutHbox     from '../layout/HBox.mjs';
+import LayoutVBox     from '../layout/VBox.mjs';
+import Logger         from '../util/Logger.mjs';
+import NeoArray       from '../util/Array.mjs';
+import {isDescriptor} from '../core/ConfigSymbols.mjs';
 
 const byWeight = ({ weight : lhs = 0 }, { weight : rhs = 0 }) => lhs - rhs;
 
@@ -31,9 +32,15 @@ class Container extends Component {
          */
         baseCls: ['neo-container'],
         /**
-         * @member {Object} itemDefaults_=null
+         * Default configuration for child items within this container.
+         * This config uses a descriptor to enable deep merging with instance based itemDefaults.
+         * @member {Object} itemDefaults_={[isDescriptor]: true, merge: 'deep', value: null}
          */
-        itemDefaults_: null,
+        itemDefaults_: {
+            [isDescriptor]: true,
+            merge         : 'deep',
+            value         : null
+        },
         /**
          * An array or an object of config objects|instances|modules for each child component
          * @member {Object[]} items_=[]
@@ -85,7 +92,13 @@ class Container extends Component {
          *     ]
          * });
          */
-        items_: [],
+        items_: {
+            [isDescriptor]: true,
+            clone         : 'shallow',
+            cloneOnGet    : 'none',
+            isEqual       : () => false,
+            value         : []
+        },
         /**
          * It is crucial to define a layout before the container does get rendered.
          * Meaning: onConstructed() is the latest life-cycle point.
@@ -342,10 +355,7 @@ class Container extends Component {
                 }
 
                 item.set(config);
-
-                // In case an item got created outside a stateProvider based hierarchy, there might be bindings or string
-                // based listeners which still need to get resolved.
-                item.getStateProvider()?.parseConfig(item);
+                item.getStateProvider()?.createBindings(item);
                 break
             }
 
@@ -617,14 +627,8 @@ class Container extends Component {
             config = super.mergeConfig(...args),
             ctorItems;
 
-        // avoid any interference on prototype level
-        // does not clone existing Neo instances
-
-        if (config.itemDefaults) {
-            me._itemDefaults = Neo.clone(config.itemDefaults, true, true);
-            delete config.itemDefaults
-        }
-
+        // Avoid any interference on prototype level
+        // Does not clone existing Neo instances
         if (config.items) {
             ctorItems = me.constructor.config.items;
 

package/src/core/Base.mjs

@@ -3,7 +3,8 @@ import Compare                                                  from '../core/Co
 import Util                                                     from '../core/Util.mjs';
 import Config                                                   from './Config.mjs';
 import {isDescriptor}                                           from './ConfigSymbols.mjs';
-import IdGenerator                                              from './IdGenerator.mjs'
+import IdGenerator                                              from './IdGenerator.mjs';
+import EffectBatchManager                                       from './EffectBatchManager.mjs';
 
 const configSymbol       = Symbol.for('configSymbol'),
       forceAssignConfigs = Symbol('forceAssignConfigs'),
@@ -98,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,
         /**
@@ -135,6 +143,12 @@ class Base {
      * @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=[]
@@ -239,7 +253,7 @@ class Base {
         if (oldValue) {
             if (hasManager) {
                 Neo.manager.Instance.unregister(oldValue)
-            } else {
+            } else if (Neo.idMap) {
                 delete Neo.idMap[oldValue]
             }
         }
@@ -249,7 +263,7 @@ class Base {
                 Neo.manager.Instance.register(me);
             } else {
                 Neo.idMap ??= {};
-                Neo.idMap[me.id] = me
+                Neo.idMap[value] = me
             }
         }
     }
@@ -386,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) {
@@ -423,7 +443,7 @@ class Base {
         let me = this;
 
         if (!me.#configs[key] && me.isConfig(key)) {
-            me.#configs[key] = new Config()
+            me.#configs[key] = new Config(me.constructor.configDescriptors?.[key])
         }
 
         return me.#configs[key]
@@ -488,7 +508,7 @@ class Base {
         Object.assign(me[configSymbol], me.mergeConfig(config, preventOriginalConfig));
         delete me[configSymbol].id;
         me.processConfigs();
-        me.isConfiguring = false;
+        me.isConfiguring = false
     }
 
     /**
@@ -524,10 +544,12 @@ class Base {
      * @returns {Boolean}
      */
     isConfig(key) {
-        // A config is considered "reactive" if it has a generated property setter
+        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 Neo.hasPropertySetter(this, key) && (key in this.constructor.config);
+        return me.#configs[key] || (Neo.hasPropertySetter(me, key) && (key in me.constructor.config))
     }
 
     /**
@@ -539,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)
@@ -549,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
     }
 
     /**
@@ -670,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();
     }
 
     /**
@@ -698,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
     }
@@ -748,7 +867,7 @@ class Base {
      * @returns {String}
      */
     get [Symbol.toStringTag]() {
-        return `${this.className} (id: ${this.id})`
+        return this.className
     }
 
     /**

package/src/core/Config.mjs

@@ -1,45 +1,52 @@
+import EffectManager  from './EffectManager.mjs';
 import {isDescriptor} from './ConfigSymbols.mjs';
 
 /**
- * @src/util/ClassSystem.mjs Neo.core.Config
- * @private
- * @internal
- *
  * 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 {
     /**
-     * The internal value of the config property.
+     * A Set to store callback functions that subscribe to changes in this config's value.
      * @private
-     * @apps/portal/view/about/MemberContainer.mjs {any} #value
      */
-    #value;
-
+    #subscribers = {}
     /**
-     * A Set to store callback functions that subscribe to changes in this config's value.
+     * The internal value of the config property.
+     * @member #value
      * @private
-     * @apps/portal/view/about/MemberContainer.mjs {Set<Function>} #subscribers
      */
-    #subscribers = new Set();
+    #value
+    /**
+     * The cloning strategy to use when setting a new value.
+     * Supported values: 'deep', 'shallow', 'none'.
+     * @member {String} clone='deep'
+     */
 
     /**
-     * The strategy to use when merging new values into this config.
-     * Defaults to 'deep'. Can be overridden via a descriptor.
-     * @apps/portal/view/about/MemberContainer.mjs {string} mergeStrategy
+     * The cloning strategy to use when getting a value.
+     * Supported values: 'deep', 'shallow', 'none'.
+     * @member {String} cloneOnGet=null
      */
-    mergeStrategy = 'deep';
 
     /**
      * The function used to compare new and old values for equality.
      * Defaults to `Neo.isEqual`. Can be overridden via a descriptor.
-     * @apps/portal/view/about/MemberContainer.mjs {Function} isEqual
+     * @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'
      */
-    isEqual = Neo.isEqual;
 
     /**
      * Creates an instance of Config.
@@ -58,24 +65,49 @@ class Config {
      * @returns {any} The current value.
      */
     get() {
-        return this.#value;
+        // 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 `mergeStrategy` and `isEqual` from the descriptor.
+     * 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.merge='deep'] - The merge strategy.
+     * @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({isEqual, merge, value}) {
+    initDescriptor({clone, cloneOnGet, isEqual, merge}) {
         let me = this;
 
-        me.#value        = value
-        me.mergeStrategy = merge   || me.mergeStrategy;
-        me.isEqual       = isEqual || me.isEqual;
+        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
+            })
+        }
     }
 
     /**
@@ -84,8 +116,13 @@ class Config {
      * @param {any} oldValue - The old value of the config.
      */
     notify(newValue, oldValue) {
-        for (const callback of this.#subscribers) {
-            callback(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)
+                }
+            }
         }
     }
 
@@ -127,13 +164,67 @@ class Config {
     /**
      * Subscribes a callback function to changes in this config's value.
      * The callback will be invoked with `(newValue, oldValue)` whenever the config changes.
-     * @param {Function} callback - The function to call when the config value 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(callback) {
-        this.#subscribers.add(callback);
-        return () => this.#subscribers.delete(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;