@tangelo/tangelo-configuration-toolkit 1.19.0 → 1.20.1

package/index.js

@@ -92,13 +92,13 @@ global._isPre51 = () => !fs.existsSync(path.join(_paths.repo, _paths.tdi, 'src')
 
 global._modulesTdi = {
   absolutePathTdi: path.join(_paths.repo, _paths.tdi),
-  ensureDepsUpToDate() {
+  ensureDepsUpToDate(message) {
     if (this.depsUpToDate) return;
     try {
-      _info('Checking installed dependencies in submodule');
+      if (message) _info('Checking installed dependencies in submodule');
       execSync('npm list', {cwd: this.absolutePathTdi, stdio: 'ignore'});
     } catch (e) {
-      _info('Updating dependencies in submodule');
+      if (message) _info('Updating dependencies in submodule');
       execSync('npm update', {cwd: this.absolutePathTdi, stdio: 'ignore'});
     }
     this.depsUpToDate = true;
@@ -110,7 +110,10 @@ global._modulesTdi = {
       return require(path.join(this.absolutePathTdi, 'tct', module));
     }
     catch (e) {
-      if (throws) _error('Module could not be loaded: ' + module);
+      if (throws) {
+        _debug(`${e}`);
+        _error('Module could not be loaded: ' + module);
+      }
       else return undefined;
     }
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tangelo/tangelo-configuration-toolkit",
-  "version": "1.19.0",
+  "version": "1.20.1",
   "engines": {
     "node": ">=14.0.0"
   },
@@ -46,10 +46,11 @@
     "p-limit": "^3.1.0",
     "replace-in-file": "^6.3.2",
     "sass": "^1.43.5",
-    "saxon-js": "^2.3.0",
+    "saxon-js": "^2.5.0",
     "ssh2-sftp-client": "^9.1.0",
     "through2": "^4.0.2",
     "tiny-lr": "^2.0.0",
+    "xml2js": "^0.6.2",
     "yargs": "^17.7.2"
   },
   "repository": {

package/src/lib/get-repoconfig.js

@@ -17,12 +17,15 @@ module.exports = function getRepoconfig(repoPath) {
       const path_cmscustom  = xpiDir.replace(/\/[^/]+$/, '').split(/\//);
       const path_dbconfig   = p.replace(/.*\/database\/config\/(.*)\/[^/]+/, '$1').split(/[/\\]/);
       const dnRegex         = [path_cmscustom[0].replace(/[_'"]/g, '.'), path_dbconfig[0].replace(/[_'"]/g, '.')].sort((a, b) => b.length - a.length).join('|');
-      const customer_name   = (dtDisplayName.match(RegExp(dnRegex, 'i')) || dtDisplayName.split(/ (.+)/))[0];
+      /* Get customer name based on txd_document_types.display_name; if that match fails fallback to customername defined in path */
+      const customer_name   = (dtDisplayName.match(RegExp(dnRegex, 'i')) || [path_cmscustom[0].split(/[\s_]/g).map(s => s[0].toUpperCase() + s.substring(1)).join(' ')])[0];
+      const customer_name_regex = RegExp(customer_name.replace(/(\W)/g, '\\$1?'), 'gi'); // match customer name; allow differences in special characters / match case insensitive
 
       return {
         customer_name,
         customer_abbr: ntName.split('_')[0],
-        project_name: dtDisplayName.split(RegExp(customer_name.replace(/(\W)/g, '\\$1')))[1].trim() || '',
+        /* if display name matches the customer name; strip customer name from display name to get the project name; otherwise use the complete display name as projectname  */
+        project_name: dtDisplayName.match(customer_name_regex) ? dtDisplayName.replace(customer_name_regex, '').trim() : dtDisplayName,
         project_abbr: ntName.split('_')[1],
         path_cmscustom,
         path_dbconfig,

package/src/lib/gulp-sftp.js

@@ -14,7 +14,7 @@ module.exports = function(ftpConfig, remotedir) {
 
     function transform (file, _, cb) {
       if (file.isStream()) return cb(new Error('Streaming not supported.'));
-      if (file.stat.isDirectory()) return cb();
+      if (file.stat?.isDirectory()) return cb();
 
       file.destination = path.join(remotedir, file.relative).toFws;
       files.push(file); // collect all files in array

package/src/lib/gulp-tcl-config.js

@@ -0,0 +1,40 @@
+const fs        = require('fs-extra');
+const path      = require('path');
+const TclConfig = require('./tcl-config');
+const through2  = require('through2');
+const Vinyl     = require('vinyl');
+
+
+function createAddToStreamFn(stream) {
+  return (path, content) => stream.push(new Vinyl({
+    path: path,
+    contents: Buffer.from(content)
+  }));
+}
+
+module.exports = function() {
+  const tclFileDirs = [];
+
+  return through2.obj(
+
+    function transform (file, _, cb) {
+      if (file.isStream()) return cb(new Error('Streaming not supported.'));
+
+      if (file.extname == '.tcl') tclFileDirs.push(path.dirname(file.relative));
+      return cb(null, file);
+    },
+
+    function flush(cb) {
+      for (const tclFileDir of tclFileDirs) {
+        const tclConfig = new TclConfig(tclFileDir, createAddToStreamFn(this));
+        tclConfig.outputJson(path.resolve(tclFileDir, 'fonto/assets'));
+        tclConfig.outputCss(path.resolve(tclFileDir, 'fonto'));
+        const esefCssDir = path.resolve(tclFileDir, 'export/esef/esef_out/css');
+        if (fs.existsSync(esefCssDir)) tclConfig.outputCss(esefCssDir);
+      }
+      cb();
+    }
+
+  )
+    .resume(); // required for triggering 'end' event
+};

package/src/lib/set-global-functions.js

@@ -10,6 +10,9 @@ global._info = (msg, time = false) => {
   }
   console.log(msg.lgreen);
 };
+global._debug = msg => {
+  if (global._devmode) console.log(`[DEBUG]: ${msg}`.yellow);
+};
 global._warn = msg => {
   console.log(msg.lyellow);
 };

package/src/lib/tcl-config.js

@@ -0,0 +1,101 @@
+const fs = require('fs-extra');
+const path = require('path');
+const sass = require('sass');
+const SaxonJS = require('saxon-js');
+
+
+module.exports = class TclConfig {
+
+  static #SEF_FILE_PATH = 'tcl/configToJson.sef.json';
+  static #JSON_TO_SCSS_FILE_PATH = 'tcl/configJsonToScss';
+  static #TCL_FILE_NAME = 'project.tcl';
+  static #TCL_JSON_FILE_NAME = 'tcl-config.json';
+  static #TCL_CSS_FILE_NAME = 'tcl-styles.css';
+  static #FONTO_HTML_FILE_NAME = 'index.html';
+
+  static #sefFile;
+  static #jsonToScssFile;
+
+  static #transformTclConfigToJson(tclFilePathRel) {
+    this.#sefFile ??= _modulesTdi.require(this.#SEF_FILE_PATH, {message: false});
+
+    const messages = [`  Warnings from transformation of ${tclFilePathRel}`];
+    const transformation = SaxonJS.transform({
+      stylesheetText: JSON.stringify(this.#sefFile),
+      sourceFileName: tclFilePathRel,
+      destination: 'raw',
+      deliverMessage(messageNode) {
+        messages.push(messageNode.textContent);
+      }
+    });
+
+    if (messages[1]) _warn(messages.join('\n    '));
+    return transformation.principalResult ?? _error(`No result from transformation of ${tclFilePathRel}`);
+  }
+
+  static #transformJsonToCss(tclFilePathRel, json, moduleName) {
+    this.#jsonToScssFile ??= _modulesTdi.require(this.#JSON_TO_SCSS_FILE_PATH, {message: false});
+    const scss = this.#jsonToScssFile(json.project, moduleName);
+    const url = new URL(path.join('file://', path.resolve(tclFilePathRel)));
+    return sass.compileString(scss, {url, style: 'compressed'}).css;
+  }
+
+  static #addCssImportToHtml(dir) {
+    const filepath = path.join(dir, this.#FONTO_HTML_FILE_NAME);
+
+    if (fs.existsSync(filepath)) {
+      const html = fs.readFileSync(filepath).toString();
+
+      if (!RegExp(`<link[^>]*${this.#TCL_CSS_FILE_NAME}[^>]*>`).test(html)) {
+        const newHtml = html.replace(/((\s+<link.*")[^"]+\.css(.*))/, `$1$2${this.#TCL_CSS_FILE_NAME}$3`);
+        fs.outputFileSync(filepath, newHtml);
+      }
+    }
+  }
+
+  #outputFn;
+  #doModifyFontoHtml;
+  #tclFilePathRel;
+  #tclFileExists;
+  #resultJson;
+  #resultCss = {};
+
+  constructor(tclFileRelDir, addToStreamFn) {
+    this.#tclFilePathRel = path.join(tclFileRelDir, TclConfig.#TCL_FILE_NAME);
+    this.#tclFileExists = fs.existsSync(this.#tclFilePathRel);
+    this.#outputFn = addToStreamFn ?? fs.outputFileSync;
+    this.#doModifyFontoHtml = !addToStreamFn;
+  }
+
+  #getJson() {
+    return this.#resultJson ??= TclConfig.#transformTclConfigToJson(this.#tclFilePathRel);
+  }
+
+  #getCss(moduleName) {
+    return this.#resultCss[moduleName] ??= TclConfig.#transformJsonToCss(this.#tclFilePathRel, this.#getJson(), moduleName);
+  }
+
+  outputJson(dir) {
+    if (this.#tclFileExists) {
+      const filepath = path.join(dir, TclConfig.#TCL_JSON_FILE_NAME);
+      this.#outputFn(filepath, JSON.stringify(this.#getJson()));
+    }
+    return this;
+  }
+
+  outputCss(dir) {
+    if (this.#tclFileExists) {
+      const filepath = path.join(dir, TclConfig.#TCL_CSS_FILE_NAME);
+      const moduleName = dir.includes('esef') ? 'ESEF' : 'FONTO';
+      this.#outputFn(filepath, this.#getCss(moduleName));
+      this.modifyFontoHtml(dir);
+    }
+    return this;
+  }
+
+  modifyFontoHtml(dir) {
+    if (this.#tclFileExists && this.#doModifyFontoHtml) TclConfig.#addCssImportToHtml(dir);
+    return this;
+  }
+
+};

package/src/modules/deploy/execute.js

@@ -4,6 +4,7 @@ const fs              = require('fs-extra');
 const globby          = require('globby');
 const gulp            = require('gulp');
 const {NodeSSH}       = require('node-ssh');
+const g_tcl           = require('../../lib/gulp-tcl-config');
 const through2        = require('through2');
 const {spawnSync}     = require('child_process');
 
@@ -119,13 +120,13 @@ const createDeliveryPack = () => { // create install scripts if necessary, zip o
 };
 
 
-const transfer = (paths, lrServer) => {
+const transfer = (paths, {watch, lrServer}) => {
   const jsFGlob = _settingsTdi().transpileToES5 ? ['**/*.js', '!**/hce/**/template_*', '!**/fonto/**', '!**/vendor/**', '!**/*.min.js'] : [];
   const jsF     = g_filter(jsFGlob, {restore: true});
   const xpsF    = g_filter(['**/xopus/**/*.x*'], {restore: true});
   const sassF   = g_filter(['**/*.scss'], {restore: true});
   const shF     = g_filter(['**/*.sh'], {restore: true});
-  const srcset  = s.create(paths);
+  const srcset  = s.create(paths, {watch});
   const files   = [];
 
   // local git repo must be on latest commit containing fonto changes, and fonto build files must be newer than that commit, unless that commit belongs to the current user
@@ -160,6 +161,7 @@ const transfer = (paths, lrServer) => {
     .pipe(xpsF)
     .pipe(g_resolveIncl())
     .pipe(xpsF.restore)
+    .pipe(g_tcl())
     .pipe(jsF)
     .pipe(g_sourcemaps.init())
     .pipe(g_babel({presets: [[babel_pe, {modules: false}]], comments: false, minified: true})) // function must be executed here, otherwise second execution during watch fails

package/src/modules/deploy/index.js

@@ -33,7 +33,7 @@ module.exports = function deploy (argv) {
   // execute chosen option
 
   if (argv.test) {
-    s.create([...c.transferPatterns, '!**/fonto/{*.*,!(dist)/**}'], true);
+    s.create([...c.transferPatterns, '!**/fonto/{*.*,!(dist)/**}'], {test: true});
   }
 
   if (argv.copy) {
@@ -52,7 +52,7 @@ module.exports = function deploy (argv) {
         this.queue = this.queue.map(p => p.replace(/fonto(.)(?:dist|dev).assets.schemas(.sx-shell-.*?).json/, 'fonto$1packages$2$1src$1assets$1schemas$2.json')); // fonto schema changes can be detected in different paths at the same time, rewrite paths to original package-path because files in build folders can be removed before transfer starts
         this.queue = [...new Set(this.queue)]; // remove duplicates
         this.queue.forEach(v => s.addToCache(v));
-        transfer(this.queue, lrServer);
+        transfer(this.queue, {watch: true, lrServer});
         this.queue = [];
       },
       add (fp) {

package/src/modules/deploy/srcset.js

@@ -9,12 +9,12 @@ const resolveBind = (d, p) => p.replace('#{cmscustompath}', 'cmscustom/').replac
 
 module.exports = {
 
-  create (pattern, test) {
+  create (paths, {test, watch}) {
     const startTime = new Date();
 
-    this.filesToTransfer          = globby.sync(pattern, {nodir: true});                                    // get list of files to transfer
-    this.potentialBaseFilesCache  = this.potentialBaseFilesCache || globby.sync('**/*.{xml,xsd,xsl,scss}'); // get list of potential base files, if not previously done
-    this.potentialBaseFiles       = this.potentialBaseFilesCache
+    this.filesToTransfer            = watch ? paths : globby.sync(paths, {nodir: true});  // get list of files to transfer
+    this.potentialBaseFilesCache  ??= globby.sync('**/*.{xml,xsd,xsl,scss}');             // get list of potential base files, if not previously done
+    this.potentialBaseFiles         = this.potentialBaseFilesCache
       .filter(p => !this.filesToTransfer.includes(p)) // subtract files to transfer from list of potential base files
       .map(path => [path]);                           // make array so file contents can be added later
 

package/src/modules/fonto/commands.js

@@ -1,12 +1,13 @@
-const del     = require('del');
-const {exec}  = require('child_process');
-const fs      = require('fs-extra');
-const globby  = require('globby');
-const gulp    = require('gulp');
-const g_print = require('gulp-print');
-const path    = require('path');
-const sass    = require('gulp-sass')(require('sass'));
-const wws     = require('../../lib/worker-with-spinner');
+const del       = require('del');
+const {exec}    = require('child_process');
+const fs        = require('fs-extra');
+const globby    = require('globby');
+const gulp      = require('gulp');
+const g_print   = require('gulp-print');
+const path      = require('path');
+const sass      = require('gulp-sass')(require('sass'));
+const TclConfig = require('../../lib/tcl-config');
+const wws       = require('../../lib/worker-with-spinner');
 
 
 g_print.setLogFunction((filepath) => _write(filepath.nostyle));
@@ -261,6 +262,11 @@ module.exports = {
         _write('Done.\n');
       })
       .then(() => cmdExec(`${fdt} editor build`))
+      .then(() => {
+        _info('Read project configuration and create json and css for Fonto:');
+        new TclConfig('..').outputJson('dist/assets').outputCss('dist');
+        _write('Done.\n');
+      })
       .then(() => [fdt])
     ;
   },
@@ -268,14 +274,27 @@ module.exports = {
   run ([fdt]) {
     return compileSass()
       .then(() => {
-        _info('Starting sass watch:');
-        gulp.watch('**/*.scss')
+        _info('Read project configuration and create json and css for Fonto:');
+        new TclConfig('..').outputJson('dev/assets').outputCss('dev');
+        _write('Done.\n');
+      })
+      .then(() => {
+        _info('Starting watch for tcl and sass files:');
+        gulp.watch(['**/*.scss', '../*.tcl', 'dev/index.html'])
           .on('all', (event, filepath) => {
             _write(event + ':', filepath);
-            gulp.src('**/*.scss')
-              .pipe(sass().on('error', sass.logError))
-              .pipe(gulp.dest('.'))
-            ;
+            if (filepath.endsWith('.scss')) {
+              gulp.src('**/*.scss')
+                .pipe(sass().on('error', sass.logError))
+                .pipe(gulp.dest('.'))
+              ;
+            }
+            else if (filepath.endsWith('.html')) {
+              new TclConfig('..').modifyFontoHtml('dev');
+            }
+            else if (filepath.endsWith('.tcl')) {
+              new TclConfig('..').outputJson('dev/assets').outputCss('dev');
+            }
           });
         _write('Done.\n');
       })

package/src/modules/git/index.js

@@ -71,9 +71,9 @@ function init () {
       ])
         .then(() => {
           _info(`Next steps:
-        1. Go to https://bitbucket.org/repo/create?workspace=tangelosoftware and create a repository named "${path.basename(process.cwd()).replace(/\W/, '-')}", with options for including README/.gitignore disabled.
-        2. Open this folder in Sourcetree (ctrl+O), and push master branch to origin.
-      `.replace(/^\s{8}/gm, ''));
+          1. Go to https://bitbucket.org/repo/create?workspace=tangelosoftware and create a repository named "${path.basename(process.cwd()).replace(/\W/, '-')}", with options for including README/.gitignore disabled.
+          2. Open this folder in Sourcetree (ctrl+O), and push master branch to origin.
+        `.replace(/^\s{8}/gm, ''));
         });
     });
 }
@@ -101,7 +101,7 @@ function clone ({clone: repoName}) {
       // Change directory for the next commands, it should have the same name as the clone argument from commandline at this point
       process.chdir('./' + repoName);
       cmdExec([
-      // Retrieve TDI submodule for this client
+        // Retrieve TDI submodule for this client
         ['git submodule update --init', 'Fetch submodules such as TDI'],
         // Create symlinks for TDI
         ['tct b -s', 'Create TDI symlinks'],