@ixon-cdk/core 1.3.0-next.0 → 1.3.0-next.2

package/config/schema.d.ts

@@ -1,5 +1,5 @@
 /**
- * @title Custom Component Workspace Configuration
+ * @title UI Component Workspace Configuration
  */
 export interface schema {
   /**
@@ -36,14 +36,22 @@ export interface schema {
 }
 
 interface component {
+  /**
+   * The component root path, relative to the workspace root. By default, the component root path
+   * is formed by concatenating the `newComponentRoot` and component name.
+   */
+  root?: string;
   runner: {
     build: {
-      /** The builder package name and build command */
+      /** The builder package name and build command. */
       builder: string;
-      /** The component input-file */
+      /** The component input file, relative to the component root. */
       input: string;
-      /** List of static component assets. */
-      assets?: string[];
+      /**
+       * List of static component assets. Can be passed as glob paths relative to the component
+       * root or as objects for more fine-tuned configuration.
+       */
+      assets?: (string | asset)[];
     };
     deploy?: {
       /** Company ID */
@@ -53,3 +61,12 @@ interface component {
     };
   };
 }
+
+interface asset {
+  /** A node-glob using input as base directory. */
+  glob: string;
+  /** A path relative to the workspace root. */
+  input?: string;
+  /** A path relative to the component output path (default is dist/component-name). */
+  output?: string;
+}

package/config/schema.json

@@ -42,11 +42,15 @@
   "required": [
     "components"
   ],
-  "title": "Custom Component Workspace Configuration",
+  "title": "UI Component Workspace Configuration",
   "definitions": {
     "component": {
       "type": "object",
       "properties": {
+        "root": {
+          "type": "string",
+          "description": "The component root path, relative to the workspace root. By default, the component root path is formed by concatenating the `newComponentRoot` and component name."
+        },
         "runner": {
           "type": "object",
           "properties": {
@@ -55,18 +59,25 @@
               "properties": {
                 "builder": {
                   "type": "string",
-                  "description": "The builder package name and build command"
+                  "description": "The builder package name and build command."
                 },
                 "input": {
                   "type": "string",
-                  "description": "The component input-file"
+                  "description": "The component input file, relative to the component root."
                 },
                 "assets": {
                   "type": "array",
                   "items": {
-                    "type": "string"
+                    "anyOf": [
+                      {
+                        "type": "string"
+                      },
+                      {
+                        "$ref": "#/definitions/asset"
+                      }
+                    ]
                   },
-                  "description": "List of static component assets."
+                  "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": [
@@ -100,6 +111,26 @@
       "required": [
         "runner"
       ]
+    },
+    "asset": {
+      "type": "object",
+      "properties": {
+        "glob": {
+          "type": "string",
+          "description": "A node-glob using input as base directory."
+        },
+        "input": {
+          "type": "string",
+          "description": "A path relative to the workspace root."
+        },
+        "output": {
+          "type": "string",
+          "description": "A path relative to the component output path (default is dist/component-name)."
+        }
+      },
+      "required": [
+        "glob"
+      ]
     }
   }
 }

package/meta-files.js

@@ -3,7 +3,7 @@ const fse = require('fs-extra');
 const path = require('path');
 const { watch } = require('chokidar');
 const { globSync } = require('glob');
-const { debounce, uniq } = require('lodash');
+const { debounce, isEqual, uniqWith } = require('lodash');
 const { getRootDir } = require('./utils');
 
 const ICON_FILE_NAME = 'icon.svg';
@@ -13,46 +13,61 @@ const WATCH_OPTIONS = {
   usePolling: process.platform !== 'darwin',
 };
 
+/**
+ * @typedef {Object} Asset
+ * @property {String} glob - A node-glob using input as base directory.
+ * @property {String} [input] - A path relative to the workspace root.
+ * @property {String} [output] - A path relative to outputPath (default is dist/component-name).
+ */
+
 module.exports = {
   cleanDir(dir) {
     fse.emptyDirSync(dir);
   },
+  /**
+   * @param {Array<String | Asset>} assets
+   * @param {String} inputDir
+   * @param {String} outputDir
+   */
   copyAssets(assets, inputDir, outputDir) {
-    const paths = uniq([MANIFEST_FILE_NAME, ICON_FILE_NAME, ...assets]).map(
-      asset => path.join(inputDir, asset),
+    _getAssetSpecs(assets, inputDir, outputDir).forEach(
+      ({ glob, input, output }) => {
+        const globFilePath = path.join(input, glob).replaceAll('\\', '/');
+        globSync(globFilePath).forEach(file => {
+          const filePath = file.slice(input.length + 1);
+          _copyFromToSync(filePath, input, output);
+        });
+      },
     );
-    paths.forEach(_path => {
-      const globFilePath = _path.replaceAll('\\', '/');
-      globSync(globFilePath).forEach(file => {
-        const filePath = file.slice(inputDir.length + 1);
-        _copyFromToSync(filePath, inputDir, outputDir);
-      });
-    });
   },
   watchAssets(assets, inputDir, outputDir) {
     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;
-      }
-    });
+    return Promise.all(
+      _getAssetSpecs(assets, inputDir, outputDir).map(asset => {
+        return watch(path.join(asset.input, asset.glob), WATCH_OPTIONS).on(
+          'all',
+          (type, file) => {
+            const filePath = path
+              .join(root, file)
+              .slice(asset.input.length + 1);
+            switch (type) {
+              case 'add':
+              case 'addDir':
+              case 'change':
+              case 'changeDir':
+                _copyFromToSync(filePath, asset.input, asset.output);
+                break;
+              case 'unlink':
+              case 'unlinkDir':
+                fse.removeSync(path.join(asset.output, filePath));
+                break;
+              default:
+                break;
+            }
+          },
+        );
+      }),
+    );
   },
   watchInputDir(dir, watchCallback) {
     const _debouncedCallback = debounce(() => watchCallback(), 300);
@@ -92,3 +107,27 @@ function _copyFromToSync(filePath, sourceDir, destDir) {
     fse.copySync(sourceFile, destFile);
   }
 }
+
+/**
+ * @param {Array<String | Asset>} assets
+ * @param {String} inputDir
+ * @param {String} outputDir
+ * @returns {Required<Asset>[]}
+ */
+function _getAssetSpecs(assets, inputDir, outputDir) {
+  const rootDir = getRootDir();
+  return uniqWith([MANIFEST_FILE_NAME, ICON_FILE_NAME, ...assets], isEqual).map(
+    asset =>
+      typeof asset === 'string'
+        ? {
+            glob: path.normalize(asset),
+            input: path.normalize(inputDir),
+            output: path.normalize(outputDir),
+          }
+        : {
+            glob: path.normalize(asset.glob),
+            input: path.join(rootDir, asset.input ?? inputDir),
+            output: path.join(outputDir, asset.output ?? '/'),
+          },
+  );
+}

package/package.json

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