neo.mjs 9.6.0 → 9.7.0

package/{apps/ServiceWorker.mjs → ServiceWorker.mjs}

@@ -1,6 +1,6 @@
-import Neo         from '../src/Neo.mjs';
-import * as core   from '../src/core/_export.mjs';
-import ServiceBase from '../src/worker/ServiceBase.mjs';
+import Neo         from './src/Neo.mjs';
+import * as core   from './src/core/_export.mjs';
+import ServiceBase from './src/worker/ServiceBase.mjs';
 
 /**
  * @class Neo.ServiceWorker
@@ -20,9 +20,9 @@ class ServiceWorker extends ServiceBase {
          */
         singleton: true,
         /**
-         * @member {String} version='9.6.0'
+         * @member {String} version='9.7.0'
          */
-        version: '9.6.0'
+        version: '9.7.0'
     }
 
     /**

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

@@ -107,7 +107,7 @@ class FooterContainer extends Container {
             }, {
                 module: Component,
                 cls   : ['neo-version'],
-                html  : 'v9.6.0'
+                html  : 'v9.7.0'
             }]
         }],
         /**

package/apps/portal/view/learn/MainContainerStateProvider.mjs

@@ -14,9 +14,9 @@ class MainContainerStateProvider extends StateProvider {
          */
         className: 'Portal.view.learn.MainContainerStateProvider',
         /**
-         * @member {String} contentBasePath='../../resources/data/deck/'
+         * @member {String} contentBasePath=Neo.config.basePath+'resources/data/deck/'
          */
-        contentBasePath: '../../resources/data/deck/',
+        contentBasePath: Neo.config.basePath + 'resources/data/deck/',
         /**
          * @member {Object} data
          */

package/buildScripts/buildESModules.mjs

@@ -8,7 +8,10 @@ const
     __filename       = fileURLToPath(import.meta.url),
     __dirname        = path.dirname(__filename),
     inputDirectories = ['apps', 'docs', 'examples', 'src'],
-    outputBasePath   = '../dist/esm/';
+    outputBasePath   = '../dist/esm/',
+    // Regex to find import statements with 'node_modules' in the path
+    // It captures the entire import statement (excluding the leading 'import') and the path itself.
+    regexImport      = /(import(?:["'\s]*(?:[\w*{}\n\r\t, ]+)from\s*)?)(["'`])((?:(?!\2).)*node_modules(?:(?!\2).)*)\2/g;
 
 async function minifyDirectory(inputDir, outputDir) {
     if (fs.existsSync(inputDir)) {
@@ -32,7 +35,11 @@ async function minifyDirectory(inputDir, outputDir) {
                         const jsonContent = JSON.parse(content);
 
                         if (dirent.name === 'neo-config.json') {
-                            jsonContent.environment = 'dist/esm';
+                            Object.assign(jsonContent, {
+                                basePath      : '../../' + jsonContent.basePath,
+                                environment   : 'dist/esm',
+                                workerBasePath: jsonContent.basePath + 'src/worker/'
+                            })
                         }
 
                         fs.writeFileSync(outputPath, JSON.stringify(jsonContent));
@@ -47,7 +54,18 @@ async function minifyDirectory(inputDir, outputDir) {
                     }
                     // Minify JS files
                     else if (dirent.name.endsWith('.mjs')) {
-                        const result = await minifyJs(content, {
+                        let adjustedContent = content.replace(regexImport, (match, p1, p2, p3) => {
+                            // p1 will be "import {marked}    from " (or similar, including the 'import' keyword and everything up to the first quote)
+                            // p2 will be the quote character (', ", or `)
+                            // p3 will be the original path string (e.g., '../../../../node_modules/marked/lib/marked.esm.js')
+
+                            const newPath = '../../' + p3; // Prepend 2 levels up
+
+                            // Reconstruct the import statement with the new path
+                            return p1 + p2 + newPath + p2;
+                        });
+
+                        const result = await minifyJs(adjustedContent, {
                             module: true,
                             compress: {
                                 dead_code: true

package/buildScripts/injectPackageVersion.mjs

@@ -15,20 +15,13 @@ const
     neoPath     = insideNeo ? './' : './node_modules/neo.mjs/',
     programName = `${packageJson.name} inject-package-version`;
 
-let startDate            = new Date(),
-    configPath           = path.join(__dirname, 'src/DefaultConfig.mjs'),
-    contentArray         = fs.readFileSync(configPath).toString().split(os.EOL),
-    i                    = 0,
-    len                  = contentArray.length,
-    serviceWorkerFolders = ['apps'],
-    versionString        = `'${packageJson.version}'`,
-    serviceContentArray, serviceWorkerPath
-
-if (!insideNeo) {
-    // todo
-} else {
-    serviceWorkerFolders.push('examples');
-}
+let startDate     = new Date(),
+    configPath    = path.join(__dirname, 'src/DefaultConfig.mjs'),
+    contentArray  = fs.readFileSync(configPath).toString().split(os.EOL),
+    i             = 0,
+    len           = contentArray.length,
+    versionString = `'${packageJson.version}'`,
+    serviceContentArray, serviceWorkerPath;
 
 for (; i < len; i++) {
     if (contentArray[i].includes('version:')) {
@@ -41,24 +34,22 @@ for (; i < len; i++) {
 
 fs.writeFileSync(configPath, contentArray.join(os.EOL));
 
-serviceWorkerFolders.forEach(folder => {
-    serviceWorkerPath    = path.join(__dirname, folder, 'ServiceWorker.mjs');
-    serviceContentArray  = fs.readFileSync(serviceWorkerPath).toString().split(os.EOL);
+serviceWorkerPath    = path.join(__dirname, 'ServiceWorker.mjs');
+serviceContentArray  = fs.readFileSync(serviceWorkerPath, 'utf-8').toString().split(os.EOL);
 
-    i   = 0;
-    len = serviceContentArray.length;
+i   = 0;
+len = serviceContentArray.length;
 
-    for (; i < len; i++) {
-        if (serviceContentArray[i].includes('version:')) {
-            // we want to update the comment inside ServiceWorker.mjs as well
-            serviceContentArray[i - 2] = serviceContentArray[i - 2].replace(/'\d.+'/, versionString);
-            serviceContentArray[i]     = serviceContentArray[i]    .replace(/'\d.+'/, versionString);
-            break;
-        }
+for (; i < len; i++) {
+    if (serviceContentArray[i].includes('version:')) {
+        // we want to update the comment inside ServiceWorker.mjs as well
+        serviceContentArray[i - 2] = serviceContentArray[i - 2].replace(/'\d.+'/, versionString);
+        serviceContentArray[i]     = serviceContentArray[i]    .replace(/'\d.+'/, versionString);
+        break;
     }
+}
 
-    fs.writeFileSync(serviceWorkerPath, serviceContentArray.join(os.EOL));
-});
+fs.writeFileSync(serviceWorkerPath, serviceContentArray.join(os.EOL));
 
 // Update the version inside the Portal App Footer
 if (insideNeo) {

package/buildScripts/webpack/development/webpack.config.worker.mjs

@@ -15,7 +15,7 @@ export default env => {
 
     if (filenameConfig.workers) {
         Object.entries(filenameConfig.workers).forEach(([key, value]) => {
-            // Inside a neo workspace, we want to use the SW inside the top level apps folder,
+            // Inside a neo workspace, we want to use the SW inside the top level folder,
             // to allow overriding its logic
             if (key === env.worker) {
                 entry[key] = path.resolve(key === 'service' && !insideNeo ? cwd : neoPath, value.input);

package/buildScripts/webpack/json/build.json

@@ -15,7 +15,7 @@
             "output": "dataworker.js"
         },
         "service": {
-            "input": "./apps/ServiceWorker.mjs",
+            "input": "./ServiceWorker.mjs",
             "output": "serviceworker.js"
         },
         "vdom": {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name"           : "neo.mjs",
-    "version"        : "9.6.0",
+    "version"        : "9.7.0",
     "description"    : "The webworkers driven UI framework",
     "type"           : "module",
     "repository"     : {

package/src/DefaultConfig.mjs

@@ -229,7 +229,8 @@ const DefaultConfig = {
      * True will add the ServiceWorker main thread addon to support caching of assets (PWA)
      * See: https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API
      *
-     * You can also use a string to specify the target environment => 'dist/production'
+     * You can also use a string to specify the target environment => 'dist/production'.
+     * Using 'dist/production' will also use the service worker for 'dist/esm'
      * @default false
      * @memberOf! module:Neo
      * @name config.useServiceWorker
@@ -263,12 +264,12 @@ const DefaultConfig = {
     useVdomWorker: true,
     /**
      * buildScripts/injectPackageVersion.mjs will update this value
-     * @default '9.6.0'
+     * @default '9.7.0'
      * @memberOf! module:Neo
      * @name config.version
      * @type String
      */
-    version: '9.6.0'
+    version: '9.7.0'
 };
 
 Object.assign(DefaultConfig, {

package/src/Main.mjs

@@ -243,28 +243,29 @@ class Main extends core.Base {
      *
      */
     async onDomContentLoaded() {
-        let me                 = this,
-            {config}           = Neo,
-            {mainThreadAddons} = config,
-            imports            = [],
+        let me       = this,
+            {config} = Neo,
+            imports  = [],
+            {environment, mainThreadAddons, useServiceWorker} = config,
             modules;
 
         DomAccess.onDomContentLoaded();
 
-        // we need different publicPath values for the main thread inside the webpack based dist envs,
+        // We need different publicPath values for the main thread inside the webpack based dist envs,
         // depending on the hierarchy level of the app entry point
-        if (config.environment === 'dist/development' || config.environment === 'dist/production') {
+        if (environment === 'dist/development' || environment === 'dist/production') {
             __webpack_require__.p = config.basePath.substring(6)
         }
 
-        // intended for the online examples where we need an easy way to add GA to every generated app
+        // Intended for the online examples where we need an easy way to add GA to every generated app
         if (config.useGoogleAnalytics && !mainThreadAddons.includes('AnalyticsByGoogle')) {
             mainThreadAddons.push('AnalyticsByGoogle')
         }
 
         if ((
-                config.useServiceWorker === true ||
-                config.useServiceWorker === config.environment
+                useServiceWorker === true ||
+                useServiceWorker === environment ||
+                (useServiceWorker === 'dist/production' && environment === 'dist/esm')
             ) &&
             !mainThreadAddons.includes('ServiceWorker')
         ) {

package/src/main/addon/ServiceWorker.mjs

@@ -30,13 +30,16 @@ class ServiceWorker extends Base {
         if ('serviceWorker' in navigator) {
             let me              = this,
                 {config}        = Neo,
-                devMode         = config.environment === 'development',
-                fileName        = devMode ? 'ServiceWorker.mjs' : 'serviceworker.js',
-                folder          = window.location.pathname.includes('/examples/') ? 'examples/' : 'apps/',
-                opts            = devMode ? {type: 'module'} : {},
-                path            = (devMode ? config.basePath : config.workerBasePath) + (devMode ? folder : '') + fileName,
+                {environment}   = config,
+                devMode         = environment === 'development',
+                hasJsModules    = devMode || environment === 'dist/esm',
+                fileName        = hasJsModules ? 'ServiceWorker.mjs' : 'serviceworker.js',
+                opts            = hasJsModules ? {type: 'module'} : {},
+                path            = (hasJsModules ? config.basePath : config.workerBasePath) + fileName,
                 {serviceWorker} = navigator,
-                registration    = await serviceWorker.register(path, opts);
+                registration;
+
+            registration = await serviceWorker.register(path, opts);
 
             window.addEventListener('beforeunload', me.onBeforeUnload.bind(me));
 

package/src/main/addon/Stylesheet.mjs

@@ -48,11 +48,7 @@ class Stylesheet extends Base {
 
         if (neoConfig.useFontAwesome) {
             if (env === 'development' || env === 'dist/esm') {
-                faPath = neoConfig.basePath + 'node_modules/@fortawesome/fontawesome-free/css/all.min.css';
-
-                if (env === 'dist/esm') {
-                    faPath = '../../' + faPath
-                }
+                faPath = neoConfig.basePath + 'node_modules/@fortawesome/fontawesome-free/css/all.min.css'
             } else {
                 faPath = neoConfig.basePath.substring(6) + 'resources/fontawesome-free/css/all.min.css'
             }
@@ -78,10 +74,6 @@ class Stylesheet extends Base {
 
         document.body.classList.add(themes[0]);
 
-        if (env === 'dist/esm') {
-            path = '../../' + path;
-        }
-
         folders.forEach(folder => {
             if (folder.startsWith('neo-')) {
                 folder = folder.substring(4)
@@ -109,10 +101,6 @@ class Stylesheet extends Base {
             promises    = [],
             rootPath    = config.basePath.substring(6);
 
-        if (env === 'dist/esm') {
-            path = '../../' + path;
-        }
-
         if (className.startsWith('Neo.')) {
             className = className.substring(4)
         }

package/src/worker/Manager.mjs

@@ -42,12 +42,6 @@ class Manager extends Base {
          * @protected
          */
         appNames: [],
-        /**
-         * The base path for the worker file URLs, can e.g. get set inside the index.html.
-         * @member {String|null} basePath=Neo.config.workerBasePath || 'worker/'
-         * @protected
-         */
-        basePath: NeoConfig.workerBasePath || 'worker/',
         /**
          * @member {Number} constructedThreads=0
          * @protected
@@ -164,7 +158,7 @@ class Manager extends Base {
     createWorker(opts) {
         let me         = this,
             {fileName} = opts,
-            filePath   = (opts.basePath || me.basePath) + fileName,
+            filePath   = (opts.basePath || Neo.config.workerBasePath) + fileName,
             name       = `neomjs-${fileName.substring(0, fileName.indexOf('.')).toLowerCase()}-worker`,
             isShared   = me.sharedWorkersEnabled && NeoConfig.useSharedWorkers,
             cls        = isShared ? SharedWorker : Worker,

package/src/worker/ServiceBase.mjs

@@ -42,6 +42,7 @@ class ServiceBase extends Base {
      */
     cachePaths = [
         'raw.githubusercontent.com/',
+        '/dist/esm/',
         '/dist/production/',
         '/fontawesome',
         '/resources/'

package/examples/ServiceWorker.mjs

@@ -1,35 +0,0 @@
-import Neo         from '../src/Neo.mjs';
-import * as core   from '../src/core/_export.mjs';
-import ServiceBase from '../src/worker/ServiceBase.mjs';
-
-/**
- * @class Neo.ServiceWorker
- * @extends Neo.worker.ServiceBase
- * @singleton
- */
-class ServiceWorker extends ServiceBase {
-    static config = {
-        /**
-         * @member {String} className='Neo.ServiceWorker'
-         * @protected
-         */
-        className: 'Neo.ServiceWorker',
-        /**
-         * @member {Boolean} singleton=true
-         * @protected
-         */
-        singleton: true,
-        /**
-         * @member {String} version='9.6.0'
-         */
-        version: '9.6.0'
-    }
-
-    /**
-     * @member {String} workerId='service'
-     * @protected
-     */
-    workerId = 'service'
-}
-
-export default Neo.setupClass(ServiceWorker);