@ixon-cdk/core 1.2.0-next.1 → 1.2.0-next.10

package/api/auth.service.js

@@ -5,10 +5,11 @@ const httpRequest = require('../http-request');
 module.exports = class AuthService extends ApiBaseService {
   logIn(credentials) {
     const c = credentials;
+    const expiresIn = 2592000; // 30 days
     return httpRequest({
       method: 'POST',
       url: `${this._getApiBaseUrl()}/access-tokens`,
-      data: { expiresIn: 86400 },
+      data: { expiresIn },
       headers: {
         ...this._getApiDefaultHeaders(),
         'User-Agent': 'ComponentDevKit',

package/config/config.service.js

@@ -8,7 +8,7 @@ module.exports = class ConfigService {
 
   constructor(configFile) {
     // When the CDK is part of a larger project workspace it may be desirable to have a more explicit config-file name. Therefore, unless
-    // a specific config file path was defined in the contructor, we'll first try to find `cdk.config.json`, before falling back to the
+    // a specific config file path was defined in the constructor, we'll first try to find `cdk.config.json`, before falling back to the
     // default file name `config.json`.
     if (configFile !== undefined) {
       this._path = path.join(getRootDir(), configFile);
@@ -23,8 +23,21 @@ module.exports = class ConfigService {
     let config;
 
     if (!fs.existsSync(this._path)) {
-      logErrorMessage('No config file.');
-      process.exit(1);
+      this._path = path.join(getRootDir(), 'cdk.config.json');
+      fs.writeFileSync(
+        this._path,
+        `${JSON.stringify(
+          {
+            $schema: './node_modules/@ixon-cdk/core/config/schema.json',
+            prefix: 'pct',
+            components: {},
+          },
+          null,
+          2,
+        )}\n`,
+        { encoding: 'utf-8' },
+      );
+      logFileCrudMessage('CREATE', 'cdk.config.json');
     }
 
     try {
@@ -88,6 +101,6 @@ module.exports = class ConfigService {
       encoding: 'utf8',
       flag: 'w',
     });
-    logFileCrudMessage('UPDATE', 'config.json');
+    logFileCrudMessage('UPDATE', path.basename(this._path));
   }
 };

package/meta-files.js

@@ -1,78 +1,73 @@
 const fs = require('fs');
+const fse = require('fs-extra');
 const path = require('path');
+const { watch } = require('chokidar');
+const { globSync } = require('glob');
 const { debounce, uniq } = require('lodash');
-const rimraf = require('rimraf');
+const { getRootDir } = require('./utils');
 
 const ICON_FILE_NAME = 'icon.svg';
 const MANIFEST_FILE_NAME = 'manifest.json';
 const WATCH_OPTIONS = {
-  cwd: require('./utils').getRootDir(),
+  cwd: getRootDir(),
   usePolling: process.platform !== 'darwin',
 };
 
 module.exports = {
   cleanDir(dir) {
-    if (fs.existsSync(dir)) {
-      rimraf.sync(dir);
-    }
-    fs.mkdirSync(dir, { recursive: true });
+    fse.emptyDirSync(dir);
   },
   copyAssets(assets, inputDir, outputDir) {
-    const paths = uniq([MANIFEST_FILE_NAME, ICON_FILE_NAME, ...assets]).map((asset) =>
-      path.join(inputDir, asset),
+    const paths = uniq([MANIFEST_FILE_NAME, ICON_FILE_NAME, ...assets]).map(
+      asset => path.join(inputDir, asset),
     );
-    paths.forEach((_path) => {
+    paths.forEach(_path => {
       const globFilePath = _path.replaceAll('\\', '/');
-      require('glob')
-        .sync(globFilePath)
-        .forEach((file) => {
-          const fileName = file.slice(inputDir.length + 1);
-          _copyFileNameFromToSync(fileName, inputDir, outputDir);
-        });
+      globSync(globFilePath).forEach(file => {
+        const filePath = file.slice(inputDir.length + 1);
+        _copyFromToSync(filePath, inputDir, outputDir);
+      });
     });
   },
   watchAssets(assets, inputDir, outputDir) {
-    const root = require('./utils').getRootDir();
-    return require('chokidar')
-      .watch(
-        uniq([MANIFEST_FILE_NAME, ICON_FILE_NAME, ...assets]).map((asset) =>
-          path.join(inputDir, asset),
-        ),
-        WATCH_OPTIONS,
-      )
-      .on('all', (type, file) => {
-        const fileName = path.join(root, file).slice(inputDir.length + 1);
-        switch (type) {
-          case 'add':
-          case 'change':
-            _copyFileNameFromToSync(fileName, inputDir, outputDir);
-            break;
-          case 'unlink':
-            if (fs.existsSync(path.join(outputDir, fileName))) {
-              rimraf.sync(path.join(outputDir, fileName));
-            }
-            break;
-          default:
-            break;
-        }
-      });
+    const root = getRootDir();
+    return watch(
+      uniq([MANIFEST_FILE_NAME, ICON_FILE_NAME, ...assets]).map(asset =>
+        path.join(inputDir, asset),
+      ),
+      WATCH_OPTIONS,
+    ).on('all', (type, file) => {
+      const filePath = path.join(root, file).slice(inputDir.length + 1);
+      switch (type) {
+        case 'add':
+        case 'addDir':
+        case 'change':
+        case 'changeDir':
+          _copyFromToSync(filePath, inputDir, outputDir);
+          break;
+        case 'unlink':
+        case 'unlinkDir':
+          fse.removeSync(path.join(outputDir, filePath));
+          break;
+        default:
+          break;
+      }
+    });
   },
   watchInputDir(dir, watchCallback) {
     const _debouncedCallback = debounce(() => watchCallback(), 300);
-    require('chokidar')
-      .watch([`${dir}/**`], WATCH_OPTIONS)
-      .on('all', (_, _path) => {
-        if (
-          _path.endsWith(path.join(dir, MANIFEST_FILE_NAME)) ||
-          _path.endsWith(path.join(dir, ICON_FILE_NAME))
-        ) {
-          watchCallback(true);
-        } else {
-          _debouncedCallback();
-        }
-      });
+    watch([`${dir}/**`], WATCH_OPTIONS).on('all', (_, _path) => {
+      if (
+        _path.endsWith(path.join(dir, MANIFEST_FILE_NAME)) ||
+        _path.endsWith(path.join(dir, ICON_FILE_NAME))
+      ) {
+        watchCallback(true);
+      } else {
+        _debouncedCallback();
+      }
+    });
   },
-  writeDemoFile: function writeDemoFile(tag, outputDir, outputFile) {
+  writeDemoFile(tag, outputDir, outputFile) {
     const demoFileContent = `<meta charset="utf-8">\n<title>${tag} demo</title>\n<script src="./${path.basename(
       outputFile,
     )}"></script>\n\n\n<${tag}></${tag}>\n\n`;
@@ -83,18 +78,17 @@ module.exports = {
   },
 };
 
-function _copyFileNameFromToSync(fileName, sourceDir, destDir) {
-  const sourceFile = path.join(sourceDir, fileName);
+/**
+ * Copies an asset file or directory from the source directory to a destination directory.
+ *
+ * @param {String} filePath
+ * @param {String} sourceDir
+ * @param {String} destDir
+ */
+function _copyFromToSync(filePath, sourceDir, destDir) {
+  const sourceFile = path.join(sourceDir, filePath);
   if (fs.existsSync(sourceFile)) {
-    const destFile = path.join(destDir, fileName);
-    if (!fs.existsSync(destDir)) {
-      fs.mkdirSync(destDir, { recursive: true });
-    }
-    if (!fs.existsSync(path.dirname(path.join(destDir, fileName)))) {
-      fs.mkdirSync(path.dirname(path.join(destDir, fileName)), {
-        recursive: true,
-      });
-    }
-    fs.copyFileSync(sourceFile, destFile);
+    const destFile = path.join(destDir, filePath);
+    fse.copySync(sourceFile, destFile);
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ixon-cdk/core",
-  "version": "1.2.0-next.1",
+  "version": "1.2.0-next.10",
   "description": "",
   "main": "index.js",
   "author": "",
@@ -8,18 +8,18 @@
   "dependencies": {
     "app-root-dir": "^1.0.2",
     "archiver": "^5.3.1",
-    "axios": "^0.26.1",
+    "axios": "^1.3.4",
     "chalk": "^4.1.2",
     "chokidar": "^3.5.3",
     "cors": "^2.8.5",
     "crypto-js": "^4.1.1",
-    "express": "^4.17.3",
-    "glob": "^8.0.1",
+    "express": "^4.18.2",
+    "fs-extra": "^11.1.1",
+    "glob": "^9.2.1",
     "livereload": "^0.9.3",
     "lodash": "^4.17.21",
     "opener": "^1.5.2",
     "prompts": "^2.4.2",
-    "rimraf": "^3.0.2",
-    "yargs": "^17.4.1"
+    "yargs": "^17.7.1"
   }
 }

package/server/index.js

@@ -62,7 +62,18 @@ module.exports = class Server {
       );
 
     // Simulator app
-    const appDir = path.dirname(require.resolve('@ixon-cdk/simulator'));
+    let appDir;
+    try {
+      appDir = path.dirname(require.resolve('@ixon-cdk/simulator'));
+    } catch (e) {
+      // If require.resolve is invoked immediately after the simulator is installed, it will return
+      // a "MODULE_NOT_FOUND" error. In that case (as a fallback) we'll find the simulator app dir
+      // relative to the core module (which should have already been installed).
+      appDir = path.join(
+        require.resolve('@ixon-cdk/core'),
+        '../../simulator/dist',
+      );
+    }
     app.get(`/${this._opts.componentBasePath}/*`, (req, res) => {
       res.sendStatus(404);
     });

package/template/template.service.js

@@ -184,6 +184,11 @@ module.exports = class TemplateService {
         if (_result) {
           variantIdx = _result.variantIdx;
         }
+
+        if (variantIdx === undefined) {
+          logErrorMessage("No variant selected");
+          process.exit(1);
+        }
       }
 
       schema = this._interpolateSchema(schema, context);
@@ -194,6 +199,33 @@ module.exports = class TemplateService {
         moduleNames.forEach((name) => ensureModule(name));
       }
 
+      // optionally install types
+      if (variantIdx !== null && /typescript/i.test(schema.variants[variantIdx].name)) {
+        ensureModule('@ixon-cdk/types');
+      }
+
+      // install dependencies
+      if (!!schema.dependencies) {
+        Object.keys(schema.dependencies).forEach(name =>
+          ensureModule(name, schema.dependencies[name], false),
+        );
+      }
+      if (!!schema.devDependencies) {
+        Object.keys(schema.devDependencies).forEach(name =>
+          ensureModule(name, schema.devDependencies[name]),
+        );
+      }
+      if (variantIdx !== null) {
+        const deps = schema.variants[variantIdx].dependencies;
+        const devDeps = schema.variants[variantIdx].devDependencies;
+        if (!!deps) {
+          Object.keys(deps).forEach(name => ensureModule(name, deps[name], false));
+        }
+        if (!!devDeps) {
+          Object.keys(devDeps).forEach(name => ensureModule(name, devDeps[name]));
+        }
+      }
+
       const componentRoot = this._configSrv.getNewComponentRoot();
 
       schema.files.forEach((file) => {
@@ -310,15 +342,21 @@ module.exports = class TemplateService {
   _discover() {
     const dir = path.dirname(require.resolve('@ixon-cdk/templates'));
     const files = fs.readdirSync(dir);
-    files.forEach((file) => {
-      if (fs.lstatSync(path.join(dir, file)).isDirectory()) {
-        const schemaFile = path.join(dir, file, 'schema.json');
-        if (fs.existsSync(schemaFile)) {
-          const schema = JSON.parse(fs.readFileSync(schemaFile));
-          this._schemas = { ...this._schemas, [file]: schema };
+    const tail = ['iframe-wrapper'];
+    files
+      .sort((a, b) => {
+        if (tail.includes(a)) return 1;
+        return tail.includes(b) ? -1 : 0;
+      })
+      .forEach(file => {
+        if (fs.lstatSync(path.join(dir, file)).isDirectory()) {
+          const schemaFile = path.join(dir, file, 'schema.json');
+          if (fs.existsSync(schemaFile)) {
+            const schema = JSON.parse(fs.readFileSync(schemaFile));
+            this._schemas = { ...this._schemas, [file]: schema };
+          }
         }
-      }
-    });
+      });
   }
 
   /**

package/utils.js

@@ -1,10 +1,17 @@
 const fs = require('fs');
+const fse = require('fs-extra');
 const path = require('path');
 const chalk = require('chalk');
+const { globSync } = require('glob');
 const flow = require('lodash/flow');
 const camelCase = require('lodash/camelCase');
 const upperFirst = require('lodash/upperFirst');
 
+function dirContains(dir, globPattern) {
+  const files = globSync(path.join(dir, globPattern));
+  return !!files.length;
+}
+
 function getArgv() {
   const remain = process.argv.slice(2);
   const { argv } = require('yargs/yargs')(remain).version(false);
@@ -45,19 +52,17 @@ function moduleExists(moduleName) {
   return exists;
 }
 
-function ensureModule(moduleName) {
-  if (!moduleName.startsWith('@ixon-cdk/')) {
-    logErrorMessage('Cannot install this module.');
-    return;
-  }
+function ensureModule(moduleName, moduleVersion = null, dev = true) {
   if (!moduleExists(moduleName)) {
-    console.log(`Installing package '${moduleName}'...`);
     if (moduleName.startsWith('@ixon-cdk/')) {
       const cdkVersion = require('./package.json').version;
-      require('child_process').execSync(`npm install --save-dev ${moduleName}@${cdkVersion}`);
-    } else {
-      require('child_process').execSync(`npm install --save-dev ${moduleName}`);
+      moduleVersion = cdkVersion;
     }
+    const v = !!moduleVersion ? '@' + moduleVersion : '';
+    console.log(`Installing package '${moduleName}${v}...`);
+    require('child_process').execSync(
+      `npm install --save${dev ? '-dev' : ''} ${moduleName}${v}`,
+    );
   }
 }
 
@@ -66,7 +71,7 @@ function zip(output, callback) {
   const zipFile = path.join(`${outputDir}.zip`);
   const stream = fs.createWriteStream(zipFile);
   stream.on('close', () => {
-    require('rimraf').sync(outputDir);
+    fse.removeSync(outputDir);
     callback(zipFile);
   });
   const archive = require('archiver')('zip', { zlib: { level: 9 } });
@@ -122,6 +127,7 @@ async function getFiles(dir) {
 }
 
 module.exports = {
+  dirContains,
   getArgv,
   getRootDir,
   logErrorMessage,