neo.mjs 7.1.0 → 7.3.0

package/apps/portal/view/examples/List.mjs

@@ -0,0 +1,156 @@
+import BaseList from '../../../../src/list/Base.mjs';
+import Examples from '../../store/Examples.mjs';
+
+/**
+ * @class Portal.view.examples.List
+ * @extends Neo.list.Base
+ */
+class List extends BaseList {
+    /**
+     * A regex to enforce a maxLength (word break)
+     * @member {RegExp} nameRegEx
+     * @protected
+     * @static
+     */
+    static nameRegEx = /^(.{65}[^\s]*).*/
+
+    static config = {
+        /**
+         * @member {String} className='Portal.view.examples.List'
+         * @protected
+         */
+        className: 'Portal.view.examples.List',
+        /**
+         * @member {String[]} baseCls=['portal-examples-list','neo-list']
+         */
+        baseCls: ['portal-examples-list', 'neo-list'],
+        /**
+         * @member {String} baseUrl='https://neomjs.com/'
+         */
+        baseUrl: 'https://neomjs.com/',
+        /**
+         * The env of the example links.
+         * Valid values are 'development', 'dist/development', 'dist/production'
+         * @member {String} environment='development'
+         */
+        environment: 'development',
+        /**
+         * @member {Neo.data.Store} store=Examples
+         */
+        store: Examples,
+        /**
+         * @member {String|null} storeUrl_=null
+         */
+        storeUrl_: null,
+        /**
+         * @member {String} sourceBaseUrl='https://github.com/neo.mjs/neo/tree/dev/'
+         */
+        sourceBaseUrl: 'https://github.com/neo.mjs/neo/tree/dev/',
+        /**
+         * @member {Boolean} useWrapperNode=true
+         */
+        useWrapperNode: true,
+        /**
+         * @member {Object} _vdom
+         */
+        _vdom:
+        {cn: [
+            {tag: 'ul', cn: []}
+        ]}
+    }
+
+    /**
+     * Triggered before the store config gets changed.
+     * @param {Object|Neo.data.Store} value
+     * @param {Object|Neo.data.Store} oldValue
+     * @returns {Neo.data.Store}
+     * @protected
+     */
+    beforeSetStore(value, oldValue) {
+        if (value) {
+            if (value.isClass) {
+                value = {
+                    module: value,
+                    url   : this.storeUrl
+                };
+            } else if (Neo.isObject(value)) {
+                value.url = this.storeUrl;
+            }
+        }
+
+        return super.beforeSetStore(value, oldValue);
+    }
+
+    /**
+     * @param {Object} record
+     */
+    createItemContent(record) {
+        let basePath;
+
+        if (Neo.config.isGitHubPages) {
+            basePath = '../../../../resources_pub/website/examples';
+
+            if (Neo.config.environment !== 'development') {
+                basePath = '../../' + basePath
+            }
+        } else {
+            basePath = 'https://raw.githubusercontent.com/neomjs/pages/main/resources_pub/website/examples'
+        }
+
+        return [
+            {cls: ['content', 'neo-relative'], removeDom: record.hidden, cn: [
+                {cls: ['neo-full-size', 'preview-image'], style: {
+                    backgroundImage: `url('${basePath}/${record.image}'), linear-gradient(#777, #333)`}
+                },
+                {cls: ['neo-absolute', 'neo-item-bottom-position'], cn: [
+                    {...this.createLink(record)},
+                    {cls: ['neo-top-20'], cn: [
+                        {tag: 'a', cls: ['fab fa-github', 'neo-github-image'], href: this.sourceBaseUrl + record.sourceUrl, target: '_blank'},
+                        {cls: ['neo-inner-content'], cn: [
+                            {cls: ['neo-inner-details'], html: record.browsers.join(', ')},
+                            {cls: ['neo-inner-details'], html: record.environments.join(', ')}
+                        ]}
+                    ]}
+                ]}
+            ]}
+        ]
+    }
+
+    /**
+     *
+     * @param {Object} record
+     * @returns {Object}
+     */
+    createLink(record) {
+        let vdom = {
+            tag : 'a',
+            cls : ['neo-title'],
+            cn  : [{html: record.name.replace(List.nameRegEx, "$1")}],
+            href: this.baseUrl + record.url
+        };
+
+        // Do not open multi-window examples inside a new browser window, in case the environment is the same.
+        // E.g. opening the multi-window covid app & the portal app inside the same app worker is problematic.
+        if (!record.sharedWorkers || this.environment !== Neo.config.environment) {
+            vdom.target = '_blank'
+        }
+
+        return vdom
+    }
+
+    /**
+     * @returns {Object}
+     */
+    getVdomRoot() {
+        return this.vdom.cn[0]
+    }
+
+    /**
+     * @returns {Object}
+     */
+    getVnodeRoot() {
+        return this.vnode.childNodes[0]
+    }
+}
+
+export default Neo.setupClass(List);

package/apps/portal/view/examples/TabContainer.mjs

@@ -0,0 +1,81 @@
+import Container              from '../../../../src/tab/Container.mjs';
+import List                   from './List.mjs';
+import TabContainerController from './TabContainerController.mjs';
+
+/**
+ * @class Portal.view.examples.TabContainer
+ * @extends Neo.tab.Container
+ */
+class TabContainer extends Container {
+    static config = {
+        /**
+         * @member {String} className='Portal.view.examples.TabContainer'
+         * @protected
+         */
+        className: 'Portal.view.examples.TabContainer',
+        /**
+         * @member {Number|null} activeIndex=null
+         */
+        activeIndex: null,
+        /**
+         * @member {String[]} baseCls=['portal-examples-tab-container','neo-tab-container']
+         */
+        baseCls: ['portal-examples-tab-container', 'neo-tab-container'],
+        /**
+         * @member {Neo.controller.Component} controller=TabContainerController
+         */
+        controller: TabContainerController,
+        /**
+         * @member {Object} headerToolbarDefaults
+         */
+        headerToolbarDefaults: {
+            cls: ['portal-examples-tab-header-toolbar']
+        },
+        /**
+         * @member {Object} itemDefaults
+         */
+        itemDefaults: {
+            module: List
+        },
+        /**
+         * @member {Object[]} items
+         */
+        items: [{
+            reference      : 'examples-devmode-list',
+            storeUrl       : '../../apps/portal/resources/data/examples_devmode.json',
+            tabButtonConfig: {
+                iconCls: 'fa fa-chess-knight',
+                route  : '/examples/devmode',
+                text   : 'DevMode'
+            }
+        }, {
+            environment    : 'dist/development',
+            reference      : 'examples-dist-dev-list',
+            storeUrl       : '../../apps/portal/resources/data/examples_dist_dev.json',
+            tabButtonConfig: {
+                iconCls: 'fa fa-chess-queen',
+                route  : '/examples/dist_dev',
+                text   : 'dist/dev'
+            }
+        }, {
+            environment    : 'dist/production',
+            reference      : 'examples-dist-prod-list',
+            storeUrl       : '../../apps/portal/resources/data/examples_dist_prod.json',
+            tabButtonConfig: {
+                iconCls: 'fa fa-chess-king',
+                route  : '/examples/dist_prod',
+                text   : 'dist/prod'
+            }
+        }],
+        /**
+         * @member {Boolean} sortable=true
+         */
+        sortable: true,
+        /**
+         * @member {String} tabBarPosition='left'
+         */
+        tabBarPosition: 'left',
+    }
+}
+
+export default Neo.setupClass(TabContainer);

package/apps/portal/view/examples/TabContainerController.mjs

@@ -0,0 +1,41 @@
+import Component from '../../../../src/controller/Component.mjs';
+
+/**
+ * @class Portal.view.examples.TabContainerController
+ * @extends Neo.controller.Component
+ */
+class TabContainerController extends Component {
+    static config = {
+        /**
+         * @member {String} className='Portal.view.examples.TabContainerController'
+         * @protected
+         */
+        className: 'Portal.view.examples.TabContainerController',
+        /**
+         * @member {Object} routes
+         */
+        routes: {
+            '/examples'         : 'onExamplesRoute',
+            '/examples/{itemId}': 'onExamplesRoute'
+        }
+    }
+
+    /**
+     * @param {Object} params
+     * @param {Object} value
+     * @param {Object} oldValue
+     */
+    onExamplesRoute(params, value, oldValue) {
+        let me     = this,
+            itemId = params?.itemId || 'dist_prod',
+            store  = me.getReference(`examples-${itemId.replace('_', '-')}-list`).store;
+
+        if (store?.getCount() < 1) {
+            store.load()
+        }
+
+        me.component.activeIndex = itemId === 'dist_prod' ? 2 : itemId === 'dist_dev' ? 1 : 0
+    }
+}
+
+export default Neo.setupClass(TabContainerController);

package/apps/portal/view/home/FooterContainer.mjs

@@ -111,7 +111,7 @@ class FooterContainer extends Container {
             }, {
                 module: Component,
                 cls   : ['neo-version'],
-                html  : 'v7.1.0'
+                html  : 'v7.3.0'
             }]
         }],
         /**

package/apps/realworld/api/Article.mjs

@@ -3,6 +3,7 @@ import Base from './Base.mjs';
 /**
  * @class RealWorld.api.Article
  * @extends RealWorld.api.Base
+ * @singleton
  */
 class Article extends Base {
     static config = {
@@ -14,7 +15,12 @@ class Article extends Base {
         /**
          * @member {String} resource='/articles'
          */
-        resource: '/articles'
+        resource: '/articles',
+        /**
+         * @member {Boolean} singleton=true
+         * @protected
+         */
+        singleton: true
     }
 
     /**

package/apps/realworld/api/Favorite.mjs

@@ -3,6 +3,7 @@ import Base from './Base.mjs';
 /**
  * @class RealWorld.api.Favorite
  * @extends RealWorld.api.Base
+ * @singleton
  */
 class Favorite extends Base {
     static config = {
@@ -10,7 +11,12 @@ class Favorite extends Base {
          * @member {String} className='RealWorld.api.Favorite'
          * @protected
          */
-        className: 'RealWorld.api.Favorite'
+        className: 'RealWorld.api.Favorite',
+        /**
+         * @member {Boolean} singleton=true
+         * @protected
+         */
+        singleton: true
     }
 
     /**

package/apps/realworld/api/Profile.mjs

@@ -3,6 +3,7 @@ import Base from './Base.mjs';
 /**
  * @class RealWorld.api.Profile
  * @extends RealWorld.api.Base
+ * @singleton
  */
 class Profile extends Base {
     static config = {
@@ -14,7 +15,12 @@ class Profile extends Base {
         /**
          * @member {String} resource='/profiles'
          */
-        resource: '/profiles'
+        resource: '/profiles',
+        /**
+         * @member {Boolean} singleton=true
+         * @protected
+         */
+        singleton: true
     }
 
     /**

package/apps/realworld/api/Tag.mjs

@@ -3,6 +3,7 @@ import Base from './Base.mjs';
 /**
  * @class RealWorld.api.Tag
  * @extends RealWorld.api.Base
+ * @singleton
  */
 class Tag extends Base {
     static config = {
@@ -14,7 +15,12 @@ class Tag extends Base {
         /**
          * @member {String} resource='/tags'
          */
-        resource: '/tags'
+        resource: '/tags',
+        /**
+         * @member {Boolean} singleton=true
+         * @protected
+         */
+        singleton: true
     }
 }
 

package/apps/realworld/api/User.mjs

@@ -3,6 +3,7 @@ import Base from './Base.mjs';
 /**
  * @class RealWorld.api.User
  * @extends RealWorld.api.Base
+ * @singleton
  */
 class User extends Base {
     static config = {
@@ -14,7 +15,12 @@ class User extends Base {
         /**
          * @member {String} resource='/tags'
          */
-        resource: '/users'
+        resource: '/users',
+        /**
+         * @member {Boolean} singleton=true
+         * @protected
+         */
+        singleton: true
     }
 }
 

package/apps/realworld2/api/Article.mjs

@@ -3,6 +3,7 @@ import Base from './Base.mjs';
 /**
  * @class RealWorld2.api.Article
  * @extends RealWorld2.api.Base
+ * @singleton
  */
 class Article extends Base {
     static config = {
@@ -14,7 +15,12 @@ class Article extends Base {
         /**
          * @member {String} resource='/articles'
          */
-        resource: '/articles'
+        resource: '/articles',
+        /**
+         * @member {Boolean} singleton=true
+         * @protected
+         */
+        singleton: true
     }
 
     /**

package/apps/realworld2/api/Favorite.mjs

@@ -3,6 +3,7 @@ import Base from './Base.mjs';
 /**
  * @class RealWorld2.api.Favorite
  * @extends RealWorld2.api.Base
+ * @singleton
  */
 class Favorite extends Base {
     static config = {
@@ -10,7 +11,12 @@ class Favorite extends Base {
          * @member {String} className='RealWorld2.api.Favorite'
          * @protected
          */
-        className: 'RealWorld2.api.Favorite'
+        className: 'RealWorld2.api.Favorite',
+        /**
+         * @member {Boolean} singleton=true
+         * @protected
+         */
+        singleton: true
     }
 
     /**

package/apps/realworld2/api/Profile.mjs

@@ -3,6 +3,7 @@ import Base from './Base.mjs';
 /**
  * @class RealWorld2.api.Profile
  * @extends RealWorld2.api.Base
+ * @singleton
  */
 class Profile extends Base {
     static config = {
@@ -14,7 +15,12 @@ class Profile extends Base {
         /**
          * @member {String} resource='/profiles'
          */
-        resource: '/profiles'
+        resource: '/profiles',
+        /**
+         * @member {Boolean} singleton=true
+         * @protected
+         */
+        singleton: true
     }
 
     /**

package/apps/realworld2/api/Tag.mjs

@@ -3,6 +3,7 @@ import Base from './Base.mjs';
 /**
  * @class RealWorld2.api.Tag
  * @extends RealWorld2.api.Base
+ * @singleton
  */
 class Tag extends Base {
     static config = {
@@ -14,7 +15,12 @@ class Tag extends Base {
         /**
          * @member {String} resource='/tags'
          */
-        resource: '/tags'
+        resource: '/tags',
+        /**
+         * @member {Boolean} singleton=true
+         * @protected
+         */
+        singleton: true
     }
 }
 

package/apps/realworld2/api/User.mjs

@@ -3,6 +3,7 @@ import Base from './Base.mjs';
 /**
  * @class RealWorld2.api.User
  * @extends RealWorld2.api.Base
+ * @singleton
  */
 class User extends Base {
     static config = {
@@ -14,7 +15,12 @@ class User extends Base {
         /**
          * @member {String} resource='/tags'
          */
-        resource: '/users'
+        resource: '/users',
+        /**
+         * @member {Boolean} singleton=true
+         * @protected
+         */
+        singleton: true
     }
 }