@ixon-cdk/core 1.4.0-next.2 → 1.5.0-next.0

package/api/api.utils.js

@@ -2,9 +2,15 @@ async function whileMoreAfter(reqFn) {
   const fetcher = async (seed, moreAfter) => {
     const response = await reqFn(moreAfter);
     const data = [...seed, ...response.data.data];
-    return response.data.moreAfter ? fetcher(data, response.data.moreAfter) : data;
+    return response.data.moreAfter
+      ? fetcher(data, response.data.moreAfter)
+      : data;
   };
-  return fetcher([]).then((data) => ({ data: { data }, moreAfter: null, status: 'success' }));
+  return fetcher([]).then(data => ({
+    data: { data },
+    moreAfter: null,
+    status: 'success',
+  }));
 }
 
 module.exports = {

package/api/deploy.service.js

@@ -7,27 +7,35 @@ const { whileMoreAfter } = require('./api.utils');
 module.exports = class DeployService extends ApiBaseService {
   deploy(companyId, templateId, file) {
     const url = `${this._getApiBaseUrl()}/page-component-templates/${templateId}/version-upload`;
-    const body = fs.readFileSync(path.join(require('../utils').getRootDir(), file));
+    const body = fs.readFileSync(
+      path.join(require('../utils').getRootDir(), file),
+    );
     const headers = {
       ...this._getApiDefaultHeaders(),
       'Content-Type': 'application/x-www-form-urlencoded',
       'Api-Company': companyId,
       Authorization: this._getApiAuthHeaderValue(),
     };
-    return httpRequest({ method: 'POST', url, data: body, headers }).then((res) => res.data.data);
+    return httpRequest({ method: 'POST', url, data: body, headers }).then(
+      res => res.data.data,
+    );
   }
 
   deployAndPublish(companyId, templateId, file) {
-    return this.deploy(companyId, templateId, file).then((data) =>
+    return this.deploy(companyId, templateId, file).then(data =>
       this._publish(companyId, data.publicId),
     );
   }
 
   fetchPublishable(companyId, templateId) {
-    return this._fetchDescTemplateVersions(companyId, templateId).then((versions) => {
-      const publishedIdx = versions.findIndex((v) => typeof v.publishedOn === 'string');
+    return this._fetchDescTemplateVersions(companyId, templateId).then(
+      versions => {
+        const publishedIdx = versions.findIndex(
+          v => typeof v.publishedOn === 'string',
+        );
         return publishedIdx !== -1 ? versions.slice(0, publishedIdx) : versions;
-    });
+      },
+    );
   }
 
   generatePreviewLink(companyId, versionId) {
@@ -36,11 +44,9 @@ module.exports = class DeployService extends ApiBaseService {
       this._fetchTemplateVersion(companyId, versionId),
     ])
       .then(([fqdn, version]) =>
-        this._fetchTemplate(companyId, version.template.publicId).then((template) => [
-          fqdn,
-          version,
-          template,
-        ]),
+        this._fetchTemplate(companyId, version.template.publicId).then(
+          template => [fqdn, version, template],
+        ),
       )
       .then(([fqdn, version, template]) => {
         const hash = require('../utils').generatePreviewHash(
@@ -62,17 +68,19 @@ module.exports = class DeployService extends ApiBaseService {
           ? Promise.reject('Template has no publishable versions')
           : Promise.resolve('Template has no publishable versions');
       }
-      const latest = data.sort((v1, v2) => Number(v2.number) - Number(v1.number))[0];
+      const latest = data.sort(
+        (v1, v2) => Number(v2.number) - Number(v1.number),
+      )[0];
       return this._publish(companyId, latest.publicId);
     });
   }
 
   publishVersion(companyId, templateId, versionNumber) {
-    return this.fetchPublishable(companyId, templateId).then((data) => {
+    return this.fetchPublishable(companyId, templateId).then(data => {
       if (!data.length) {
         return Promise.reject('Template has no publishable versions');
       }
-      const _version = data.find((v) => v.number === String(versionNumber));
+      const _version = data.find(v => v.number === String(versionNumber));
       if (_version) {
         return this._publish(companyId, _version.publicId);
       }
@@ -89,7 +97,7 @@ module.exports = class DeployService extends ApiBaseService {
       Authorization: this._getApiAuthHeaderValue(),
     };
     // Lookup company FQDN (premium branding)
-    return httpRequest({ method: 'GET', url, params, headers }).then((res) => {
+    return httpRequest({ method: 'GET', url, params, headers }).then(res => {
       const myCompany = res.data.data;
       if (myCompany.branding && myCompany.branding.fqdn) {
         return myCompany.branding.fqdn;
@@ -97,7 +105,12 @@ module.exports = class DeployService extends ApiBaseService {
       // Or fallback to sector FQDN
       const _url = `${this._getApiBaseUrl()}/sectors/me`;
       const _headers = { ...this._getApiDefaultHeaders() };
-      return httpRequest({ method: 'GET', url: _url, params, headers: _headers }).then((res) => {
+      return httpRequest({
+        method: 'GET',
+        url: _url,
+        params,
+        headers: _headers,
+      }).then(res => {
         const mySector = res.data.data;
         if (mySector.branding && mySector.branding.fqdn) {
           return mySector.branding.fqdn;
@@ -119,14 +132,16 @@ module.exports = class DeployService extends ApiBaseService {
       'Api-Company': companyId,
       Authorization: this._getApiAuthHeaderValue(),
     };
-    return whileMoreAfter((pageAfter) =>
+    return whileMoreAfter(pageAfter =>
       httpRequest({
         method: 'GET',
         url,
         params: pageAfter ? { ...params, 'page-after': pageAfter } : params,
         headers,
       }),
-    ).then((res) => res.data.data.sort((v1, v2) => Number(v2.number) - Number(v1.number)));
+    ).then(res =>
+      res.data.data.sort((v1, v2) => Number(v2.number) - Number(v1.number)),
+    );
   }
 
   _fetchTemplate(companyId, templateId) {
@@ -137,7 +152,9 @@ module.exports = class DeployService extends ApiBaseService {
       'Api-Company': companyId,
       Authorization: this._getApiAuthHeaderValue(),
     };
-    return httpRequest({ method: 'GET', url, params, headers }).then((res) => res.data.data);
+    return httpRequest({ method: 'GET', url, params, headers }).then(
+      res => res.data.data,
+    );
   }
 
   _fetchTemplateVersion(companyId, versionId) {
@@ -148,7 +165,9 @@ module.exports = class DeployService extends ApiBaseService {
       'Api-Company': companyId,
       Authorization: this._getApiAuthHeaderValue(),
     };
-    return httpRequest({ method: 'GET', url, params, headers }).then((res) => res.data.data);
+    return httpRequest({ method: 'GET', url, params, headers }).then(
+      res => res.data.data,
+    );
   }
 
   _publish(companyId, versionId) {

package/config/schema.json

@@ -39,9 +39,7 @@
       }
     }
   },
-  "required": [
-    "components"
-  ],
+  "required": ["components"],
   "title": "UI Component Workspace Configuration",
   "definitions": {
     "component": {
@@ -80,10 +78,7 @@
                   "description": "List of static component assets. Can be passed as glob paths relative to the component root or as objects for more fine-tuned configuration."
                 }
               },
-              "required": [
-                "builder",
-                "input"
-              ]
+              "required": ["builder", "input"]
             },
             "deploy": {
               "type": "object",
@@ -97,20 +92,13 @@
                   "description": "PageComponentTemplate ID"
                 }
               },
-              "required": [
-                "company",
-                "template"
-              ]
+              "required": ["company", "template"]
             }
           },
-          "required": [
-            "build"
-          ]
+          "required": ["build"]
         }
       },
-      "required": [
-        "runner"
-      ]
+      "required": ["runner"]
     },
     "asset": {
       "type": "object",
@@ -128,9 +116,7 @@
           "description": "A path relative to the component output path (default is dist/component-name)."
         }
       },
-      "required": [
-        "glob"
-      ]
+      "required": ["glob"]
     }
   }
-}
+}

package/http-request.js

@@ -10,14 +10,18 @@ module.exports = function request(options) {
     const customRequest = require(customPath);
 
     if (typeof customRequest !== 'function') {
-      logErrorMessage('The custom "http-request.js" file must export a function.');
+      logErrorMessage(
+        'The custom "http-request.js" file must export a function.',
+      );
       process.exit(1);
     }
 
     const promise = customRequest(options);
 
     if (typeof promise !== 'object' || typeof promise.then !== 'function') {
-      logErrorMessage('The exported function in the custom "http-request.js" file must return a Promise.');
+      logErrorMessage(
+        'The exported function in the custom "http-request.js" file must return a Promise.',
+      );
       process.exit(1);
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ixon-cdk/core",
-  "version": "1.4.0-next.2",
+  "version": "1.5.0-next.0",
   "description": "",
   "main": "index.js",
   "author": "",

package/prompts.js

@@ -4,7 +4,7 @@ module.exports = {
       type: 'text',
       name,
       message: 'What is the ID of your Company?',
-      validate: (value) => {
+      validate: value => {
         if (!value) {
           return 'Company ID is required.';
         }
@@ -20,7 +20,7 @@ module.exports = {
       type: 'text',
       name,
       message: 'What is the ID of the PageComponentTemplate?',
-      validate: (value) => {
+      validate: value => {
         if (!value) {
           return 'Template ID is required.';
         }

package/server/index.js

@@ -31,17 +31,23 @@ module.exports = class Server {
     // CORS
     app.use((_, res, next) => {
       res.header('Access-Control-Allow-Origin', '*');
-      res.header('Access-Control-Allow-Headers', 'Origin, X-Requested-With, Content-Type, Accept');
+      res.header(
+        'Access-Control-Allow-Headers',
+        'Origin, X-Requested-With, Content-Type, Accept',
+      );
       next();
     });
 
     // Components
     if (names) {
-      names.forEach((name) => {
+      names.forEach(name => {
         const outputDir = this._getOutputDir(name);
         if (outputDir) {
           const dir = path.resolve(this._rootDir, outputDir);
-          app.use(`/${this._opts.componentBasePath}/${name}`, express.static(dir));
+          app.use(
+            `/${this._opts.componentBasePath}/${name}`,
+            express.static(dir),
+          );
         }
       });
     }
@@ -53,7 +59,7 @@ module.exports = class Server {
     const _refresh = () => lrServer.refresh('/');
     const _debouncedRefresh = require('lodash/debounce')(_refresh, 250);
     names
-      .flatMap((name) => [
+      .flatMap(name => [
         [path.join(this._rootDir, this._getOutput(name)), 100],
         [path.join(this._rootDir, `dist/${name}/manifest.json`), 500],
       ])

package/template/template.service.js

@@ -24,14 +24,21 @@ module.exports = class TemplateService {
   }
 
   async addFromExample(componentName, componentPrefix) {
-    const examplesRoot = path.join(this._rootDir, 'node_modules/ixon-custom-component-examples');
+    const examplesRoot = path.join(
+      this._rootDir,
+      'node_modules/ixon-custom-component-examples',
+    );
 
     if (!fs.existsSync(examplesRoot)) {
-      logErrorMessage("Package 'ixon-custom-component-examples' is not installed.");
+      logErrorMessage(
+        "Package 'ixon-custom-component-examples' is not installed.",
+      );
       process.exit(1);
     }
 
-    const examplesConfigSrv = new ConfigService('node_modules/ixon-custom-component-examples/config.json');
+    const examplesConfigSrv = new ConfigService(
+      'node_modules/ixon-custom-component-examples/config.json',
+    );
     const { components } = examplesConfigSrv._config;
 
     if (!Object.keys(components).length) {
@@ -46,7 +53,10 @@ module.exports = class TemplateService {
       type: 'select',
       name: 'name',
       message: 'Pick a template',
-      choices: Object.keys(components).map((name) => ({ title: name, value: name })),
+      choices: Object.keys(components).map(name => ({
+        title: name,
+        value: name,
+      })),
       initial: 0,
     });
     const exampleName = result.name;
@@ -60,11 +70,13 @@ module.exports = class TemplateService {
 
     const { build } = components[exampleName].runner;
     const { builder } = build;
-    
+
     // make sure the builders for this example are installed.
     if (components[exampleName].runner) {
-      const moduleNames = this._getModuleNamesForRunner(components[exampleName].runner);
-      moduleNames.forEach((name) => ensureModule(name));
+      const moduleNames = this._getModuleNamesForRunner(
+        components[exampleName].runner,
+      );
+      moduleNames.forEach(name => ensureModule(name));
     }
 
     const isVue = builder.startsWith('@ixon-cdk/vue-builder');
@@ -72,12 +84,21 @@ module.exports = class TemplateService {
     const isSvelte = builder.startsWith('@ixon-cdk/svelte-builder');
 
     // find source files, read and replace.
-    const exampleDir = path.join(examplesRoot, exampleComponentRoot, exampleName);
+    const exampleDir = path.join(
+      examplesRoot,
+      exampleComponentRoot,
+      exampleName,
+    );
     const inputFilePath = path.join(exampleDir, build.input);
-    let inputFileContents = fs.readFileSync(inputFilePath, { encoding: 'utf-8' });
+    let inputFileContents = fs.readFileSync(inputFilePath, {
+      encoding: 'utf-8',
+    });
 
     if (isVue) {
-      inputFileContents = this._findAndReplaceVueInputFile(inputFileContents, componentName);
+      inputFileContents = this._findAndReplaceVueInputFile(
+        inputFileContents,
+        componentName,
+      );
     } else if (isStatic) {
       inputFileContents = this._findAndReplaceStaticInputFile(
         inputFileContents,
@@ -89,9 +110,15 @@ module.exports = class TemplateService {
     }
 
     // find manifest file, read and replace.
-    const manifestFilePath = path.join(path.dirname(inputFilePath), 'manifest.json');
+    const manifestFilePath = path.join(
+      path.dirname(inputFilePath),
+      'manifest.json',
+    );
     const manifestFileContents = JSON.parse(fs.readFileSync(manifestFilePath));
-    manifestFileContents.main = `${this._getTag(componentPrefix, componentName)}.min.js`;
+    manifestFileContents.main = `${this._getTag(
+      componentPrefix,
+      componentName,
+    )}.min.js`;
     manifestFileContents.version = '1';
 
     let input;
@@ -106,10 +133,12 @@ module.exports = class TemplateService {
     const files = await getFiles(exampleDir).catch(logErrorMessage);
 
     // find and install any missing dependencies.
-    files.forEach((file) => {
+    files.forEach(file => {
       if (/\.(jsx?|tsx?|svelte|vue)$/i.test(file)) {
         const fileContents = fs.readFileSync(file);
-        const { dependencies } = require(path.join(examplesRoot, 'package.json'));
+        const { dependencies } = require(
+          path.join(examplesRoot, 'package.json'),
+        );
         this._checkDependencies(fileContents, dependencies || {});
       }
     });
@@ -117,14 +146,17 @@ module.exports = class TemplateService {
     // else start copying input, and menifest files
     const componentRoot = this._configSrv.getNewComponentRoot();
     const dir = path.join(this._rootDir, componentRoot, componentName);
-    const _logCreatedInDir = (fileName) => {
-      logFileCrudMessage('CREATE', path.join(componentRoot, componentName, fileName));
+    const _logCreatedInDir = fileName => {
+      logFileCrudMessage(
+        'CREATE',
+        path.join(componentRoot, componentName, fileName),
+      );
     };
     fs.mkdirSync(dir, { recursive: true });
 
     files
-      .map((file) => file.slice(exampleDir.length + 1))
-      .forEach((file) => {
+      .map(file => file.slice(exampleDir.length + 1))
+      .forEach(file => {
         // create directory if it doesn't exist.
         const _dir = path.dirname(path.join(dir, file));
         if (!fs.existsSync(_dir)) {
@@ -132,7 +164,9 @@ module.exports = class TemplateService {
         }
         // for the input-file and manifest use the replaced file contents.
         if (file === build.input) {
-          fs.writeFileSync(path.join(dir, input), inputFileContents, { encoding: 'utf-8' });
+          fs.writeFileSync(path.join(dir, input), inputFileContents, {
+            encoding: 'utf-8',
+          });
           _logCreatedInDir(input);
         } else if (file === 'manifest.json') {
           const json = `${JSON.stringify(manifestFileContents, null, 2)}\n`;
@@ -144,7 +178,9 @@ module.exports = class TemplateService {
         }
       });
 
-    return Promise.resolve({ config: { runner: { build: { builder, input } } } });
+    return Promise.resolve({
+      config: { runner: { build: { builder, input } } },
+    });
   }
 
   async add(componentName, componentPrefix) {
@@ -154,7 +190,7 @@ module.exports = class TemplateService {
       type: 'select',
       name: 'templateName',
       message: 'Pick a template',
-      choices: Object.keys(this._schemas).map((key) => ({
+      choices: Object.keys(this._schemas).map(key => ({
         title: this._schemas[key].name,
         value: key,
       })),
@@ -166,7 +202,10 @@ module.exports = class TemplateService {
     }
 
     if (schema) {
-      const context = { name: componentName, tag: this._getTag(componentPrefix, componentName) };
+      const context = {
+        name: componentName,
+        tag: this._getTag(componentPrefix, componentName),
+      };
       let variantIdx = null;
 
       if (schema.variants) {
@@ -186,7 +225,7 @@ module.exports = class TemplateService {
         }
 
         if (variantIdx === undefined) {
-          logErrorMessage("No variant selected");
+          logErrorMessage('No variant selected');
           process.exit(1);
         }
       }
@@ -196,11 +235,14 @@ module.exports = class TemplateService {
       // make sure the builders for this template are installed.
       if (schema.config.runner) {
         const moduleNames = this._getModuleNamesForRunner(schema.config.runner);
-        moduleNames.forEach((name) => ensureModule(name));
+        moduleNames.forEach(name => ensureModule(name));
       }
 
       // optionally install types
-      if (variantIdx !== null && /typescript/i.test(schema.variants[variantIdx].name)) {
+      if (
+        variantIdx !== null &&
+        /typescript/i.test(schema.variants[variantIdx].name)
+      ) {
         ensureModule('@ixon-cdk/types');
       }
 
@@ -219,22 +261,26 @@ module.exports = class TemplateService {
         const deps = schema.variants[variantIdx].dependencies;
         const devDeps = schema.variants[variantIdx].devDependencies;
         if (!!deps) {
-          Object.keys(deps).forEach(name => ensureModule(name, deps[name], false));
+          Object.keys(deps).forEach(name =>
+            ensureModule(name, deps[name], false),
+          );
         }
         if (!!devDeps) {
-          Object.keys(devDeps).forEach(name => ensureModule(name, devDeps[name]));
+          Object.keys(devDeps).forEach(name =>
+            ensureModule(name, devDeps[name]),
+          );
         }
       }
 
       const componentRoot = this._configSrv.getNewComponentRoot();
 
-      schema.files.forEach((file) => {
+      schema.files.forEach(file => {
         file.dest = `${componentRoot}/${componentName}/${file.dest}`;
         this.createFile(file, context);
       });
 
       if (variantIdx !== null) {
-        schema.variants[variantIdx].files.forEach((file) => {
+        schema.variants[variantIdx].files.forEach(file => {
           file.dest = `${componentRoot}/${componentName}/${file.dest}`;
           this.createFile(file, context);
         });
@@ -250,7 +296,10 @@ module.exports = class TemplateService {
     });
     if (file.interpolateContent) {
       const text = fs.readFileSync(
-        path.join(path.dirname(require.resolve('@ixon-cdk/templates')), file.source),
+        path.join(
+          path.dirname(require.resolve('@ixon-cdk/templates')),
+          file.source,
+        ),
         { encoding: 'utf-8' },
       );
       const data = this._interpolateText(text, ctx);
@@ -259,7 +308,10 @@ module.exports = class TemplateService {
       });
     } else {
       fs.copyFileSync(
-        path.join(path.dirname(require.resolve('@ixon-cdk/templates')), file.source),
+        path.join(
+          path.dirname(require.resolve('@ixon-cdk/templates')),
+          file.source,
+        ),
         path.join(this._rootDir, file.dest),
       );
     }
@@ -272,8 +324,9 @@ module.exports = class TemplateService {
    * already be a depencency in your workspace. If not, the package will get installed and saved.
    */
   _checkDependencies(fileContents, dependencies) {
-    const rootDeps = require(path.join(this._rootDir, 'package.json')).dependencies || {};
-    Object.keys(dependencies).forEach((pkg) => {
+    const rootDeps =
+      require(path.join(this._rootDir, 'package.json')).dependencies || {};
+    Object.keys(dependencies).forEach(pkg => {
       const matcher = new RegExp(`^\\s*import.*\\s['"]${pkg}\\S*['"]`, 'gm');
       if (matcher.test(fileContents) && !(pkg in rootDeps)) {
         const version = dependencies[pkg];
@@ -288,7 +341,9 @@ module.exports = class TemplateService {
    */
   _findAndReplaceVueInputFile(fileContents, componentName) {
     const matcher = /export\s+default\s+{\s+name:\s+['"](\S+)['"]/gm;
-    return fileContents.replaceAll(matcher, (match, p1) => match.replace(p1, componentName));
+    return fileContents.replaceAll(matcher, (match, p1) =>
+      match.replace(p1, componentName),
+    );
   }
 
   /**
@@ -326,16 +381,21 @@ module.exports = class TemplateService {
     const searchTag = this._getTag(searchPrefix, searchName);
     const replacementTag = this._getTag(replacementPrefix, replacementName);
     return fileContents
-      .replaceAll(new RegExp(`class\\s+(${pascalCase(searchTag)})`, 'gm'), (match, p1) =>
-        match.replace(p1, pascalCase(replacementTag)),
+      .replaceAll(
+        new RegExp(`class\\s+(${pascalCase(searchTag)})`, 'gm'),
+        (match, p1) => match.replace(p1, pascalCase(replacementTag)),
       )
       .replaceAll(
         new RegExp(
-          `define\\s*\\(\\s*['"](${searchTag})['"]\\s*,\\s+(${pascalCase(searchTag)})\\)`,
+          `define\\s*\\(\\s*['"](${searchTag})['"]\\s*,\\s+(${pascalCase(
+            searchTag,
+          )})\\)`,
           'gm',
         ),
         (match, p1, p2) =>
-          match.replace(p1, replacementTag).replace(p2, pascalCase(replacementTag)),
+          match
+            .replace(p1, replacementTag)
+            .replace(p2, pascalCase(replacementTag)),
       );
   }
 
@@ -373,8 +433,8 @@ module.exports = class TemplateService {
    * ```
    * ["@ixon-cdk/svelte-builder"]
    * ```
-   * 
-   * @param {Object} runner 
+   *
+   * @param {Object} runner
    * @returns {Array.<String>} names
    */
   _getModuleNamesForRunner(runner) {
@@ -387,7 +447,7 @@ module.exports = class TemplateService {
       }
       return names;
     }, []);
-  } 
+  }
 
   _getTag(prefix, name) {
     return prefix ? `${prefix}-${name}` : name;

package/utils.js

@@ -93,7 +93,11 @@ function apiHttpErrorToMessage(error, exit = true) {
     if (errors) {
       logErrorMessage(
         errors
-          .map((err) => (err.propertyName ? `${err.propertyName}: ${err.message}` : err.message))
+          .map(err =>
+            err.propertyName
+              ? `${err.propertyName}: ${err.message}`
+              : err.message,
+          )
           .join('\n'),
       );
       exit && process.exit(1);
@@ -105,7 +109,13 @@ function apiHttpErrorToMessage(error, exit = true) {
   exit && process.exit(1);
 }
 
-function generatePreviewHash(templateId, templateName, versionId, versionNumber, versionMainPath) {
+function generatePreviewHash(
+  templateId,
+  templateName,
+  versionId,
+  versionNumber,
+  versionMainPath,
+) {
   const ref = {
     tid: templateId,
     tnm: templateName,
@@ -120,7 +130,7 @@ function generatePreviewHash(templateId, templateName, versionId, versionNumber,
 async function getFiles(dir) {
   const dirents = await fs.promises.readdir(dir, { withFileTypes: true });
   const files = await Promise.all(
-    dirents.map((dirent) => {
+    dirents.map(dirent => {
       const res = path.resolve(dir, dirent.name);
       return dirent.isDirectory() ? getFiles(res) : res;
     }),