neo.mjs 10.0.0-beta.5 → 10.0.0

package/src/component/mwc/Button.mjs

@@ -20,32 +20,39 @@ class Button extends Component {
         ntype: 'mwc-button',
         /**
          * @member {Boolean} dense_=false
+         * @reactive
          */
         dense_: false,
         /**
          * Shortcut for domListeners={click:handler}
          * A string based value assumes that the handlerFn lives inside a ComponentController
          * @member {Function|String|null} handler_=null
+         * @reactive
          */
         handler_: null,
         /**
          * @member {String} icon_=''
+         * @reactive
          */
         icon_: '',
         /**
          * @member {String} label_=''
+         * @reactive
          */
         label_: '',
         /**
          * @member {Boolean} outlined_=false
+         * @reactive
          */
         outlined_: false,
         /**
          * @member {Boolean} raised_=false
+         * @reactive
          */
         raised_: false,
         /**
          * @member {Boolean} unelevated_=false
+         * @reactive
          */
         unelevated_: false,
         /**

package/src/component/mwc/TextField.mjs

@@ -21,38 +21,47 @@ class TextField extends Component {
         /**
          * Displays a helper text below the field
          * @member {String} helper_=''
+         * @reactive
          */
         helper_: '',
         /**
          * @member {String} icon_=''
+         * @reactive
          */
         icon_: '',
         /**
          * @member {String} iconTrailing_=''
+         * @reactive
          */
         iconTrailing_: '',
         /**
          * @member {String} label_=''
+         * @reactive
          */
         label_: '',
         /**
          * @member {String} name_=''
+         * @reactive
          */
         name_: '',
         /**
          * @member {Boolean} outlined_=false
+         * @reactive
          */
         outlined_: false,
         /**
          * @member {String} placeholder_=''
+         * @reactive
          */
         placeholder_: '',
         /**
          * @member {Boolean} required_=false
+         * @reactive
          */
         required_: false,
         /**
          * @member {String} value_=''
+         * @reactive
          */
         value_: '',
         /**

package/src/component/wrapper/AmChart.mjs

@@ -21,11 +21,13 @@ class AmChart extends Component {
         /**
          * See: https://www.amcharts.com/docs/v4/
          * @member {Object} chartConfig_=null
+         * @reactive
          */
         chartConfig_: null,
         /**
          * Stores the chart data
          * @member {Array|null} chartData_=null
+         * @reactive
          */
         chartData_: null,
         /**

package/src/component/wrapper/GoogleMaps.mjs

@@ -21,12 +21,14 @@ class GoogleMaps extends Base {
         /**
          * Specify lat & lng for the current focus position
          * @member {Object} center_={lat: -34.397, lng: 150.644}
+         * @reactive
          */
         center_: {lat: -34.397, lng: 150.644},
         /**
          * Prefer to use markerStoreConfig instead.
          * @member {Neo.data.Store|Object} markerStore_
          * @protected
+         * @reactive
          */
         markerStore_: {
             model: {
@@ -52,6 +54,7 @@ class GoogleMaps extends Base {
         },
         /**
          * @member {Number} zoom_=8
+         * @reactive
          */
         zoom_: 8
     }

package/src/component/wrapper/MapboxGL.mjs

@@ -25,10 +25,12 @@ class MapboxGL extends Component {
         accessToken: null,
         /**
          * @member {Array|null} chartData_=null
+         * @reactive
          */
         chartData_: null,
         /**
          * @member {Object} center_={lat: 0, lng: 0}
+         * @reactive
          */
         center_: {lat: 0, lng: 0},
         /**
@@ -47,6 +49,7 @@ class MapboxGL extends Component {
          * beforeId is a custom property which will get passed as the second param for:
          * https://docs.mapbox.com/mapbox-gl-js/api/#map#addlayer
          * @member {Object[]|null} layers_=null
+         * @reactive
          */
         layers_: null,
         /**
@@ -59,6 +62,7 @@ class MapboxGL extends Component {
          * id is a custom property which will get passed as the first param for:
          * https://docs.mapbox.com/mapbox-gl-js/api/#map#addsource
          * @member {Object[]|null} sources_=null
+         * @reactive
          */
         sources_: null,
         /**
@@ -73,6 +77,7 @@ class MapboxGL extends Component {
         /**
          *
          * @member {Number} zoom_=3
+         * @reactive
          */
         zoom_: 3
     }

package/src/component/wrapper/MonacoEditor.mjs

@@ -47,34 +47,41 @@ class MonacoEditor extends Base {
         baseCls: ['neo-monaco-editor'],
         /**
          * @member {Boolean} contextmenu_=false
+         * @reactive
          */
         contextmenu_: false,
         /**
          * Options are: 'blink', 'expand', 'phase', 'smooth', 'solid'
          * @member {String} cursorBlinking_='blink'
+         * @reactive
          */
         cursorBlinking_: 'blink',
         /**
          * additional property to only use in combination with readOnly === true.
          * domReadOnly additionally sets the readonly attribute to the underlying textarea.
          * @member {Boolean} domReadOnly_=false
+         * @reactive
          */
         domReadOnly_: false,
         /**
          * Options are: 'vs', 'vs-dark', 'hc-black', 'hc-light'
          * @member {String} editorTheme_='vs'
+         * @reactive
          */
         editorTheme_: 'vs',
         /**
          * @member {Number} fontSize_=14
+         * @reactive
          */
         fontSize_: 14,
         /**
          * @member {String} language_='javascript'
+         * @reactive
          */
         language_: 'javascript',
         /**
          * @member {Object} minimap_={enabled: false}
+         * @reactive
          */
         minimap_: {enabled: false},
         /**
@@ -85,22 +92,27 @@ class MonacoEditor extends Base {
          * For initial options this config will win over related class configs.
          * However, run-time changes of related class configs will dynamically change their option values.
          * @member {Object} options_={}
+         * @reactive
          */
         options_: {},
         /**
          * @member {Boolean} readOnly_=false
+         * @reactive
          */
         readOnly_: false,
         /**
          * @member {Boolean} scrollBeyondLastLine_=false
+         * @reactive
          */
         scrollBeyondLastLine_: false,
         /**
          * @member {Boolean} showLineNumbers_=true
+         * @reactive
          */
         showLineNumbers_: true,
         /**
          * @member {String|String[]} value_=''
+         * @reactive
          */
         value_: ''
     }

package/src/container/Accordion.mjs

@@ -29,10 +29,12 @@ class Accordion extends Panel {
         initialOpen_: [],
         /**
          * @member {Object} itemDefaults={ntype:'accordionitem'}
+         * @reactive
          */
         itemDefaults: {ntype: 'accordionitem'},
         /**
          * @member {Object[]} items=[]
+         * @reactive
          */
         items: [],
         /**

package/src/container/Base.mjs

@@ -35,6 +35,7 @@ class Container extends Component {
          * 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}
+         * @reactive
          */
         itemDefaults_: {
             [isDescriptor]: true,
@@ -91,6 +92,7 @@ class Container extends Component {
          *         MyRedButton            // you can drop imported modules directly into the items array
          *     ]
          * });
+         * @reactive
          */
         items_: {
             [isDescriptor]: true,
@@ -104,6 +106,7 @@ class Container extends Component {
          * Meaning: onConstructed() is the latest life-cycle point.
          * You can use layout: 'base', in case you do not need a layout at all.
          * @member {Object|String|null} layout_={ntype: 'vbox', align: 'stretch'}
+         * @reactive
          */
         layout_: {
             ntype: 'vbox',
@@ -349,13 +352,14 @@ class Container extends Component {
 
                     // Convenience logic, especially for moving components into different browser windows:
                     // A component might rely on references & handler methods inside the previous controller realm
-                    if (!item.controller && !me.getController() && parent.getController()) {
+                    // todo: We need ?. until functional.component.Base supports controllers
+                    if (!item.controller && !me.getController() && parent.getController?.()) {
                         item.controller = {parent: parent.getController()}
                     }
                 }
 
                 item.set(config);
-                item.getStateProvider()?.createBindings(item);
+                item.getStateProvider?.()?.createBindings(item);
                 break
             }
 
@@ -437,7 +441,7 @@ class Container extends Component {
 
         // We need to add items into the vdom
         me.updateDepth = -1;
-        me.update();
+        me.isConstructed && me.update();
 
         me.fire('itemsCreated', {id: me.id, items})
     }

package/src/container/Panel.mjs

@@ -36,6 +36,7 @@ class Panel extends Container {
         headers: null,
         /**
          * @member {Object} items={ntype: 'vbox', align: 'stretch'}
+         * @reactive
          */
         _layout: {
             ntype: 'vbox',

package/src/container/Viewport.mjs

@@ -35,6 +35,7 @@ class Viewport extends Container {
          * true applies a main.addon.ResizeObserver and fires a custom resize event
          * which other instances can subscribe to.
          * @member {Boolean} monitorSize_=false
+         * @reactive
          */
         monitorSize_: false
     }

package/src/controller/Application.mjs

@@ -30,6 +30,7 @@ class Application extends Base {
         appThemeFolder: null,
         /**
          * @member {Neo.component.Base} mainView_=null
+         * @reactive
          */
         mainView_: null,
         /**

package/src/controller/Base.mjs

@@ -55,6 +55,7 @@ class Controller extends Base {
          *     'default'                       : 'handleOtherRoutes'
          * }
          * @member {Object} routes_={}
+         * @reactive
          */
         routes_: {}
     }

package/src/controller/Component.mjs

@@ -24,6 +24,7 @@ class Component extends Base {
         component: null,
         /**
          * @member {Neo.controller.Component|null} parent_=null
+         * @reactive
          */
         parent_: null,
         /**

package/src/core/Base.mjs

@@ -4,7 +4,8 @@ import Util                                                     from '../core/Ut
 import Config                                                   from './Config.mjs';
 import {isDescriptor}                                           from './ConfigSymbols.mjs';
 import IdGenerator                                              from './IdGenerator.mjs';
-import EffectBatchManager                                       from './EffectBatchManager.mjs';
+import EffectManager                                            from './EffectManager.mjs';
+
 
 const configSymbol       = Symbol.for('configSymbol'),
       forceAssignConfigs = Symbol('forceAssignConfigs'),
@@ -58,7 +59,26 @@ class Base {
      */
     static overwrittenMethods = {}
     /**
-     * Configs will get merged throughout the class hierarchy
+     * Defines the default configuration properties for the class. These configurations are
+     * merged throughout the class hierarchy and can be overridden at the instance level.
+     *
+     * There are two main types of configs:
+     *
+     * 1.  **Reactive Configs:** Property names ending with a trailing underscore (e.g., `myConfig_`).
+     *     The framework automatically generates a public getter and setter, removing the underscore
+     *     from the property name (e.g., `this.myConfig`). This system enables powerful, optional
+     *     lifecycle hooks that are called automatically if they are implemented on the class:
+     *     - `beforeGetMyConfig(value)`: Executed before the getter returns. Can be used to dynamically modify the returned value.
+     *     - `beforeSetMyConfig(newValue, oldValue)`: Executed before a new value is set. Can be used for validation or transformation. Returning `undefined` from this hook will cancel the update.
+     *     - `afterSetMyConfig(newValue, oldValue)`: Executed after a new value has been successfully set. Ideal for triggering side effects.
+     *
+     * 2.  **Non-Reactive (Prototype-based) Configs:** Property names without a trailing underscore.
+     *     These are applied directly to the class's **prototype** during the `Neo.setupClass`
+     *     process. This is highly memory-efficient as the value is shared across all instances.
+     *     It also allows for powerful, application-wide modifications of default behaviors
+     *     by using the `Neo.overwrites` mechanism, which modifies these prototype values at
+     *     load time.
+     *
      * @returns {Object} config
      */
     static config = {
@@ -83,6 +103,7 @@ class Base {
         /**
          * The unique component id
          * @member {String|null} id_=null
+         * @reactive
          */
         id_: null,
         /**
@@ -104,6 +125,7 @@ class Base {
          * Effects can observe this config to clean themselves up.
          * @member {Boolean} isDestroying_=false
          * @protected
+         * @reactive
          */
         isDestroying_: false,
         /**
@@ -112,6 +134,7 @@ class Base {
          * Since not all classes use the Observable mixin, Neo will not fire an event.
          * method body.
          * @member {Boolean} isReady_=false
+         * @reactive
          */
         isReady_: false,
         /**
@@ -133,6 +156,7 @@ class Base {
          *
          * @member {Object|null} remote_=null
          * @protected
+         * @reactive
          */
         remote_: null
     }
@@ -210,8 +234,6 @@ class Base {
         me.id = config.id || IdGenerator.getId(this.getIdKey());
         delete config.id;
 
-        me.getStaticConfig('observable') && me.initObservable(config);
-
         // assign class field values prior to configs
         config = me.setFields(config);
 
@@ -290,9 +312,38 @@ class Base {
     }
 
     /**
-     * Applying overwrites and adding overwrittenMethods to the class constructors
-     * @param {Object} cfg
+     * This static method is called by `Neo.setupClass()` during the class creation process.
+     * It allows for modifying a class's default prototype-based configs from outside the
+     * class hierarchy, which is a powerful way to avoid boilerplate code.
+     *
+     * It looks for a matching entry in the global `Neo.overwrites` object based on the
+     * class's `className`. If found, it merges the properties from the overwrite object
+     * into the class's static `config`. This provides a powerful mechanism for theming
+     * or applying application-wide customizations to framework or library classes without
+     * needing to extend them.
+     *
+     * @example
+     * // Imagine you have hundreds of buttons in your app, and you want all of them
+     * // to have `labelPosition: 'top'` instead of the default `'left'`.
+     * // Instead of configuring each instance, you can define an overwrite.
+     *
+     * // inside an Overwrites.mjs file loaded by your app:
+     * Neo.overwrites = {
+     *     Neo: {
+     *         button: {
+     *             Base: {
+     *                 labelPosition: 'top'
+     *             }
+     *         }
+     *     }
+     * };
+     *
+     * // Now, every `Neo.button.Base` (and any class that extends it) will have this
+     * // new default value on its prototype.
+     *
+     * @param {Object} cfg The static `config` object of the class being processed.
      * @protected
+     * @static
      */
     static applyOverwrites(cfg) {
         let overwrites = Neo.ns(cfg.className, false, Neo.overwrites),
@@ -774,40 +825,42 @@ class Base {
         let me                = this,
             classFieldsViaSet = {};
 
-        // Start batching for effects
-        EffectBatchManager.startBatch();
+        // Prevent Effects from running for bulk changes
+        EffectManager.pause();
 
-        values = me.setFields(values);
+        try {
+            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
-        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]
+            // 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
+            if (me[forceAssignConfigs] !== true && Object.keys(me[configSymbol]).length > 0) {
+                me.processConfigs()
             }
-        })
 
-        // Add reactive configs to the configSymbol
-        Object.assign(me[configSymbol], values);
+            // 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]
+                }
+            })
 
-        // 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
-        })
+            // Add reactive configs to the configSymbol
+            Object.assign(me[configSymbol], values);
 
-        // Process reactive configs
-        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
+            })
 
-        // End batching for effects
-        EffectBatchManager.endBatch();
+            // Process reactive configs
+            me.processConfigs(true);
+        } finally {
+            // Trigger the skipped Effect, if needed
+            EffectManager.resume()
+        }
     }
 
     /**

package/src/core/Compare.mjs

@@ -163,10 +163,7 @@ class Compare {
     }
 }
 
-const ns = Neo.ns('Neo.core', true);
-ns.Compare = Compare;
-
-// alias
-Neo.isEqual = Compare.isEqual;
-
-export default Compare;
+export default Neo.gatekeep(Compare, 'Neo.core.Compare', () => {
+    // alias
+    Neo.isEqual = Compare.isEqual
+});