@rws-framework/client 2.4.2 → 2.5.0

package/.eslintrc.json

@@ -18,9 +18,7 @@
     "rules": {
         "no-unused-vars": "off",                
         "no-prototype-builtins": "off",                
-        "no-case-declarations": "off",
-        "unused-imports/no-unused-imports": "error",
-        "unused-imports/no-unused-vars": ["warn", { "vars": "all", "args": "none"}],     
+        "no-case-declarations": "off",        
         "@typescript-eslint/no-var-requires": "off",   
         "@typescript-eslint/semi": ["error", "always"],
         "@typescript-eslint/no-unused-vars": "off",

package/.setup/_base.eslintrc.json

@@ -15,9 +15,7 @@
     "rules": {
         "no-case-declarations": "off",
         "no-unused-vars": "off",                
-        "no-prototype-builtins": "off",                
-        "unused-imports/no-unused-imports": "error",
-        "unused-imports/no-unused-vars": ["warn", { "vars": "all", "args": "none"}],     
+        "no-prototype-builtins": "off",                         
         "@typescript-eslint/no-var-requires": "off",   
         "@typescript-eslint/semi": ["error", "always"],
         "@typescript-eslint/no-unused-vars": "off",

package/_tools.js

@@ -3,6 +3,7 @@ const fs = require('fs');
 const ts = require('typescript');
 const { spawn } = require('child_process');
 const JSON5 = require('json5');
+const chalk = require('chalk');
 
 function findRootWorkspacePath(currentPath) {        
   const parentPackageJsonPath = path.join(currentPath + '/..', 'package.json');        
@@ -329,6 +330,57 @@ function getAllFilesInFolder(folderPath, ignoreFilenames = [], recursive = false
   return files;
 }
 
+function setupTsConfig(tsConfigPath)
+{
+  
+  if(!fs.existsSync(tsConfigPath)){
+    throw new Error(`Typescript config file "${tsConfigPath}" does not exist`);
+  }  
+
+  const tsConfigContents = fs.readFileSync(tsConfigPath, 'utf-8');  
+
+  try{
+    const tsConfig = JSON.parse(tsConfigContents);  
+
+    const declarationsPath = path.resolve(__dirname, 'types') + '/declarations.d.ts';
+    const testsPath = path.resolve(__dirname, 'tests');
+  
+    let changed = false;  
+  
+    if(!Object.keys(tsConfig).includes('include')){
+      tsConfig['include'] = [];
+    }
+  
+    if(!Object.keys(tsConfig).includes('exclude')){
+      tsConfig['exclude'] = [];
+    }
+  
+    if(!tsConfig['include'].includes(declarationsPath)){
+      console.log(chalk.blueBright('[RWS TS CONFIG]'), 'adding RWS typescript declarations to project tsconfig.json');
+      tsConfig['include'].push(declarationsPath);
+      changed = true;
+    }
+  
+    if(!tsConfig['exclude'].includes(testsPath)){
+      console.log(chalk.blueBright('[RWS TS CONFIG]'), 'adding RWS typescript exclusions to project tsconfig.json');
+      tsConfig['exclude'].push(testsPath);
+      changed = true;
+    }
+  
+    if(changed){
+      fs.writeFileSync(tsConfigPath, JSON.stringify(tsConfig, null, 2));
+      console.log(chalk.yellowBright('Typescript config file'), `"${chalk.blueBright(tsConfigPath)}"`, chalk.yellowBright('has been changed'));
+    }
+
+    return true;
+  } catch (e) {
+    console.log(chalk.red('Error in tsconfig.json:'));
+    console.log(chalk.blueBright(e.message));
+
+    return false;
+  }
+}
+
 module.exports = {
     findRootWorkspacePath,
     findPackageDir,
@@ -340,5 +392,6 @@ module.exports = {
     extractRWSIgnoreArguments,
     findServiceFilesWithClassExtend,
     findSuperclassFilePath,
-    getAllFilesInFolder
+    getAllFilesInFolder,
+    setupTsConfig
 }

package/cfg/_default.cfg.js

@@ -6,7 +6,7 @@ const _DEFAULT_CONFIG_VARS = {
     publicDir: './public',
     publicIndex: 'index.html',      
     outputFileName: 'client.rws.js',
-    outputDir: process.cwd() + '/build',
+    outputDir: './build',
     //Frontend RWS client configs  
     backendUrl: null,
     wsUrl: null,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@rws-framework/client",
   "private": false,
-  "version": "2.4.2",
+  "version": "2.5.0",
   "main": "src/index.ts",
   "scripts": {
     "docs": "typedoc --tsconfig ./tsconfig.json"
@@ -28,11 +28,12 @@
   "dependencies": {
     "@microsoft/fast-element": "^1.12.0",
     "@microsoft/fast-foundation": "^2.46.2",
-    "@rws-framework/console": "^0.2.0",
+    "@rws-framework/console": "^0.2.2",
     "@types/moment": "^2.13.0",
     "dragula": "^3.7.3",
     "he": "^1.2.0",
     "json5": "^2.2.3",
+    "lodash": "^4.17.21",
     "moment": "^2.29.4",
     "partial-json-parser": "^1.0.0",
     "reflect-metadata": "^0.1.13",
@@ -50,25 +51,19 @@
     "v4": "^0.0.1"
   },
   "devDependencies": {
-    "@open-wc/dev-server-hmr": "^0.1.2-next.0",
     "@types/dragula": "^3.7.4",
     "@types/express-fileupload": "^1.4.4",
     "@types/glob": "^8.1.0",
-    "@types/he": "^1.2.3",
-    "@types/json5": "^2.2.0",
-    "@types/sanitize-html": "^2.11.0",
-    "@types/socket.io-client": "^3.0.0",
+    "@types/he": "^1.2.3",    
+    "@types/sanitize-html": "^2.11.0",    
     "@types/uuid": "^9.0.7",
-    "@typescript-eslint/eslint-plugin": "^7.2.0",
-    "@typescript-eslint/parser": "^7.2.0",
+    "@types/eslint": "^6.0.0",
+    "@typescript-eslint/parser": "^5.0.0",
     "clean-webpack-plugin": "^4.0.0",
     "css-loader": "^6.8.1",
-    "css-minimizer-webpack-plugin": "^5.0.1",
-    "dts-bundle": "^0.7.3",
-    "eslint": "^8.57.0",
-    "eslint-plugin-unused-imports": "^3.1.0",
+    "css-minimizer-webpack-plugin": "^5.0.1",    
+    "eslint": "^6.0.0",
     "file-loader": "^6.2.0",
-    "html-minifier": "^4.0.0",
     "html-webpack-plugin": "^5.5.3",
     "loader-utils": "^3.2.1",
     "mini-css-extract-plugin": "^2.7.6",
@@ -88,12 +83,17 @@
     "typedoc-plugin-rename-defaults": "^0.7.0",
     "typedoc-theme-hierarchy": "^4.1.2",
     "typescript": "^5.1.6",
-    "typescript-eslint": "^7.2.0",
     "url-loader": "^4.1.1",
     "webpack": "^5.75.0",
     "webpack-bundle-analyzer": "^4.10.1",
     "webpack-cli": "^5.1.4",
     "webpack-dev-server": "^4.15.1",
     "webpack-node-externals": "^3.0.0"
+  },
+  "resolutions": {
+    "lodash": "^4.17.21"
+  },
+  "overrides": {
+    "lodash": "^4.17.21"
   }
 }

package/rws.webpack.config.js

@@ -9,36 +9,39 @@ const RWSAfterPlugin = require('./webpack/rws_after_plugin');
 const tools = require('./_tools');
 const { _DEFAULT_CONFIG } = require('./cfg/_default.cfg');
 const RWSConfigBuilder = require('@rws-framework/console').RWSConfigBuilder;
+const RWSPath = require('@rws-framework/console').rwsPath;
 
 const TerserPlugin = require('terser-webpack-plugin');
-const HtmlMinifier = require('html-minifier').minify;
 const CssMinimizerPlugin = require('css-minimizer-webpack-plugin');
 const JsMinimizerPlugin = require('terser-webpack-plugin');
 
 const json5 = require('json5');
 
 
-const RWSWebpackWrapper = (config) => {
-const executionDir = config.executionDir || process.cwd();
+const RWSWebpackWrapper = (config) => {  
+  const BuildConfigurator = new RWSConfigBuilder(RWSPath.findPackageDir(process.cwd()) + '/.rws.json', _DEFAULT_CONFIG);
 
-const BuildConfigurator = new RWSConfigBuilder(executionDir + '/.rws.json', _DEFAULT_CONFIG);
+  config.packageDir = RWSPath.findPackageDir(process.cwd());
 
-const isDev = BuildConfigurator.get('dev') || config.dev;
-const isHotReload = BuildConfigurator.get('hot') || config.hot;
-const isReport = BuildConfigurator.get('report') || config.report;
+  const executionDir = RWSPath.relativize(BuildConfigurator.get('executionDir') || config.executionDir || process.cwd(), config.packageDir);
 
-const isParted = BuildConfigurator.get('parted') || config.parted;
-const partedPrefix = BuildConfigurator.get('partedPrefix') || config.partedPrefix;
-const partedDirUrlPrefix = BuildConfigurator.get('partedDirUrlPrefix') || config.partedDirUrlPrefix;
+  const isDev = BuildConfigurator.get('dev') || config.dev;
+  const isHotReload = BuildConfigurator.get('hot') || config.hot;
+  const isReport = BuildConfigurator.get('report') || config.report;
 
-const partedComponentsLocations = BuildConfigurator.get('partedComponentsLocations') || config.partedComponentsLocations;
-const customServiceLocations = BuildConfigurator.get('customServiceLocations') || config.customServiceLocations;
-const outputDir = BuildConfigurator.get('outputDir') || config.outputDir;
-const outputFileName = BuildConfigurator.get('outputFileName') || config.outputFileName;
-const publicDir = BuildConfigurator.get('publicDir') || config.publicDir;
-const serviceWorkerPath = BuildConfigurator.get('serviceWorker') || config.serviceWorker;
+  const isParted = BuildConfigurator.get('parted') || config.parted;
+  const partedPrefix = BuildConfigurator.get('partedPrefix') || config.partedPrefix;
+  const partedDirUrlPrefix = BuildConfigurator.get('partedDirUrlPrefix') || config.partedDirUrlPrefix;
 
-const publicIndex = BuildConfigurator.get('publicIndex') || config.publicIndex;
+  const partedComponentsLocations = BuildConfigurator.get('partedComponentsLocations') || config.partedComponentsLocations;
+  const customServiceLocations = BuildConfigurator.get('customServiceLocations') || config.customServiceLocations;
+  const outputDir = RWSPath.relativize(BuildConfigurator.get('outputDir') || config.outputDir, config.packageDir);
+
+  const outputFileName = BuildConfigurator.get('outputFileName') || config.outputFileName;
+  const publicDir = BuildConfigurator.get('publicDir') || config.publicDir;
+  const serviceWorkerPath = BuildConfigurator.get('serviceWorker') || config.serviceWorker;
+
+  const publicIndex = BuildConfigurator.get('publicIndex') || config.publicIndex;
 
 
   let WEBPACK_PLUGINS = [
@@ -98,16 +101,16 @@ const publicIndex = BuildConfigurator.get('publicIndex') || config.publicIndex;
     });
   }
 
-  const assetsToCopy = config.copyAssets || BuildConfigurator.get('copyAssets');
+  const assetsToCopy = BuildConfigurator.get('copyAssets') || config.copyAssets;
 
-  if (!!assetsToCopy) {
+  if (!!assetsToCopy) {    
     WEBPACK_AFTER_ACTIONS.push({
       type: 'copy',
       actionHandler: assetsToCopy
     });
   }
 
-  if (WEBPACK_AFTER_ACTIONS.length) {
+  if (WEBPACK_AFTER_ACTIONS.length) {    
     WEBPACK_PLUGINS.push(new RWSAfterPlugin({ actions: WEBPACK_AFTER_ACTIONS }));
   }
 
@@ -134,18 +137,18 @@ const publicIndex = BuildConfigurator.get('publicIndex') || config.publicIndex;
   const optimConfig = {
     minimize: true,
     minimizer: isDev ? [
-      new TerserPlugin({   
-        terserOptions: {      
+      new TerserPlugin({
+        terserOptions: {
           mangle: false, //@error breaks FAST view stuff if enabled for all assets             
           output: {
             comments: false
-          },          
+          },
         },
         extractComments: false,
         parallel: true,
       })
     ] : [
-      new TerserPlugin({   
+      new TerserPlugin({
         terserOptions: {
           keep_classnames: true, // Prevent mangling of class names
           mangle: false, //@error breaks FAST view stuff if enabled for all assets             
@@ -155,7 +158,7 @@ const publicIndex = BuildConfigurator.get('publicIndex') || config.publicIndex;
           },
           output: {
             comments: false
-          },          
+          },
         },
         extractComments: false,
         parallel: true,
@@ -215,6 +218,12 @@ const publicIndex = BuildConfigurator.get('publicIndex') || config.publicIndex;
     }
   }
 
+  const tsValidated = tools.setupTsConfig(path.resolve(config.tsConfigPath));
+
+  if(!tsValidated){
+    throw new Error('RWS Webpack build failed.');
+  }
+  
   const cfgExport = {
     entry: {
       client: config.entry,
@@ -267,7 +276,7 @@ const publicIndex = BuildConfigurator.get('publicIndex') || config.publicIndex;
               loader: 'ts-loader',
               options: {
                 allowTsInNodeModules: true,
-                configFile: path.resolve(config.tsConfigPath)
+                configFile: path.resolve(config.tsConfigPath)             
               }
             },
             {

package/tsconfig.json

@@ -19,10 +19,6 @@
     },
     "include": [
       "src",             
-      "docs-typings.d.ts",
-      "node_modules/@microsoft"
-    ],
-    "exclude": [                
-      
+      "types/docs-typings.d.ts"      
     ]
   }

package/webpack/after/copy.js

@@ -14,50 +14,56 @@ function collectFiles(dir, fileList = []) {
   return fileList;
 }
 
-module.exports = async (copyList = {}) => {
-    const copyQueue = [];
+module.exports = async (copyList = {}, pluginCfg) => {
+  const copyQueue = [];
+
+  Object.keys(copyList).forEach((targetPath) => {
+    const copyListKey = targetPath;
+
+    if (targetPath[0] === '.') {
+      targetPath = path.resolve(pluginCfg.packageDir, targetPath);
+    }
+
+    const sources = copyList[copyListKey];
+
+    sources.forEach((sourcePath) => {
+      const stat = fs.statSync(sourcePath);
+      if (stat.isDirectory()) {
+        // If sourcePath is a directory, collect all files recursively
+        const allFiles = collectFiles(sourcePath);
+        allFiles.forEach((file) => {
+          const relativePath = path.relative(sourcePath, file);
+          const targetFilePath = path.join(targetPath, relativePath);
+          const targetFileDir = path.dirname(targetFilePath);
+
+          // Ensure the target directory exists
+          if (!fs.existsSync(targetFileDir)) {
+            fs.mkdirSync(targetFileDir, { recursive: true });
+          }
 
-    Object.keys(copyList).forEach((targetPath) => {
-      const sources = copyList[targetPath];
-      
-      sources.forEach((sourcePath) => {
-        const stat = fs.statSync(sourcePath);
-        if (stat.isDirectory()) {
-          // If sourcePath is a directory, collect all files recursively
-          const allFiles = collectFiles(sourcePath);
-          allFiles.forEach((file) => {
-            const relativePath = path.relative(sourcePath, file);
-            const targetFilePath = path.join(targetPath, relativePath);
-            const targetFileDir = path.dirname(targetFilePath);
-    
-            // Ensure the target directory exists
-            if (!fs.existsSync(targetFileDir)) {
-              fs.mkdirSync(targetFileDir, { recursive: true });
-            }
-    
-            // Check if the file already exists in the target location
-            if (fs.existsSync(targetFilePath)) {
-              fs.unlinkSync(targetFilePath);
-            }
-    
-            // Add to copy queue
-            copyQueue.push({ from: file, to: targetFilePath });
-          });
-        } else {
-          // If sourcePath is not a directory, proceed as before
-          const fileName = path.basename(sourcePath);
-          const targetFilePath = path.join(targetPath, fileName);
-    
           // Check if the file already exists in the target location
           if (fs.existsSync(targetFilePath)) {
             fs.unlinkSync(targetFilePath);
           }
-    
+
           // Add to copy queue
-          copyQueue.push({ from: sourcePath, to: targetFilePath });
+          copyQueue.push({ from: file, to: targetFilePath });
+        });
+      } else {
+        // If sourcePath is not a directory, proceed as before
+        const fileName = path.basename(sourcePath);
+        const targetFilePath = path.join(targetPath, fileName);
+
+        // Check if the file already exists in the target location
+        if (fs.existsSync(targetFilePath)) {
+          fs.unlinkSync(targetFilePath);
         }
-      });
+
+        // Add to copy queue
+        copyQueue.push({ from: sourcePath, to: targetFilePath });
+      }
     });
+  });
 
     copyQueue.forEach((copyset) => {
         if(fs.existsSync(copyset.to)){

package/webpack/rws_after_plugin.js

@@ -2,7 +2,7 @@ const rwsAfterCopy = require('./after/copy');
 const rwsAfterSW = require('./after/sw');
 
 
-const _DEFAULT_CONFIG = {actions: []}
+const _DEFAULT_CONFIG = {actions: [], executionDir: process.cwd(), packageDir: process.cwd()}
 
 const _DEFAULT_ACTION = {
     type: 'copy',
@@ -67,8 +67,8 @@ class RWSAfterPlugin {
         switch (actionType){
             case 'copy': {
                 const copyFiles = typeof action === 'function' ? await action() : action;
-    
-                await rwsAfterCopy(copyFiles);
+              
+                await rwsAfterCopy(copyFiles, this.config);
                 return;
             };
 
@@ -92,8 +92,7 @@ class RWSAfterPlugin {
             }
 
             default:
-                console.warn('RWSAfterPlugin::_runActionType could not act upon input. Please resolve.');
-                console.log({ actionType, action })
+                console.warn('RWSAfterPlugin::_runActionType could not act upon input. Please resolve.');                
                 return;            
         }        
     }

package/webpack/rws_fast_ts_loader.js

@@ -135,8 +135,6 @@ module.exports = async function(content) {
     }catch(e){
         console.error(e);
         console.warn('IN:\n\n');
-        // console.log(processedContent);
-
         return content;
     }
 };

package/webpack/rws_plugin.js

@@ -303,7 +303,7 @@ class RWSPlugin {
         return finalCss;
       } catch(err) {
         console.error('SASS Error in', fileRootDir);
-        // console.log(err);
+        
         console.error(err);
         throw err;        
         return '';

package/src/hmr.ts

@@ -1,19 +0,0 @@
-//@ts-expect-error no-types
-import { hmrPlugin, presets } from '@open-wc/dev-server-hmr';
-
-const AUTORELOAD_CFG = {
-    plugins: [
-        hmrPlugin({
-            include: ['src/**/*'],
-            presets: [presets.fastElement],
-        }),
-    ],
-};
-
-const HMR = {
-    autoReloadConfig: (): any => {    
-        return AUTORELOAD_CFG;
-    }
-};
-
-export default HMR;